api#
- datagen.api.create_datapoint(human: Human, camera: Camera, glasses: Optional[Glasses] = None, mask: Optional[Mask] = None, background: Optional[Background] = None, lights: Optional[List[Light]] = None) HumanDatapoint#
Puts together all of the parts of a datapoint, for inclusion in your data request.
- Parameters:
human (datagen.api.assets.Human) – The human asset to be used in the scene. See
datagen.api.catalog.humans.camera (datagen.api.assets.Camera) – The camera in the scene.
glasses (datagen.api.assets.Glasses) – Optional. The glasses asset, if any, worn by the human in the scene.
mask (datagen.api.assets.Mask) – Optional. The mask asset, if any, worn by the human in the scene.
background (datagen.api.assets.Background) – The HDRI background asset to be used in the scene. Required if using a visual spectrum camera; forbidden if using a near-infrared camera.
lights (List[datagen.api.assets.Light]) – Any special lighting requirements to be added to the scene, such as near-infrared lighting.
- Returns:
A formatted datapoint for inclusion in your
datagen.api.assets.DataRequest.- Return type:
- datagen.api.dump(request: DataRequest, path: Optional[str] = None) None#
Generates a JSON file from a datagen.api.assets.DataRequest object
- Parameters:
request (datagen.api.assets.DataRequest) – Your data request, containing instructions for generating one or more datapoints
path (str) – The output path for the file. Must use a .json extension. Optional, defaults to “datagen_data_request.json”.
- Returns:
None
- datagen.api.load(path: str) DataRequest#
Creates a DataRequest object from an existing JSON file.
- Parameters:
path (str) – The path to the JSON file.
- Returns:
A DataRequest object containing all of the datapoints in the loaded file.
- Return type: