RFSImageCharacteristics

Objective-C

@interface RFSImageCharacteristics: NSObject

/// The image width, pixels.
/// Doesn't have recommended value.
+ (RFSImageQualityCharacteristic *)imageWidthWithRange:(NSArray<NSNumber *> *)range;

/// The image height, pixels.
/// Doesn't have recommended value.
+ (RFSImageQualityCharacteristic *)imageHeightWithRange:(NSArray<NSNumber *> *)range;

/// The image width to height proportion.
/// Doesn't have recommended value.
+ (RFSImageQualityCharacteristic *)imageWidthToHeightWithRange:(NSArray<NSNumber *> *)range;

/// The image RGB channels number.
/// Doesn't have recommended value.
/// Range value [3, 3] is for RGB images.
+ (RFSImageQualityCharacteristic *)imageChannelsNumberWithValue:(NSNumber *)value;

/// Whether the face in the image is a photo, not a drawing, sculpture, cartoon, etc.
/// If the returned value is out of the recommended range, the image is not a photo.
/// The range is from 0 to 1 where 0 means the image is a photo.
+ (RFSImageQualityCharacteristic *)artFace;

/// The percentage of the area of the image that was "padded" during alignment.
/// The characteristic is needed to determine if the head goes beyond the image.
/// The range is from 0 to 1 where 0 is 0% of the image is "padded".
/// Doesn't have recommended value.
+ (RFSImageQualityCharacteristic *)paddingRatioWithMinValue:(NSNumber *)minValue maxValue:(NSNumber *)maxValue;

/// All Group characteristics with default (recommended) values.
/// Doesn't include characteristics without default values.
+ (NSArray<RFSImageQualityCharacteristic *> *)allRecommended;

RFS_EMPTY_INIT_UNAVAILABLE

@end

Swift

class Image : NSObject

Undocumented

  • The image width, pixels. Doesn’t have recommended value.

    Declaration

    Objective-C

    + (nonnull RFSImageQualityCharacteristic *)imageWidthWithRange:
    (nonnull NSArray<NSNumber *> *)range;

    Swift

    class func imageWidth(withRange range: [NSNumber]) -> ImageQualityCharacteristic

  • The image height, pixels. Doesn’t have recommended value.

    Declaration

    Objective-C

    + (nonnull RFSImageQualityCharacteristic *)imageHeightWithRange:
    (nonnull NSArray<NSNumber *> *)range;

    Swift

    class func imageHeight(withRange range: [NSNumber]) -> ImageQualityCharacteristic

  • The image width to height proportion. Doesn’t have recommended value.

    Declaration

    Objective-C

    + (nonnull RFSImageQualityCharacteristic *)imageWidthToHeightWithRange:
    (nonnull NSArray<NSNumber *> *)range;

    Swift

    class func imageWidthToHeight(withRange range: [NSNumber]) -> ImageQualityCharacteristic

  • The image RGB channels number. Doesn’t have recommended value. Range value [3, 3] is for RGB images.

    Declaration

    Objective-C

    + (nonnull RFSImageQualityCharacteristic *)imageChannelsNumberWithValue:
    (nonnull NSNumber *)value;

    Swift

    class func imageChannelsNumber(withValue value: NSNumber) -> ImageQualityCharacteristic

  • Whether the face in the image is a photo, not a drawing, sculpture, cartoon, etc. If the returned value is out of the recommended range, the image is not a photo. The range is from 0 to 1 where 0 means the image is a photo.

    Declaration

    Objective-C

    + (nonnull RFSImageQualityCharacteristic *)artFace;

    Swift

    class func artFace() -> ImageQualityCharacteristic

  • The percentage of the area of the image that was “padded” during alignment. The characteristic is needed to determine if the head goes beyond the image. The range is from 0 to 1 where 0 is 0% of the image is “padded”. Doesn’t have recommended value.

    Declaration

    Objective-C

    + (nonnull RFSImageQualityCharacteristic *)
    paddingRatioWithMinValue:(nonnull NSNumber *)minValue
                    maxValue:(nonnull NSNumber *)maxValue;

    Swift

    class func paddingRatio(withMinValue minValue: NSNumber, maxValue: NSNumber) -> ImageQualityCharacteristic

  • All Group characteristics with default (recommended) values. Doesn’t include characteristics without default values.

    Declaration

    Objective-C

    + (nonnull NSArray<RFSImageQualityCharacteristic *> *)allRecommended;

    Swift

    class func allRecommended() -> [ImageQualityCharacteristic]

  • Unavailable

    Not the designated initializer

    Undocumented

    Declaration

    Objective-C

    RFS_EMPTY_INIT_UNAVAILABLE

  • Unavailable

    Not the designated initializer

    Undocumented

    Declaration

    Objective-C

    RFS_EMPTY_INIT_UNAVAILABLE