hermes.pipeline.core.pipelinecomponent.PipelineComponent Class Reference

Defines a common structure for the components. More...

Inheritance diagram for hermes.pipeline.core.pipelinecomponent.PipelineComponent:

Public Member Functions
def	__init__
def	__call__
def	optionsAreValid
def	getOptions
def	setOptions
def	checkExistShapeUnits
def	isOption

Public Attributes
	options
	logger
	ConsoleLogSeverity
	default value
	canShowGraphics
	when machine does not run matplotlib. More...

Detailed Description

Defines a common structure for the components.

    PURPOSE: Base Class for chain components

Constructor & Destructor Documentation

def hermes.pipeline.core.pipelinecomponent.PipelineComponent.__init__	(		self,
			resultDict
	)

    PURPOSE: Initialize the PipelineComponent

Member Function Documentation

def hermes.pipeline.core.pipelinecomponent.PipelineComponent.__call__	(		self,
			resultDict,
			instrumentModel
	)

PURPOSE: make it callable  ( overrides the " ( )"). This function should be overloaded
by the child class.

def hermes.pipeline.core.pipelinecomponent.PipelineComponent.checkExistShapeUnits	(		self,
			name,
			shape,
			units,
			resultDict,
			instrumentModel
	)

PURPOSE : used to allow a component to run only with correct input

name must be "rawimage", "image", "orders" and determines the name to be found in the resultdict
shape must be "raw", "CCD", "orders" and determines the shape deducted from the instrumentmodel
units must be "ADU", "electron"

the resultdict should contain those.

def hermes.pipeline.core.pipelinecomponent.PipelineComponent.getOptions

(

self

)

PURPOSE: Returns the option dictionary defined in the class constructor

def hermes.pipeline.core.pipelinecomponent.PipelineComponent.isOption	(		self,
			value,
			equals
	)

PURPOSE: test independently from the case.
Just pass two values to compare.
Returns True or False.

INPUT: . value, value to compare to

def hermes.pipeline.core.pipelinecomponent.PipelineComponent.optionsAreValid	(		self,
			optionDict
	)

PURPOSE: Check whether the given options are valid options. his function should be
overloaded by the child class.

def hermes.pipeline.core.pipelinecomponent.PipelineComponent.setOptions	(		self,
			optionDict
	)

PURPOSE: check if the options given are valid and relevant for this pipeline
component. If yes, store it as a class member.

INPUT: optionDict: dictionary with the options relevant to this pipeline component

Member Data Documentation

hermes.pipeline.core.pipelinecomponent.PipelineComponent.canShowGraphics

when machine does not run matplotlib.

This makes it possible to run the reduction anyway, but without graphics.

---

The documentation for this class was generated from the following file:

• pipeline/core/pipelinecomponent.py