mp.tasks.vision.FaceDetector

Class that performs face detection on images.

mp.tasks.vision.FaceDetector(
    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

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
) -> 'FaceDetector'

Creates an FaceDetector object from a TensorFlow Lite model and the default FaceDetectorOptions.

Note that the created FaceDetector instance is in image mode, for detecting faces on single image inputs.

Args
model_path Path to the model.

Returns
FaceDetector object that's created from the model file and the default FaceDetectorOptions.

Raises
ValueError If failed to create FaceDetector 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.FaceDetectorOptions
) -> 'FaceDetector'

Creates the FaceDetector object from face detector options.

Args
options Options for the face detector task.

Returns
FaceDetector object that's created from options.

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

detect

View source

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

Performs face detection on the provided MediaPipe Image.

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

Args
image MediaPipe Image.
image_processing_options Options for image processing.

Returns
A face detection result object that contains a list of face detections, each detection has a bounding box that is expressed in the unrotated input frame of reference coordinates system, i.e. in [0,image_width) x [0, image_height), which are the dimensions of the underlying image data.

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

detect_async

View source

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

Sends live image data (an Image with a unique timestamp) to perform face detection.

Only use this method when the FaceDetector is created with the live stream running mode. The input timestamps should be monotonically increasing for adjacent calls of this method. This method will return immediately after the input image is accepted. The results will be available via the result_callback provided in the FaceDetectorOptions. The detect_async method is designed to process live stream data such as camera input. To lower the overall latency, face detector may drop the input images if needed. In other words, it's not guaranteed to have output per input image.

The result_callback provides:

  • A face detection result object that contains a list of face detections, each detection has a bounding box that is expressed in the unrotated input frame of reference coordinates system, i.e. in [0,image_width) x [0,image_height), which are the dimensions of the underlying image data.
  • The input image that the face detector runs on.
  • The input timestamp in milliseconds.

Args
image MediaPipe Image.
timestamp_ms The timestamp of the input image in milliseconds.
image_processing_options Options for image processing.

Raises
ValueError If the current input timestamp is smaller than what the face detector has already processed.

detect_for_video

View source

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

Performs face detection on the provided video frames.

Only use this method when the FaceDetector is created with the video running mode. It's required to provide the video frame's timestamp (in milliseconds) along with the video frame. The input timestamps should be monotonically increasing for adjacent calls of this method.

Args
image MediaPipe Image.
timestamp_ms The timestamp of the input video frame in milliseconds.
image_processing_options Options for image processing.

Returns
A face detection result object that contains a list of face detections, each detection has a bounding box that is expressed in the unrotated input frame of reference coordinates system, i.e. in [0,image_width) x [0, image_height), which are the dimensions of the underlying image data.

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

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.