Class MaskReferenceImage

A mask reference image.

This encapsulates either a mask image provided by the user and configs for the user provided mask, or only config parameters for the model to generate a mask.

A mask image is an image whose non-zero values indicate where to edit the base image. If the user provides a mask image, the mask must be in the same dimensions as the raw image.

Constructors

Properties

Configuration for the mask reference image.

referenceId?: number

The id of the reference image.

referenceImage?: Image

The reference image for the editing operation.

referenceType?: string

The type of the reference image. Only set by the SDK.

Methods

  • Internal method to convert to ReferenceImageAPIInternal.

    Returns ReferenceImageAPIInternal