Class MaskReferenceImage (1.122.0)

Version latest

• 1.122.0 (latest)
• 1.121.0
• 1.120.0
• 1.119.0
• 1.118.0
• 1.117.0
• 1.95.1
• 1.94.0
• 1.93.1
• 1.92.0
• 1.91.0
• 1.90.0
• 1.89.0
• 1.88.0
• 1.87.0
• 1.86.0
• 1.85.0
• 1.84.0
• 1.83.0
• 1.82.0
• 1.81.0
• 1.80.0
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.0
• 1.75.0
• 1.74.0
• 1.73.0
• 1.72.0
• 1.71.1
• 1.70.0
• 1.69.0
• 1.68.0
• 1.67.1
• 1.66.0
• 1.65.0
• 1.63.0
• 1.62.0
• 1.60.0
• 1.59.0

MaskReferenceImage(
    reference_id,
    image: typing.Optional[
        typing.Union[bytes, vertexai.vision_models.Image, str]
    ] = None,
    mask_mode: typing.Optional[
        typing.Literal[
            "default", "user_provided", "background", "foreground", "semantic"
        ]
    ] = None,
    dilation: typing.Optional[float] = None,
    segmentation_classes: typing.Optional[typing.List[int]] = None,
)

Mask reference image. This encapsulates the mask reference image type.

Methods

MaskReferenceImage

MaskReferenceImage(
    reference_id,
    image: typing.Optional[
        typing.Union[bytes, vertexai.vision_models.Image, str]
    ] = None,
    mask_mode: typing.Optional[
        typing.Literal[
            "default", "user_provided", "background", "foreground", "semantic"
        ]
    ] = None,
    dilation: typing.Optional[float] = None,
    segmentation_classes: typing.Optional[typing.List[int]] = None,
)

Creates a MaskReferenceImage object.

Parameters
Name	Description
image	typing.Union[bytes, vertexai.vision_models.Image, str, NoneType] Either Image object or Image file bytes. Image can be in PNG or JPEG format.
mask_mode	typing.Optional[typing.Literal['default', 'user_provided', 'background', 'foreground', 'semantic']] Mask mode for the image. Can take the following values: * default: Default mask mode * user_provided: User provided mask * background: Background mask * foreground: Foreground mask * semantic: Semantic mask
dilation	typing.Optional[float] Dilation percentage of the mask
segmentation_classes	typing.Optional[typing.List[int]] List of class IDs for segmentation. Max of 5 IDs