MUSE Pipeline Reference Manual  2.1.1
Functions
Radial velocity corrections

Functions

muse_rvcorrect_type muse_rvcorrect_select_type (const char *aTypeString)
 Select type of radial velocity correction to be done from type string. More...
 
cpl_error_code muse_rvcorrect (muse_pixtable *aPixtable, muse_rvcorrect_type aType)
 Correct the wavelengths of all pixels of a given pixel table for radial velocity shift. More...
 

Detailed Description

Function Documentation

cpl_error_code muse_rvcorrect ( muse_pixtable aPixtable,
muse_rvcorrect_type  aType 
)

Correct the wavelengths of all pixels of a given pixel table for radial velocity shift.

Parameters
aPixtablethe input pixel table to correct for DAR
aTypetype of velocity correction to perform
Returns
CPL_ERROR_NONE on success another CPL error code on failure
Remarks
The resulting correction is directly applied to the input pixel table.
This function adds a FITS header (MUSE_HDR_PT_RVCORR) with the value of the computed correction to the pixel table; its comment contains the type of correction that was applied. Then users and other functions can determine, if and which correction was applied. If such a pixel table is passed to this function, it will then immediately return.
Exceptions
return CPL_ERROR_NULL_INPUTthe input pixel table and/or one of its components are NULL
output info message, skip the correction, return CPL_ERROR_NONEthe input pixel table was already corrected for non-zero radial velocity
return CPL_ERROR_ILLEGAL_INPUTan unknown aType was given

Definition at line 120 of file muse_rvcorrect.c.

References muse_astro_rvcorr::bary, muse_astro_rvcorr::geo, muse_pixtable::header, muse_astro_rvcorr::helio, muse_astro_rvcorr_compute(), MUSE_HDR_PT_RVCORR, muse_pixtable_get_nrow(), MUSE_PIXTABLE_LAMBDA, and muse_pixtable::table.

Referenced by muse_postproc_process_exposure().

muse_rvcorrect_type muse_rvcorrect_select_type ( const char *  aTypeString)

Select type of radial velocity correction to be done from type string.

Parameters
aTypeStringtype string of velocity correction to perform
Returns
the corresponding muse_rvcorrect_type or MUSE_RVCORRECT_UNKNOWN on error
Exceptions
set CPL_ERROR_NULL_INPUT, return MUSE_RVCORRECT_UNKNOWNaTypeString is NULL
set CPL_ERROR_ILLEGAL_INPUT, return MUSE_RVCORRECT_UNKNOWNan unknown aType was given

Definition at line 73 of file muse_rvcorrect.c.