sierra.core.pipeline.stage3.imagizer

Classes for creating image files from .mean files for experiments.

See Rendering for usage documentation.

• BatchExpParallelImagizer: Generate images for each Experiment in the Batch Experiment.

• ExpImagizer: Create images from the averaged .mean files from an experiment.

class sierra.core.pipeline.stage3.imagizer.BatchExpParallelImagizer(main_config: Dict[str, Any], cmdopts: Dict[str, Any])

Generate images for each Experiment in the Batch Experiment.

Ideally this is done in parallel across experiments, but this can be changed to serial if memory on the SIERRA host machine is limited via --processing-serial.

Inheritance

__call__(HM_config: Dict[str, Any], criteria: IConcreteBatchCriteria) → None

Call self as a function.

__dict__ = mappingproxy({'__module__': 'sierra.core.pipeline.stage3.imagizer', '__doc__': 'Generate images for each :term:`Experiment` in the :term:`Batch Experiment`.\n\n    Ideally this is done in parallel across experiments, but this can be changed\n    to serial if memory on the SIERRA host machine is limited via\n    ``--processing-serial``.\n\n    ', '__init__': <function BatchExpParallelImagizer.__init__>, '__call__': <function BatchExpParallelImagizer.__call__>, '_enqueue_for_exp': <function BatchExpParallelImagizer._enqueue_for_exp>, '_thread_worker': <staticmethod object>, '__dict__': <attribute '__dict__' of 'BatchExpParallelImagizer' objects>, '__weakref__': <attribute '__weakref__' of 'BatchExpParallelImagizer' objects>, '__annotations__': {}})

__doc__ = 'Generate images for each :term:`Experiment` in the :term:`Batch Experiment`.\n\n    Ideally this is done in parallel across experiments, but this can be changed\n    to serial if memory on the SIERRA host machine is limited via\n    ``--processing-serial``.\n\n    '

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

__module__ = 'sierra.core.pipeline.stage3.imagizer'

__weakref__

list of weak references to the object (if defined)

_enqueue_for_exp(exp_stat_root: Path, exp_imagize_root: Path, q: JoinableQueue) → None

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

class sierra.core.pipeline.stage3.imagizer.ExpImagizer

Create images from the averaged .mean files from an experiment.

If no .mean files suitable for averaging are found, nothing is done. See Rendering for per-platform descriptions of what “suitable” means.

Parameters:

• HM_config – Parsed YAML configuration for heatmaps.

• imagize_opts – Dictionary of imagizing options.

Inheritance

__call__(HM_config: Dict[str, Any], imagize_opts: dict) → None

Call self as a function.

__dict__ = mappingproxy({'__module__': 'sierra.core.pipeline.stage3.imagizer', '__doc__': 'Create images from the averaged ``.mean`` files from an experiment.\n\n    If no ``.mean`` files suitable for averaging are found, nothing is done. See\n    :ref:`ln-sierra-usage-rendering` for per-platform descriptions of what\n    "suitable" means.\n\n    Arguments:\n\n        HM_config: Parsed YAML configuration for heatmaps.\n\n        imagize_opts: Dictionary of imagizing options.\n\n    ', '__init__': <function ExpImagizer.__init__>, '__call__': <function ExpImagizer.__call__>, '__dict__': <attribute '__dict__' of 'ExpImagizer' objects>, '__weakref__': <attribute '__weakref__' of 'ExpImagizer' objects>, '__annotations__': {}})

__doc__ = 'Create images from the averaged ``.mean`` files from an experiment.\n\n    If no ``.mean`` files suitable for averaging are found, nothing is done. See\n    :ref:`ln-sierra-usage-rendering` for per-platform descriptions of what\n    "suitable" means.\n\n    Arguments:\n\n        HM_config: Parsed YAML configuration for heatmaps.\n\n        imagize_opts: Dictionary of imagizing options.\n\n    '

__init__() → None

__module__ = 'sierra.core.pipeline.stage3.imagizer'

__weakref__

list of weak references to the object (if defined)