mp.tasks.vision.FaceAligner

Class that performs face alignment on images.

mp.tasks.vision.FaceAligner(
    graph_config: mp.calculators.core.constant_side_packet_calculator_pb2.mediapipe_dot_framework_dot_calculator__pb2.CalculatorGraphConfig,
    running_mode: mp.tasks.vision.RunningMode,
    packet_callback: Optional[Callable[[Mapping[str, packet_module.Packet]], None]] = None
) -> None

graph_config The mediapipe vision task graph config proto.
running_mode The running mode of the mediapipe vision task.
packet_callback The optional packet callback for getting results asynchronously in the live stream mode.

ValueError The packet callback is not properly set based on the task's running mode.

Methods

align

View source

align(
    image: mp.Image,
    image_processing_options: Optional[mp.tasks.vision.holistic_landmarker.image_processing_options_module.ImageProcessingOptions] = None
) -> mp.Image

Performs face alignment on the provided MediaPipe Image.

Only use this method when the FaceAligner is created with the image running mode.

Args
image MediaPipe Image.
image_processing_options Options for image processing.

Returns
The aligned face image. The aligned output image size is the same as the model output size. None if no face is detected on the input image.

Raises
ValueError If any of the input arguments is invalid.
RuntimeError If face alignment failed to run.

close

View source

close() -> None

Shuts down the mediapipe vision task instance.

Raises
RuntimeError If the mediapipe vision task failed to close.

convert_to_normalized_rect

View source

convert_to_normalized_rect(
    options: mp.tasks.vision.holistic_landmarker.image_processing_options_module.ImageProcessingOptions,
    image: mp.Image,
    roi_allowed: bool = True
) -> mp.tasks.components.containers.NormalizedRect

Converts from ImageProcessingOptions to NormalizedRect, performing sanity checks on-the-fly.

If the input ImageProcessingOptions is not present, returns a default NormalizedRect covering the whole image with rotation set to 0. If 'roi_allowed' is false, an error will be returned if the input ImageProcessingOptions has its 'region_of_interest' field set.

Args
options Options for image processing.
image The image to process.
roi_allowed Indicates if the region_of_interest field is allowed to be set. By default, it's set to True.

Returns
A normalized rect proto that represents the image processing options.

create_from_model_path

View source

@classmethod
create_from_model_path(
    model_path: str
) -> 'FaceAligner'

Creates a FaceAligner object from a face landmarker task bundle and the default FaceAlignerOptions.

Note that the created FaceAligner instance is in image mode, for aligning one face on a single image input.

Args
model_path Path to the face landmarker task bundle.

Returns
FaceAligner object that's created from the model file and the default FaceAlignerOptions.

Raises
ValueError If failed to create FaceAligner object from the provided file such as invalid file path.
RuntimeError If other types of error occurred.

create_from_options

View source

@classmethod
create_from_options(
    options: mp.tasks.vision.FaceAlignerOptions
) -> 'FaceAligner'

Creates the FaceAligner object from face aligner options.

Args
options Options for the face aligner task.

Returns
FaceAligner object that's created from options.

Raises
ValueError If failed to create FaceAligner object from FaceAlignerOptions such as missing the model.
RuntimeError If other types of error occurred.

get_graph_config

View source

get_graph_config() -> mp.calculators.core.constant_side_packet_calculator_pb2.mediapipe_dot_framework_dot_calculator__pb2.CalculatorGraphConfig

Returns the canonicalized CalculatorGraphConfig of the underlying graph.

__enter__

View source

__enter__()

Return self upon entering the runtime context.

__exit__

View source

__exit__(
    unused_exc_type, unused_exc_value, unused_traceback
)

Shuts down the mediapipe vision task instance on exit of the context manager.

Raises
RuntimeError If the mediapipe vision task failed to close.