Pipeline Handlers (nips.pipelines)

The pipelines module consists of a number of classes that handle input and output directories, loggers and parameters of the pipeline. Most of them are run by the Pipeline class and are not important for the user. The most important classes in this module are Pipeline and PipelineParameters, especially the PipelineParameters.m_set() method, which takes the pipeline inputs. For examples and usage of the pipeline we refer to the dedicated sections.

nips.pipelines Package

The nips.pipelines module contains the pipeline management classes for the nips package.

Classes

Database([logger_id])

Class for the handling of the target databases.

ExposureSetup([logger_id])

nips exposure pipeline class.

LoggingTemplate([logger_id])

Template class allowing to use the target pipeline (nips.pipelines.target_pipeline module) logging system in a relatively transparent way.

MasterSetup()

nips master pipeline class.

Pipeline([logger_id])

———- MAIN PIPELINE CLASS ———-

PipelineParameters([logger_id])

Class for the computation parameters the Pipeline

Step(stepname[, logger_id])

Class that executes an entire pipeline step (<STEP>).

TargetParameters([logger_id])

Container lass containing the computation parameters of the target pipeline

TargetSetup()

nips target pipeline class.

Class Inheritance Diagram

Inheritance diagram of nips.pipelines.target_database.Database, nips.pipelines.exposure_setup.ExposureSetup, nips.pipelines.target_logging_template.LoggingTemplate, nips.pipelines.master_setup.MasterSetup, nips.pipelines.pipeline.Pipeline, nips.pipelines.pipeline.PipelineParameters, nips.pipelines.step.Step, nips.pipelines.target_setup.TargetParameters, nips.pipelines.target_setup.TargetSetup