api.catalog.attributes#
- class datagen.api.catalog.attributes.BackgroundAttributes(environment: Enum, time_of_day: Enum, strength: Optional[float] = None)#
Each background asset contains the following read-only attributes.
When you call the
datagen.api.catalog.backgrounds.get()
ordatagen.api.catalog.backgrounds.count()
functions, you can use this attribute to filter the catalog.- environment: Enum#
The general location of the scene (indoor or outdoor). Uses the
Environment
enum.
- strength: Optional[float] = None#
Float. A measure of the strength of the lighting in the scene
- class datagen.api.catalog.attributes.BeardAttributes(style: Enum)#
Each beard asset contains the following read-only attribute.
When you call the
datagen.api.catalog.beards.get()
ordatagen.api.catalog.beards.count()
functions, you can use this attribute to filter the catalog.- style: Enum#
The general category of facial hair, such as full beard, stubble, or mustache. Uses the
BeardStyle
enum.
- class datagen.api.catalog.attributes.EyebrowsAttributes(gender_match: List[Enum])#
Each eyebrows asset contains the following read-only attribute.
When you call the
datagen.api.catalog.eyebrows.get()
ordatagen.api.catalog.eyebrows.count()
functions, you can use this attribute to filter the catalog.
- class datagen.api.catalog.attributes.EyesAttributes(color: Enum)#
Each eyes asset contains the following read-only attribute.
When you call the
datagen.api.catalog.eyes.get()
ordatagen.api.catalog.eyes.count()
functions, you can use this attribute to filter the catalog.
- class datagen.api.catalog.attributes.HairAttributes(age_group_match: List[Enum], ethnicity_match: List[Enum], gender_match: List[Enum], length: Enum, style: List[Enum])#
Each hair asset contains the following read-only attributes.
When you call the
datagen.api.catalog.hair.get()
ordatagen.api.catalog.hair.count()
functions, you can use this attribute to filter the catalog.- age_group_match: List[Enum]#
Matches the requested hairstyle(s) with a desired age group. Uses the
Age
enum.A hairstyle may match with any number of age groups, or even all of them.
NOTE: Age group matches are recommendations only and are not mandatory.
- ethnicity_match: List[Enum]#
Matches the requested hairstyle(s) with a desired ethnicity. Uses the
Ethnicity
enum.A hair asset may match with any number of ethnicities, or even all of them.
NOTE: Ethnicity matches are recommendations only and are not mandatory.
- gender_match: List[Enum]#
Matches the requested hairstyle(s) with a desired gender. Uses the
Gender
enum.A hair asset may match with either or both genders.
NOTE: Gender matches are recommendations only and are not mandatory.
- length: Enum#
The length of the haircut. Uses the
HairLength
enum.
- class datagen.api.catalog.attributes.HumanAttributes(age: Enum, ethnicity: Enum, gender: Enum)#
Each human asset contains the following read-only attributes.
When you call the
datagen.api.catalog.humans.get()
ordatagen.api.catalog.humans.count()
functions, you can use these attributes to filter the catalog.
- class datagen.api.catalog.attributes.GlassesAttributes(supported_position: List[Enum], gender: List[Enum], style: Enum)#
Each glasses asset contains the following read-only attributes.
When you call the
datagen.api.catalog.glasses.get()
ordatagen.api.catalog.glasses.count()
functions, you can use this attribute to filter the catalog.- gender: List[Enum]#
Matches the requested accessory(s) with a desired gender. Uses the
Gender
enum.An accessory may match with either or both genders.
NOTE: Gender matches are recommendations only and are not mandatory.
- style: Enum#
The general shape and style of the pair of glasses. Uses the
GlassesStyle
enum.
- supported_position: List[Enum]#
The list of positions on the body where this accessory can be worn. Uses the
AccessoryPosition
enum.
- class datagen.api.catalog.attributes.MaskAttributes(supported_position: List[Enum], gender: List[Enum], style: Enum)#
Each mask asset contains the following read-only attributes.
When you call the
datagen.api.catalog.masks.get()
ordatagen.api.catalog.masks.count()
functions, you can use this attribute to filter the catalog.- gender: List[Enum]#
Matches the requested accessory(s) with a desired gender. Uses the
Gender
enum.An accessory may match with either or both genders.
NOTE: Gender matches are recommendations only and are not mandatory.
- supported_position: List[Enum]#
The list of positions on the body where this accessory can be worn. Uses the
AccessoryPosition
enum.
- class datagen.api.catalog.attributes.Age(value)#
The list of available genders.
This enum is valid for use in the following attributes:
Values:
- ADULT = 'adult'#
Approximate age range: 31-50
- OLD = 'old'#
Approximate age range: 51+
- YOUNG = 'young'#
Approximate age range: 18-30
- class datagen.api.catalog.attributes.AccessoryPosition(value)#
The list of available positions where an accessory can be worn.
This enum is valid for use in the following attributes:
Values:
- ON_CHIN = 'chin'#
- ON_MOUTH = 'mouth'#
- ON_NOSE = 'nose'#
- class datagen.api.catalog.attributes.BeardStyle(value)#
The list of valid beard styles.
This enum is valid for use in the following attributes:
Values:
- BEARD = 'beard'#
- FULL_BEARD = 'full_beard'#
- MUSTACHE = 'mustache'#
- PARTIAL_BEARD = 'partial_beard'#
- STUBBLE = 'stubble'#
- class datagen.api.catalog.attributes.Environment(value)#
The list of valid environments.
This enum is valid for use in the following attributes:
Values:
- CROSS_POLARIZED = 'cross_polarized'#
- INDOOR = 'indoor'#
- OUTDOOR = 'outdoor'#
- class datagen.api.catalog.attributes.Ethnicity(value)#
The list of available ethnicities.
This enum is valid for use in the following attributes:
- AFRICAN = 'african'#
- EAST_ASIAN = 'east_asian'#
- HISPANIC = 'hispanic'#
- MEDITERRANEAN = 'mediterranean'#
- NORTH_EUROPEAN = 'north_european'#
- SOUTHEAST_ASIAN = 'southeast_asian'#
- SOUTH_ASIAN = 'south_asian'#
- class datagen.api.catalog.attributes.EyesColor(value)#
The list of available eye colors.
This enum is valid for use in the following attributes:
Values:
- BLUE = 'blue'#
- BROWN = 'brown'#
- GREEN = 'green'#
- class datagen.api.catalog.attributes.Gender(value)#
The list of available genders.
This enum is valid for use in the following attributes:
Values:
- FEMALE = 'female'#
- MALE = 'male'#
- class datagen.api.catalog.attributes.GlassesStyle(value)#
The list of valid glasses styles.
This enum is valid for use in the following attributes:
Values:
- AVIATOR = 'aviator'#
- BROWLINE = 'browline'#
- CAT_EYE = 'cat_eye'#
- GEOMETRIC = 'geometric'#
- OVAL = 'oval'#
- OVERSIZED = 'oversized'#
- READING_FULL_FRAME = 'reading_full_frame'#
- READING_RIMLESS = 'reading_rimless'#
- ROUND = 'round'#
- class datagen.api.catalog.attributes.HairLength(value)#
The list of valid hair lengths.
This enum is valid for use in the following attributes:
Values:
- ARMPIT = 'armpit'#
- BUZZ_CUT = 'buzz_cut'#
- CHIN = 'chin'#
- EAR = 'ear'#
- MID_BACK = 'mid_back'#
- SHOULDER = 'shoulder'#
- TAILBONE = 'tailbone'#
- UNDEFINED = 'undefined'#
- class datagen.api.catalog.attributes.HairStyle(value)#
The list of valid hair styles.
This enum is valid for use in the following attributes:
Values:
- AFRO = 'afro'#
- BALDING = 'balding'#
- BANGS = 'bangs'#
- BOB = 'bob'#
- BUN = 'bun'#
- CREW_CUT = 'crew_cut'#
- CURTAIN = 'curtain'#
- HAIR_DOWN = 'hair_down'#
- HIGH_TOP_CUT = 'high_top_cut'#
- LAYERED = 'layered'#
- PONYTAIL = 'ponytail'#
- PULLED_BACK = 'pulled_back'#
- UNDEFINED = 'undefined'#
- class datagen.api.catalog.attributes.MaskStyle(value)#
The list of valid mask styles.
This enum is valid for use in the following attributes:
Values:
- CLOTH = 'cloth'#