GRAVI Pipeline Reference Manual 1.9.4
Loading...
Searching...
No Matches
Functions | Variables
gravity_p2vm.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_metrology.h"
#include "gravi_calib.h"
#include "gravi_preproc.h"
#include "gravi_wave.h"
#include "gravi_p2vm.h"
#include "gravi_p2vmred.h"

Go to the source code of this file.

Functions

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

 
static int gravity_p2vm_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
 
static int gravity_p2vm_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
 
static int gravity_p2vm (cpl_frameset *frameset, const cpl_parameterlist *parlist)
 Compute the DARK, BAD, FLAT, WAVE, P2VM from a list of calibration set.
 
int cpl_plugin_get_info (cpl_pluginlist *list)
 Build the list of available plugins, for this module.
 

Variables

static char gravity_p2vm_short [] = "Calibrate the instrument bad pixels, wavelength table, interferometric contrast and phase."
 
static char gravity_p2vm_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 113 of file gravity_p2vm.c.

References gravi_get_license(), gravity_p2vm_create(), gravity_p2vm_description, gravity_p2vm_destroy(), gravity_p2vm_exec(), and gravity_p2vm_short.

◆ gravity_p2vm()

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

Compute the DARK, BAD, FLAT, WAVE, P2VM from a list of calibration set.

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

Definition at line 334 of file gravity_p2vm.c.

References cpl_msg_info(), CPLCHECK_CLEAN, ERROR_CLEAN, FREE, FREELOOP, gravi_align_spectrum(), GRAVI_ARRAY_GEOMETRY_EXT, GRAVI_BAD_MAP, gravi_compute_badpix(), gravi_compute_dark(), gravi_compute_gain(), gravi_compute_p2vm(), gravi_compute_p2vmred(), gravi_compute_profile(), gravi_compute_wave(), gravi_create_p2vm(), GRAVI_DARK_MAP, gravi_data_add_table(), gravi_data_check_shutter, gravi_data_copy_ext(), gravi_data_delete(), gravi_data_detector_cleanup(), gravi_data_get_header, gravi_data_get_shutter, gravi_data_get_table(), gravi_data_load_frame(), gravi_data_load_rawframe(), gravi_data_load_rawframe_ext(), gravi_data_move_ext(), gravi_data_new(), gravi_data_save_new(), GRAVI_DET_FT, GRAVI_DET_SC, gravi_dfs_set_groups(), gravi_extract_spectrum(), GRAVI_FLAT_MAP, gravi_frameset_extract_bad_map(), gravi_frameset_extract_dark_data(), gravi_frameset_extract_dark_map(), gravi_frameset_extract_flat_data(), gravi_frameset_extract_flat_map(), gravi_frameset_extract_p2vm_data(), gravi_frameset_extract_wave_data(), gravi_frameset_extract_wave_map(), gravi_frameset_extract_wave_param(), gravi_frameset_extract_wavesc_data(), GRAVI_FT, GRAVI_IMAGING_DATA_FT_EXT, GRAVI_IMAGING_DATA_SC_EXT, GRAVI_IMAGING_DETECTOR_FT_EXT, GRAVI_IMAGING_DETECTOR_SC_EXT, gravi_metrology_compute_p2vm(), GRAVI_METROLOGY_EXT, gravi_msg_function_exit, gravi_msg_function_start, GRAVI_OI_FLUX_EXT, GRAVI_OI_VIS_EXT, GRAVI_OI_WAVELENGTH_EXT, GRAVI_OPTICAL_TRAIN_EXT, GRAVI_P2VM_MAP, GRAVI_P2VM_MET_EXT, gravi_p2vm_normalisation(), gravi_p2vm_phase_correction(), gravi_p2vm_transmission(), gravi_param_get_bool(), gravi_param_get_string(), gravi_pfits_get_met_wavelength_mean(), GRAVI_PREPROC, GRAVI_SC, GRAVI_SPECTRUM_DATA_FT_EXT, gravi_wave_compute_opds(), GRAVI_WAVE_MAP, gravi_wave_qc(), and gravity_print_banner().

Referenced by gravity_p2vm_exec().

◆ gravity_p2vm_create()

static int gravity_p2vm_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 154 of file gravity_p2vm.c.

References gravi_parameter_add_badpix(), gravi_parameter_add_biasmethod(), gravi_parameter_add_debug_file(), gravi_parameter_add_extract(), gravi_parameter_add_metrology(), gravi_parameter_add_preproc_file(), gravi_parameter_add_profile(), gravi_parameter_add_static_name(), and gravi_parameter_add_wave().

Referenced by cpl_plugin_get_info().

◆ gravity_p2vm_destroy()

static int gravity_p2vm_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 302 of file gravity_p2vm.c.

Referenced by cpl_plugin_get_info().

◆ gravity_p2vm_exec()

static int gravity_p2vm_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 240 of file gravity_p2vm.c.

References gravity_p2vm().

Referenced by cpl_plugin_get_info().

Variable Documentation

◆ gravity_p2vm_description

char gravity_p2vm_description[]
static
Initial value:
=
"This recipe reduces the internal calibrations. As a special sequence of shutter opening is required, it is advised to always build the SOF with a complete sequence of files obtained within a single execution of the p2vm calibration template. However it is still possible to input a SOF with DARK_RAW only, or DARK_RAW and FLAT_RAW only. It is also possible to input a SOF with some already processed calibration (e.g WAVE).\n"
"* Compute the dark, write product\n"
"* Compute the flat, write product\n"
"* Compute the badpixels, write product\n"
"* Compute the spectral calibration, write product\n"
"* Compute the p2vm, write product\n"
GRAVI_DARK_RAW" : raw dark, all shutters closed (DPR.TYPE=DARK)\n"
GRAVI_FLAT_RAW" x4 : raw flats, one shutter open (DPR.TYPE=FLAT)\n"
GRAVI_P2VM_RAW" x6 : raw p2vms, two shutters open (DPR.TYPE=P2VM)\n"
GRAVI_WAVE_RAW" : raw wavelength calibration for FT (DPR.TYPE=WAVE)\n"
GRAVI_WAVESC_RAW" : raw wavelength calibration for SC (DPR.TYPE=WAVE,SC)\n"
GRAVI_DARK_MAP" : dark calibration\n"
GRAVI_FLAT_MAP" : flat calibration\n"
GRAVI_BAD_MAP" : badpixel calibration\n"
GRAVI_WAVE_MAP" : wave calibration\n"
GRAVI_P2VM_MAP" : p2vm calibration\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_RAW
Definition: gravi_dfs.h:47
#define GRAVI_WAVE_MAP
Definition: gravi_dfs.h:75
#define GRAVI_FLAT_MAP
Definition: gravi_dfs.h:74
#define GRAVI_DARK_MAP
Definition: gravi_dfs.h:77
#define GRAVI_RECIPE_INPUT
Definition: gravi_dfs.h:38
#define GRAVI_P2VM_RAW
Definition: gravi_dfs.h:44
#define GRAVI_FLAT_RAW
Definition: gravi_dfs.h:50
#define GRAVI_WAVESC_RAW
Definition: gravi_dfs.h:48

Definition at line 76 of file gravity_p2vm.c.

Referenced by cpl_plugin_get_info().

◆ gravity_p2vm_short

char gravity_p2vm_short[] = "Calibrate the instrument bad pixels, wavelength table, interferometric contrast and phase."
static

Definition at line 75 of file gravity_p2vm.c.

Referenced by cpl_plugin_get_info().