GRAVI Pipeline Reference Manual 1.9.4
Loading...
Searching...
No Matches
Functions | Variables
gravity_badpix.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"

Go to the source code of this file.

Functions

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

 
static int gravity_badpix_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
 
static int gravity_badpix_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
 
static int gravity_badpix (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_badpix_short [] = "Calibrate the badpixels from the detectors."
 
static char gravity_badpix_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 83 of file gravity_badpix.c.

References gravi_get_license(), gravity_badpix_create(), gravity_badpix_description, gravity_badpix_destroy(), gravity_badpix_exec(), and gravity_badpix_short.

◆ gravity_badpix()

static int gravity_badpix ( 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 269 of file gravity_badpix.c.

References cpl_msg_info(), CPLCHECK_CLEAN, CPLCHECK_INT, FREE, FREELOOP, GRAVI_BAD_MAP, gravi_compute_badpix(), gravi_compute_dark(), gravi_data_delete(), gravi_data_load_rawframe(), gravi_data_save_new(), gravi_dfs_set_groups(), gravi_frameset_extract_dark_data(), gravi_frameset_extract_flat_data(), gravi_msg_function_exit, gravi_msg_function_start, and gravity_print_banner().

Referenced by gravity_badpix_exec().

◆ gravity_badpix_create()

static int gravity_badpix_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 124 of file gravity_badpix.c.

References gravi_parameter_add_badpix(), and gravi_parameter_add_static_name().

Referenced by cpl_plugin_get_info().

◆ gravity_badpix_destroy()

static int gravity_badpix_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 237 of file gravity_badpix.c.

Referenced by cpl_plugin_get_info().

◆ gravity_badpix_exec()

static int gravity_badpix_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 175 of file gravity_badpix.c.

References gravity_badpix().

Referenced by cpl_plugin_get_info().

Variable Documentation

◆ gravity_badpix_description

char gravity_badpix_description[]
static
Initial value:
= "The recipe creates a BAD calibration map from raw DARKs and raw FLATs observations. Since it is not associated with the calibration of the instrumental transmission, more specific darks or flats can be used. Such as very long darks, fore better statistic; and/or defocused flats to illuminate more pixels. The create BAD map can then be used as an input for further calibration (P2VM) and observations.\n"
"* Load input files\n"
"* Compute badpixel from dark rms, dark median, and flat value\n"
"* Save the product)\n"
GRAVI_DARK_RAW" : raw dark, all shutters closed (DPR.TYPE=DARK)\n"
GRAVI_FLAT_RAW" x4 : raw flats, one sutter open (DPR.TYPE=FLAT)\n"
GRAVI_BAD_MAP" : badpixel calibration (PRO.CATG="GRAVI_BAD_MAP") \n"
#define GRAVI_RECIPE_OUTPUT
Definition: gravi_dfs.h:39
#define GRAVI_DARK_RAW
Definition: gravi_dfs.h:46
#define GRAVI_RECIPE_FLOW
Definition: gravi_dfs.h:37
#define GRAVI_BAD_MAP
Definition: gravi_dfs.h:73
#define GRAVI_RECIPE_INPUT
Definition: gravi_dfs.h:38
#define GRAVI_FLAT_RAW
Definition: gravi_dfs.h:50

Definition at line 56 of file gravity_badpix.c.

Referenced by cpl_plugin_get_info().

◆ gravity_badpix_short

char gravity_badpix_short[] = "Calibrate the badpixels from the detectors."
static

Definition at line 55 of file gravity_badpix.c.

Referenced by cpl_plugin_get_info().