synthesizers.synth_workers.base_synthesizer module

Implements Base Synthesizer which defines an interface across all Synthesizer Workers.

class synthesizers.synth_workers.base_synthesizer.BaseSynthesizer(class_name: str, scenario_owner: str)

Bases: object

Implements Base Synthesizer which defines an interface across all Synthesizer Workers.

__name__

Defines name of the <__call__> magic method, which Omniverse Replicator uses to register a method. It has to return synthesizer name, the same name as is used in the config.

Type:

str

scenario_owner

Defines the name of owning Scenario.

Type:

str

abstract __call__(camera_setup: List[str]) → None

With this magic function, a command is executed.

Parameters:

camera_setup (List[str]) – List of camera primitive paths in for the camera setup. It can contain more than one camera, e.g. stereo camera or more complicated camera rigs.

__init__(class_name: str, scenario_owner: str) → None

abstract get_prims() → List[str]

Returns paths in stage to Synthesizer’s created prims.

Returns:

List of stage prim paths.

Return type:

List[str]

abstract register_synthesizers_prims(synthesizer_workers: Dict[str, BaseSynthesizer]) → None

Allows an access to other Synthesizer’s prims if needed.

Parameters:

synthesizer_workers (Dict[str, BaseSynthesizer]) – Dict of all Synthesizers.

Returns (None):