blendgen.dataset

Public symbols exposed by blendgen.dataset.

DatasetOutputType

Class source

class DatasetOutputType(Enum)

Defines the type of dataset output file

Values

JSON = 'JSON'
NPY = 'NPY'

Dataset

Class source

class Dataset

A wrapper class to define the dataset index file

Raises: ValueError: When prefix is not set ValueError: When calling add_frame without a frame_num arg

Returns: Dataset -- The instance of dataset created

Dataset.__init__

Method source

def __init__(self, prefix=None, dataset_name='BlendGen toy dataset', output_dir='data/toy_dataset/', filename='blendgen_dataset', output_type=None)

Create a dataset wrapper class

Keyword Arguments: prefix {str} -- The folder prefix to prepand (default: {None}) dataset_name {str} -- The name of the dataset (default: {"BlendGen toy dataset"}) output_dir {str} -- The base path of the dataset (default: {"data/toy_dataset/"}) filename {str} -- Name of dataset index file without extension (default: {"blendgen_dataset"}) output_type {DatasetOutputType} -- The type of output file to save (default: {None})

Raises: ValueError: when a prefix is not provided

Dataset.add_attribute

Method source

def add_attribute(self, attribute_name=None, attribute_value=None)

A method to manually add an attribute to the dataset

Keyword Arguments: attributeName {str} -- The name of the attribute (default: {None}) attributeValue {any} -- Any value you want to add (default: {None})

Dataset.add_frame

Method source

def add_frame(self, frame_num=None, attributes=None, passes=None)

Add a frame to the dataset index file

Keyword Arguments: frame_num {int} -- The current frame index (default: {None}) attributes {list} -- List of attributes (default: {None}) passes {list} -- List of render passes (default: {None})

Raises: ValueError: when a frame number is not provided

Dataset.save

Method source

def save(self)

Save the dataset to file

Dataset.name

Property source

def name(self)

Dataset name getter

Returns: str -- Name of the dataset

Dataset.prefix

Property source

def prefix(self)

Dataset prefix getter

Returns: str -- The path prefix

Dataset.output_type

Property source

def output_type(self)

Getter for dataset file output type

Returns: DatasetOutputType -- The type of output file

Dataset.raw

Property source

def raw(self)

Dataset frames getter

Returns: list -- The raw dataset frames list