hermes.pipeline.components.unblaze.unBlaze Class Reference

unBlaze More...

Inheritance diagram for hermes.pipeline.components.unblaze.unBlaze:

Public Member Functions
def	__init__
	Make a Hermes component and initialize variables.
def	validateOptions
	see if the component receives some options, or set them to default values. More...
def	__call__
	run entry point
Public Member Functions inherited from hermes.pipeline.core.pipelinecomponent.PipelineComponent
def	__init__
def	__call__
def	optionsAreValid
def	getOptions
def	setOptions
def	checkExistShapeUnits
def	isOption

Public Attributes
	minimumShift
	default values for options More...
	maximumShift
	sets maximumShift. More...
	results
Public Attributes inherited from hermes.pipeline.core.pipelinecomponent.PipelineComponent
	options
	logger
	ConsoleLogSeverity
	default value
	canShowGraphics
	when machine does not run matplotlib. More...

Detailed Description

unBlaze

PURPOSE :

computes unblazedExtractedFlatField
= ExtractedFlatField / referenceMaster


COMMENTS :


SYNTAX :


INPUT CONSTANTS FROM INSTRUMENT MODEL :


master extracted flat-field (smoothed)



INPUT DATA FROM RESULTDICT :


MANDATORY :
    extractedFlatField from extractOrders



OPTIONS READ FROM OPTIONDICT :
RESULTDICT

no options for this component



OUTPUT written in the RESULTDICT :

When success condition is met :
    write unblazedExtractedFlatfieldBlazeShift


When success condition is not met :
    record the fatal error message and stop the chain.




SUCCESS CONDITIONS :



    RESULTDICT should provide the input information, usually
    coming from previously runned components.

Member Function Documentation

def hermes.pipeline.components.unblaze.unBlaze.validateOptions	(		self,
			optionDict
	)

see if the component receives some options, or set them to default values.

Member Data Documentation

hermes.pipeline.components.unblaze.unBlaze.maximumShift

sets maximumShift.

Default is 0

hermes.pipeline.components.unblaze.unBlaze.minimumShift

default values for options

sets minimumShift.

Default is 0

---

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

• pipeline/components/unblaze.py