The Solar-Stellar Spectrograph

[ Home | About | Tech Info & Data | Publications | References ]      [ Site by Jeffrey Hall | Research funded by NSF ]

WaveCal

The WaveCal class creates or adds a wavelength calibration solution to a spectrum.

Version History

2008 July 28 - Documentation started.

Data Members

pointer calibration

Method List

cleanup

define

get_calibration( )

init( )

load_calibration

Method Descriptions

PRO cleanup

Calls ReduceTool::cleanup

Destructor. Calls ReduceTool::cleanup and then frees its own data member pointer. Never call this procedure directly; it is invoked by IDL's Obj_Destroy function.

PRO define

Structure definition. Specifies the contents of the IDL structure instantiated by the Normalizer class. Used by Obj_New; do not invoke directly.

FUNCTION get_calibration

Return pointer normSpec

Returns the object's calibration data member.

FUNCTION init

keyword bool verbose

Return bool TRUE, FALSE

Constructor. If the keyword verbose is set, the verbose data member (inherited from Tool) is set to TRUE. Never call this function directly; it is invoked by IDL's Obj_New function.

PRO load_calibration

argument string f

argument int ordLen

argument int numOrds

Loads the contents of the file f into the object's data member. This should be an array of floats with the wavelength information for each pixel in the spectrum.

[Back to contents]