sierra.core.pipeline.stage4.rendering

Classes for rendering frames (images) into videos.

Frames can be:

• Captured by by the --platform during stage 2.

• Generated during stage 3 of SIERRA via imagizing.

• Generated inter-experiment heatmaps from bivariate experiments.

• ParallelRenderer: Base class for performing the requested rendering in parallel.

• PlatformFramesRenderer: Renders frames (images) captured in each experimental run by a platform.

• ProjectFramesRenderer: Render the video for each experimental run in each experiment.

• BivarHeatmapRenderer: Render videos from generated inter-experiment heatmaps.

• ExpRenderer: Render all images in the input directory to a video via ffmpeg.

class sierra.core.pipeline.stage4.rendering.ParallelRenderer(main_config: Dict[str, Any], cmdopts: Dict[str, Any])

Base class for performing the requested rendering in parallel.

Unless disabled with --proccessing-serial, then it is done serially.

Inheritance

__dict__ = mappingproxy({'__module__': 'sierra.core.pipeline.stage4.rendering', '__doc__': 'Base class for performing the requested rendering in parallel.\n\n    Unless disabled with ``--proccessing-serial``, then it is done serially.\n\n    ', '__init__': <function ParallelRenderer.__init__>, 'do_rendering': <function ParallelRenderer.do_rendering>, '_thread_worker': <staticmethod object>, '__dict__': <attribute '__dict__' of 'ParallelRenderer' objects>, '__weakref__': <attribute '__weakref__' of 'ParallelRenderer' objects>, '__annotations__': {}})

__doc__ = 'Base class for performing the requested rendering in parallel.\n\n    Unless disabled with ``--proccessing-serial``, then it is done serially.\n\n    '

__init__(main_config: Dict[str, Any], cmdopts: Dict[str, Any]) → None

__module__ = 'sierra.core.pipeline.stage4.rendering'

__weakref__

list of weak references to the object (if defined)

static _thread_worker(q: Queue, main_config: Dict[str, Any]) → None

do_rendering(inputs: List[Dict[str, Union[str, int]]]) → None

Do the rendering.

class sierra.core.pipeline.stage4.rendering.PlatformFramesRenderer(main_config: Dict[str, Any], cmdopts: Dict[str, Any])

Renders frames (images) captured in each experimental run by a platform.

Inheritance

__call__(criteria: IConcreteBatchCriteria) → None

Call self as a function.

__doc__ = 'Renders frames (images) captured in each experimental run by a platform.\n\n    '

__init__(main_config: Dict[str, Any], cmdopts: Dict[str, Any]) → None

__module__ = 'sierra.core.pipeline.stage4.rendering'

_calc_rendering_inputs(exp: Path) → List[Dict[str, Union[str, int]]]

class sierra.core.pipeline.stage4.rendering.ProjectFramesRenderer(main_config: Dict[str, Any], cmdopts: Dict[str, Any])

Render the video for each experimental run in each experiment.

Inheritance

__call__(criteria: IConcreteBatchCriteria) → None

Call self as a function.

__doc__ = 'Render the video for each experimental run in each experiment.\n    '

__init__(main_config: Dict[str, Any], cmdopts: Dict[str, Any]) → None

__module__ = 'sierra.core.pipeline.stage4.rendering'

_calc_rendering_inputs(exp: Path) → List[Dict[str, Union[str, int]]]

class sierra.core.pipeline.stage4.rendering.BivarHeatmapRenderer(main_config: Dict[str, Any], cmdopts: Dict[str, Any])

Render videos from generated inter-experiment heatmaps.

versionadded:: 1.2.20

Inheritance

__call__(criteria: IConcreteBatchCriteria) → None

Call self as a function.

__doc__ = 'Render videos from generated inter-experiment heatmaps.\n\n    versionadded:: 1.2.20\n    '

__init__(main_config: Dict[str, Any], cmdopts: Dict[str, Any]) → None

__module__ = 'sierra.core.pipeline.stage4.rendering'

_calc_rendering_inputs() → List[Dict[str, Union[str, int]]]

class sierra.core.pipeline.stage4.rendering.ExpRenderer

Render all images in the input directory to a video via ffmpeg.

Inheritance

__call__(main_config: Dict[str, Any], render_opts: Dict[str, str]) → None

Call self as a function.

__dict__ = mappingproxy({'__module__': 'sierra.core.pipeline.stage4.rendering', '__doc__': 'Render all images in the input directory to a video via :program:`ffmpeg`.\n\n    ', '__init__': <function ExpRenderer.__init__>, '__call__': <function ExpRenderer.__call__>, '__dict__': <attribute '__dict__' of 'ExpRenderer' objects>, '__weakref__': <attribute '__weakref__' of 'ExpRenderer' objects>, '__annotations__': {}})

__doc__ = 'Render all images in the input directory to a video via :program:`ffmpeg`.\n\n    '

__init__() → None

__module__ = 'sierra.core.pipeline.stage4.rendering'

__weakref__

list of weak references to the object (if defined)