hermes.pipeline.components.wlmodel.wlModel Class Reference

Inheritance diagram for hermes.pipeline.components.wlmodel.wlModel:

Public Member Functions
def	__init__
	Make a Hermes component and initialize variables.
def	optionsAreValid
	check the options we need
def	__call__
	run the component
def	__absoluteModel__
def	__writeCheckFITS__
def	__differentialModel__
def	__getMask__
	get mask
def	__matrixBuilder__
	build the result matrix More...
def	__applyModelOfShifts__
def	__coefficientsInHeader__
	update fits header More...
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
	canShowGraphics
	isDebug
	isDebug is False by default. More...
	middleRow
	middleRowCCD
	middleOrder
	middleOrderCCD
	polyorderdiff
	orderPolynomeDegreeDifferentialModel
	polyrowdiff
	rowPolynomeDegreeDifferentialModel
	polyorderabs
	orderPolynomeDegreeAbsoluteModel
	polyrowabs
	row polynome degree absolute model, default is 8 More...
	isDifferential
	Should be True or False, default is True.
	results
	toleranceFactor
	default for toleranceFactor is 7
	allowedLimitOfRejectedLines
	default for allowedLimitOfRejectedLines is 100
	firstOrder
	reddest order
	lastOrder
	bluest order
	rootAbs
	1st step compute the shift model
Public Attributes inherited from hermes.pipeline.core.pipelinecomponent.PipelineComponent
	options
	logger
	ConsoleLogSeverity
	default value
	canShowGraphics
	when machine does not run matplotlib. More...

Detailed Description

PURPOSE :



COMMENTS :



SYNTAX :


INPUT CONSTANTS FROM INSTRUMENT MODEL :


INPUT DATA FROM RESULTDICT :

    FITSheader (fits header):
        the header of the input wavelength calibration frame
        used to update/add the coefficients of the WLC model

    extImageWCF (extracted WCF):
        is the extracted image that was used in the linepositions module
        to locate the calibration spectral lines. This frame is here only
        used to produce a fits file having in the header the coefficients.

    When absolute model is needed:
    AbsoluteLinePositions (matrix)
        Elements per spectral line are:
            1. Absolute pixel position
            2. Line intensities or surfaces (measured)
            3. Maxima of the correlation functions
            4. Order number
            5. Tabulated central wavelength
            6. Expected line position in pixel units
            7. log. of line surface (expected);
    selectedLampLinesDescription (list of Strings)
        descriptions of the lines found in the table used to identify the lines in the WC frame

    When differential model is needed:
    wlDispersionCoefficientsFromWCFtemplate
        Wavelength dispersion coefficients saved in the WCF template

OPTIONS READ FROM OPTIONDICT :

    isDebug (boolean)
        default : False

    middleRowCCD (int)
        default : 2304

    middleOrderCCD (int)
        default : 70

    orderPolynomeDegreeDifferentialModel (int)
        default : 2

    rowPolynomeDegreeDifferentialModel (int)
        default : 2

    orderPolynomeDegreeAbsoluteModel (int)
        default : 8

    rowPolynomeDegreeAbsoluteModel (int)
        default : 8


OUTPUT WRITTEN TO THE RESULTDICT:

    wavelengthScale (Matrix (nbORder x nbRows))
        The wavelength scale. It has the same dimensions than extImageWCF.

    wlDispersionCoefficients
        Wavelength dispersion coefficients

OUTPUT FILES:

    wavelengthScale.fits
        the wavelength scale is saved in a fits file (Matrix (nbORder x nbRows))
        it has the same dimensions than extImageWCF

    OMCS4CHECK.XLS
        if absolute wavelength calibration is required then this ascii profile
        provides an overview of the rejected/used ThAr lines.

    WCFrameFromWLMODEL.fits
        the WCF frame with the WL dispersion coefficients updated in the header

SUCCESS CONDITIONS :

Member Function Documentation

def hermes.pipeline.components.wlmodel.wlModel.__absoluteModel__

(

self

)

Model for absolute wavelength calibration

def hermes.pipeline.components.wlmodel.wlModel.__applyModelOfShifts__

(

self

)

Make a frame with the "new" row positions. Then get the corrected wavelength scale.

def hermes.pipeline.components.wlmodel.wlModel.__coefficientsInHeader__	(		self,
			coefs,
			header
	)

update fits header

Update/add the coefficients in the header.
@param coefs   : coefficients of the wavelength dispersion model
@param header  : the header to update
@return header : updated header

def hermes.pipeline.components.wlmodel.wlModel.__differentialModel__

(

self

)

Model for differential wavelength calibration

def hermes.pipeline.components.wlmodel.wlModel.__matrixBuilder__	(		self,
			LinePositions,
			mask
	)

build the result matrix

Prepares the matrix for the modeling. Wavelength vs positions
@param LinePositions, mask
@type LinePositions: is a matrix of the same type than AbsoluteLinePositions or DiffLinePositions
@type mask: is the mask
@return: positionMatrix, completePositionMatric
@rtype positionMatrix: contains the unmasked positions
@rtype completePositionMatrix: contains all the positions

def hermes.pipeline.components.wlmodel.wlModel.__writeCheckFITS__	(		self,
			tbl,
			ionDesc,
			fn,
			omcs,
			nmask,
			outputPath,
			fileIndex
	)

Write intermediate results in a FITS table

Member Data Documentation

hermes.pipeline.components.wlmodel.wlModel.isDebug

isDebug is False by default.

When set to True, intermediate files are written in the debug folder. This is meant to let the user find out why his results are not the expected ones. Usually it reflects a change in the instrument that has to be fixed.

hermes.pipeline.components.wlmodel.wlModel.polyrowabs

row polynome degree absolute model, default is 8

to check

---

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

• pipeline/components/wlmodel.py