hermes.pipeline.components.convertADUtophotonunits.convertADUtoPhotonUnits Class Reference

multiplication of ADU counts with gain factor More...

Inheritance diagram for hermes.pipeline.components.convertADUtophotonunits.convertADUtoPhotonUnits:

Public Member Functions
def	__init__
	Make a Hermes component and initialize variables.
def	optionsAreValid
	read user's choices
def	__call__
	runs from here
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
	results
	isDebug
	user may want intermediary files More...
Public Attributes inherited from hermes.pipeline.core.pipelinecomponent.PipelineComponent
	options
	logger
	ConsoleLogSeverity
	default value
	canShowGraphics
	when machine does not run matplotlib. More...

Detailed Description

multiplication of ADU counts with gain factor

PURPOSE :

This module transforms the intensities in the input image from ADU units
to electrons, facilitating the inclusion of the error progression through
the data reduction chain. It also generates the variance frame, or, in the
case that the input frame is the average of a stack of frames, converts
the existing variance frame from ADU to electrons


COMMENTS :

The "number Of Images In Stack" is taken into account for the error computation.
It is given by «len(self.results["FITSFileNames"])».
One may consider to add the efficiency factor for conversion of electrons
to photons. Which one (electrons or photons) determines the error computation?


SYNTAX :


INPUT CONSTANTS FROM INSTRUMENT MODEL :

Image with shape of detector, in ADU units, from self.results.image
"gain" factor from the instrument model


INPUT DATA FROM RESULTDICT :

self.results.readoutNoise as chosen in subtractbiasCCD is needed to compute
the variance image in the input image originates from a single exposure


OPTIONS READ FROM OPTIONDICT :

MANDATORY :

OPTIONAL :
    isDebug (True or False)
        default value : False
        writes two fits files with the results
            image           in 'T10image.fits')
            imageVariance   in 'T11imageVariance.fits')


OUTPUT written in the RESULTDICT :

Image with shape of detector, in electron units, in self.results.image with
updated self.results.imageUnits, also in header
Corresponding variance image in self.results.imageVariance

Member Data Documentation

hermes.pipeline.components.convertADUtophotonunits.convertADUtoPhotonUnits.isDebug

user may want intermediary files

Assume a is an array that you want to ''clip'' so that no values are greater than 100.0.

choose(greater(a, 100.0), (a, 100.0))

choose(less(.. replaces negative values by zeroes

---

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

• pipeline/components/convertADUtophotonunits.py