Settings reference#

class blenderline.settings.ImageDatasetSettings#

TODO

__init__(config, target)#

TODO

Parameters:
  • config (pathlib.Path) – Absolute location of the configuration file.

  • target (pathlib.Path) – Absolute location of the directory where the dataset is generated.

Return type:

None

get(key, default=None)#
Get nested value from settings dictionary using dot notation to specify

a path of keys to follow. E.g., “scene.path”. Intermediate keys will return an empty dictionary of not present, so the function will always follow the entire key path.

Parameters:
  • key (str) – dot-separated path of keys to follow

  • default (_type_, optional) – default value to return if key does not exist. Note that this is also triggered if an intermediary key is not present. Defaults to None.

get_background_collection()#

Create background collection from registered backgrounds in settings.

Returns:

collection of backgrounds.

Return type:

BackgroundCollection

get_background_manager()#

Create background manager using parameters configured in settings.

Returns:

background manager object.

Return type:

BackgroundManager

get_dataset_generator()#

Create image dataset generator using parameters configured in settings.

Returns:

dataste generator object.

Return type:

ImageDatasetGenerator

get_hdr_collection()#

Create HDR collection from registered HDR backgrounds in settings.

Returns:

collection of HDR backgrounds.

Return type:

HDRCollection

get_hdr_manager()#

Create HDR background manager using parameters configured in settings.

Returns:

HDR manager object.

Return type:

HDRManager

get_item_collection()#

Create item collection from registered items in settings.

Returns:

collection of items.

Return type:

ItemCollection

get_item_manager()#

Create item manager using parameters configured in settings.

Returns:

item manager object.

Return type:

ItemManager

get_scene_manager()#

Create scene manager using parameters configured in settings.

Returns:

scene manager object.

Return type:

SceneManager