face_imm_58_to_face_imm_58

menpo.landmark.face_imm_58_to_face_imm_58(x, return_mapping=False)[source]

Apply the 58-point semantic labels from the IMM dataset.

The semantic labels applied are as follows:

  • jaw
  • left_eye
  • right_eye
  • left_eyebrow
  • right_eyebrow
  • mouth
  • nose
Parameters:
  • x (LandmarkGroup or PointCloud or ndarray) – The input landmark group, pointcloud or array to label. If a pointcloud is passed, then only the connectivity information is propagated to the pointcloud (a subclass of PointCloud may be returned).
  • return_mapping (bool, optional) – Only applicable if a PointCloud or ndarray is passed. Returns the mapping dictionary which maps labels to indices into the resulting PointCloud (which is then used to for building a LandmarkGroup. This parameter is only provided for internal use so that other labellers can piggyback off one another.
Returns:

  • x_labelled (LandmarkGroup or PointCloud) – If a LandmarkGroup was passed, a LandmarkGroup is returned. This landmark group will contain specific labels and these labels may refer to sub-pointclouds with specific connectivity information.

    If a PointCloud was passed, a PointCloud is returned. Only the connectivity information is propagated to the pointcloud (a subclass of PointCloud may be returned).

  • mapping_dict (ordereddict {str -> int ndarray}, optional) – Only returned if return_mapping==True. Used for building LandmarkGroup.

Raises:

: :map:`LabellingError` – If the given landmark group/pointcloud contains less than the expected number of points.