GRAVI Pipeline Reference Manual 1.9.4
Loading...
Searching...
No Matches
Functions | Variables
gravity_wavelamp.c File Reference
#include <cpl.h>
#include <stdio.h>
#include <string.h>
#include <time.h>
#include "gravi_data.h"
#include "gravi_pfits.h"
#include "gravi_dfs.h"
#include "gravi_utils.h"
#include "gravi_calib.h"
#include "gravi_wave.h"
#include "gravi_preproc.h"
#include "gravi_disp.h"

Go to the source code of this file.

Functions

static int gravity_wavelamp_create (cpl_plugin *plugin)
 Setup the recipe options

 
static int gravity_wavelamp_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
 
static int gravity_wavelamp_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
 
static int gravity_wavelamp (cpl_frameset *frameset, const cpl_parameterlist *parlist)
 The perpese of the recipe is to reduce the raw calibration file for dispersion calibration.
 
int cpl_plugin_get_info (cpl_pluginlist *list)
 Build the list of available plugins, for this module.
 

Variables

static char gravity_wavelamp_short [] = "Measure the position of the Argon lines in the spectra."
 
static char gravity_wavelamp_description []
 

Function Documentation

◆ cpl_plugin_get_info()

int cpl_plugin_get_info ( cpl_pluginlist *  list)

Build the list of available plugins, for this module.

Parameters
listthe plugin list
Returns
0 if everything is ok, 1 otherwise
Note
Only this function is exported

Create the recipe instance and make it available to the application using the interface.

Definition at line 103 of file gravity_wavelamp.c.

References gravi_get_license(), gravity_wavelamp_create(), gravity_wavelamp_description, gravity_wavelamp_destroy(), gravity_wavelamp_exec(), and gravity_wavelamp_short.

◆ gravity_wavelamp()

static int gravity_wavelamp ( cpl_frameset *  frameset,
const cpl_parameterlist *  parlist 
)
static

◆ gravity_wavelamp_create()

static int gravity_wavelamp_create ( cpl_plugin *  plugin)
static

Setup the recipe options

Parameters
pluginthe plugin
Returns
0 if everything is ok

Defining the command-line/configuration parameters for the recipe.

Definition at line 144 of file gravity_wavelamp.c.

References gravi_parameter_add_static_name().

Referenced by cpl_plugin_get_info().

◆ gravity_wavelamp_destroy()

static int gravity_wavelamp_destroy ( cpl_plugin *  plugin)
static

Destroy what has been created by the 'create' function.

Parameters
pluginthe plugin
Returns
0 if everything is ok

Definition at line 254 of file gravity_wavelamp.c.

Referenced by cpl_plugin_get_info().

◆ gravity_wavelamp_exec()

static int gravity_wavelamp_exec ( cpl_plugin *  plugin)
static

Execute the plugin instance given by the interface.

Parameters
pluginthe plugin
Returns
0 if everything is ok

Definition at line 189 of file gravity_wavelamp.c.

References gravity_wavelamp().

Referenced by cpl_plugin_get_info().

Variable Documentation

◆ gravity_wavelamp_description

char gravity_wavelamp_description[]
static
Initial value:
=
"This recipe is associated to the template gravity_wavelamp.\n"
"It reduces the raw file obtained with the Argon lamp (WAVELAMP) and process it so that it can be used to calibrate the fiber dispersion (recipe gravity_disp).\n"
"* Extract the spectra of the Argon exposure\n"
"* Interpolate the spectra into a common wavelength table\n"
"* Measure the wavelength position of known Argon lines\n"
"* Write the product\n"
GRAVI_FLAT_MAP" : flat calibration (PRO.CATG="GRAVI_FLAT_MAP")\n"
GRAVI_BAD_MAP" : badpixel calibration (PRO.CATG="GRAVI_BAD_MAP") \n"
GRAVI_WAVE_MAP" : wave calibration (PRO.CATG="GRAVI_WAVE_MAP")\n"
GRAVI_P2VM_MAP" : p2vm calibration (PRO.CATG="GRAVI_P2VM_MAP")\n"
GRAVI_WAVELAMP_RAW" : long exposure of Argon lamp\n"
GRAVI_DARK_RAW" : dark of Argon exposure\n"
GRAVI_WAVELAMP_MAP" : spectrum of Argon, with position of lines\n"
""
#define GRAVI_RECIPE_OUTPUT
Definition: gravi_dfs.h:39
#define GRAVI_DARK_RAW
Definition: gravi_dfs.h:46
#define GRAVI_P2VM_MAP
Definition: gravi_dfs.h:76
#define GRAVI_RECIPE_FLOW
Definition: gravi_dfs.h:37
#define GRAVI_BAD_MAP
Definition: gravi_dfs.h:73
#define GRAVI_WAVE_MAP
Definition: gravi_dfs.h:75
#define GRAVI_FLAT_MAP
Definition: gravi_dfs.h:74
#define GRAVI_WAVELAMP_MAP
Definition: gravi_dfs.h:85
#define GRAVI_RECIPE_INPUT
Definition: gravi_dfs.h:38
#define GRAVI_WAVELAMP_RAW
Definition: gravi_dfs.h:49

Definition at line 69 of file gravity_wavelamp.c.

Referenced by cpl_plugin_get_info().

◆ gravity_wavelamp_short

char gravity_wavelamp_short[] = "Measure the position of the Argon lines in the spectra."
static

Definition at line 68 of file gravity_wavelamp.c.

Referenced by cpl_plugin_get_info().