GRAVI Pipeline Reference Manual 1.9.2
Loading...
Searching...
No Matches
Functions | Variables
gravity_disp.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_preproc.h"
#include "gravi_p2vmred.h"
#include "gravi_signal.h"
#include "gravi_vis.h"
#include "gravi_metrology.h"
#include "gravi_disp.h"

Go to the source code of this file.

Functions

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

 
static int gravity_disp_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
 
static int gravity_disp_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
 
static int gravity_disp (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_disp_short [] = "Calibrate the linearity and the dispersion of the differential delay lines."
 
static char gravity_disp_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 111 of file gravity_disp.c.

References gravi_get_license(), gravity_disp_create(), gravity_disp_description, gravity_disp_destroy(), gravity_disp_exec(), and gravity_disp_short.

◆ gravity_disp()

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

The perpese of the recipe is to reduce the raw calibration file for dispersion calibration.

Parameters
framesetthe frames list
parlistthe parameters list
Returns
0 if everything is ok

Definition at line 317 of file gravity_disp.c.

References cpl_msg_info(), CPLCHECK_CLEAN, CPLCHECK_MSG, FREE, gravi_align_spectrum(), GRAVI_ARRAY_GEOMETRY_EXT, GRAVI_ASTROREDUCED, gravi_compute_dark(), gravi_compute_disp(), gravi_compute_opdc_state(), gravi_compute_outliers(), gravi_compute_p2vmred(), gravi_compute_rejection(), gravi_compute_signals(), gravi_compute_snr(), gravi_compute_vis(), gravi_compute_vis_qc(), GRAVI_DARK_MAP, gravi_data_append(), gravi_data_clean_for_astro(), gravi_data_copy_ext(), gravi_data_delete(), gravi_data_detector_cleanup(), gravi_data_load_frame(), gravi_data_load_rawframe(), gravi_data_move_ext(), gravi_data_save_new(), GRAVI_DET_ALL, gravi_dfs_set_groups(), gravi_disp_cleanup(), GRAVI_DISP_MODEL, GRAVI_DISP_VIS, gravi_extract_spectrum(), GRAVI_FDDL_EXT, gravi_frameset_extract_bad_map(), gravi_frameset_extract_dark_data(), gravi_frameset_extract_dark_map(), gravi_frameset_extract_disp_data(), gravi_frameset_extract_dispvis_data(), gravi_frameset_extract_flat_map(), gravi_frameset_extract_p2vm_map(), gravi_frameset_extract_static_param(), gravi_frameset_extract_wave_map(), gravi_frameset_extract_wavelamp_map(), GRAVI_METROLOGY_EXT, gravi_metrology_reduce(), gravi_msg_function_exit, gravi_msg_function_start, GRAVI_OPDC_EXT, GRAVI_OPTICAL_TRAIN_EXT, GRAVI_P2VMRED_SINGLE_CALIB, gravi_param_get_bool(), GRAVI_PREPROC, gravi_vis_mjd_to_time(), GRAVI_VIS_SINGLE_CALIB, and gravity_print_banner().

Referenced by gravity_disp_exec().

◆ gravity_disp_create()

static int gravity_disp_create ( cpl_plugin *  plugin)
static

◆ gravity_disp_destroy()

static int gravity_disp_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 284 of file gravity_disp.c.

Referenced by cpl_plugin_get_info().

◆ gravity_disp_exec()

static int gravity_disp_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 219 of file gravity_disp.c.

References gravity_disp().

Referenced by cpl_plugin_get_info().

Variable Documentation

◆ gravity_disp_description

char gravity_disp_description[]
static
Initial value:
=
"This recipe is associated to the template GRAVI_all_disp. It measures the phases obtained on the internal source at the position of the Argon lines and various positions (= fiber stretch) of the Fibered Differential Delay Lines (FDDL). It deduces the linearity model and the dispersion model of the differential delay lines. These models are stored as polynomials versus wavelength.\n"
"* Reduce all the input DISP files (see gravity_vis), write each product\n"
"* Compute the dispersion parameters from this entire dataset\n"
"* Write 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_DARK_MAP" : dark calibration (PRO.CATG="GRAVI_DARK_MAP")\n"
GRAVI_WAVELAMP_MAP" : spectrum of Argon, with position of lines\n"
GRAVI_DISP_RAW" (>50) : raw dispersion\n"
GRAVI_DISP_VIS" : intermediate product\n"
GRAVI_DISP_MODEL" : dispersion model of FDDL\n"
""
#define GRAVI_RECIPE_OUTPUT
Definition: gravi_dfs.h:39
#define GRAVI_P2VM_MAP
Definition: gravi_dfs.h:76
#define GRAVI_RECIPE_FLOW
Definition: gravi_dfs.h:37
#define GRAVI_DISP_RAW
Definition: gravi_dfs.h:45
#define GRAVI_BAD_MAP
Definition: gravi_dfs.h:73
#define GRAVI_WAVE_MAP
Definition: gravi_dfs.h:75
#define GRAVI_DISP_MODEL
Definition: gravi_dfs.h:79
#define GRAVI_FLAT_MAP
Definition: gravi_dfs.h:74
#define GRAVI_WAVELAMP_MAP
Definition: gravi_dfs.h:85
#define GRAVI_DARK_MAP
Definition: gravi_dfs.h:77
#define GRAVI_RECIPE_INPUT
Definition: gravi_dfs.h:38
#define GRAVI_DISP_VIS
Definition: gravi_dfs.h:59

Definition at line 77 of file gravity_disp.c.

Referenced by cpl_plugin_get_info().

◆ gravity_disp_short

char gravity_disp_short[] = "Calibrate the linearity and the dispersion of the differential delay lines."
static

Definition at line 76 of file gravity_disp.c.

Referenced by cpl_plugin_get_info().