@regulaforensics/face-sdk
    Preparing search index...

    Class OutputImageCrop

    Crop settings for OutputImageParams.

    Index
    • get padColor(): number | null

      When an image is aligned by type, its original size may be insufficient, and in this case it needs to be supplemented, "padded". padColor sets the value for the color that will be used for such a supplement.

      Returns number | null

    • get returnOriginalRect(): boolean

      If set, the coordinates of the rectangle with the face in the original image prepared for the face crop are returned in the DetectFaceResult.originalRect field. Default is false.

      Returns boolean

    • get size(): Size | null

      The resize value to process. If the value doesn't match AspectRatio type proportion or minimum size, an adjustment is applied. Use OutputImageCropAspectRatio to check you size matches AspectRatio type proportions and minimum size.

      Returns Size | null