Try for free

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() or datagen.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

time_of_day: Enum

The general time of day in the scene. Uses the TimeOfDay enum.

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() or datagen.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() or datagen.api.catalog.eyebrows.count() functions, you can use this attribute to filter the catalog.

gender_match: List[Enum]

Matches the requested eyebrows(s) with a desired gender. Uses the Gender enum.

An eyebrows asset may match with either or both genders.

NOTE: Gender group matches are recommendations only and are not mandatory.

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() or datagen.api.catalog.eyes.count() functions, you can use this attribute to filter the catalog.

color: Enum

The base color of the texture of the Eyes asset. Uses the EyesColor enum.

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() or datagen.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.

style: List[Enum]

The style of the haircut, e.g., ponytail, crew cut, or afro. Uses the HairStyle enum.

A hair asset may match with more than one style.

For example, one hair asset may be both “balding” and “crew_cut”.

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() or datagen.api.catalog.humans.count() functions, you can use these attributes to filter the catalog.

age: Enum

The age category of the human asset. Uses the Age enum.

ethnicity: Enum

The ethnicity of the human asset. Uses the Ethnicity enum.

gender: Enum

The gender of the human asset. Uses the Gender enum.

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() or datagen.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() or datagen.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.

style: Enum

The general shape and style of the mask. Uses the MaskStyle 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.Age(value)

The list of available genders.

This enum is valid for use in the following attributes:

• HumanAttributes.age

• HairAttributes.age_group_match

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:

• GlassesAttributes.supported_position

• MaskAttributes.supported_position

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:

• BeardAttributes.style

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:

• BackgroundAttributes.environment

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:

• HumanAttributes.ethnicity

• HairAttributes.ethnicity_match

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:

• EyesAttributes.color

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:

• HumanAttributes.gender

• GlassesAttributes.gender

• MaskAttributes.gender

• HairAttributes.gender_match

• EyebrowsAttributes.gender_match

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:

• GlassesAttributes.style

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:

• HairAttributes.length

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:

• HairAttributes.style

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:

• MaskAttributes.style

Values:

CLOTH = 'cloth'

class datagen.api.catalog.attributes.TimeOfDay(value)

The list of valid times of day.

This enum is valid for use in the following attributes:

• BackgroundAttributes.time_of_day

Values:

EVENING = 'evening'

MORNING = 'morning'

NA = 'N/A'

This value is used for the cross-polarized lighting environment.

NIGHT = 'night'