GRAVI Pipeline Reference Manual 1.7.2
Loading...
Searching...
No Matches
Functions | Variables
gravity_biasmask.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_biasmask_create (cpl_plugin *plugin)
 Setup the recipe options

 
static int gravity_biasmask_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
 
static int gravity_biasmask_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
 
static int gravity_biasmask (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_biasmask_short [] = GRAVI_UNOFFERED"Determine which pixels can be used to measure the bias of SC detector."
 
static char gravity_biasmask_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 84 of file gravity_biasmask.c.

References gravi_get_license(), gravity_biasmask_create(), gravity_biasmask_description, gravity_biasmask_destroy(), gravity_biasmask_exec(), and gravity_biasmask_short.

◆ gravity_biasmask()

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

◆ gravity_biasmask_create()

static int gravity_biasmask_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 125 of file gravity_biasmask.c.

References gravi_parameter_add_static_name().

Referenced by cpl_plugin_get_info().

◆ gravity_biasmask_destroy()

static int gravity_biasmask_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 235 of file gravity_biasmask.c.

Referenced by cpl_plugin_get_info().

◆ gravity_biasmask_exec()

static int gravity_biasmask_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 173 of file gravity_biasmask.c.

References gravity_biasmask().

Referenced by cpl_plugin_get_info().

Variable Documentation

◆ gravity_biasmask_description

char gravity_biasmask_description[]
static
Initial value:
= GRAVI_UNOFFERED"The recipe creates a binary mask (BIASPIX) indentifying which pixels of the SC detector are not illuminated, and thus could be used as bias-pixels in further processing. The idea would be to input such a mask, as static calibration, in all reductions. However this is not yet implemented, nor demonstrated as necessary.\n"
"* Load the input files\n"
"* Identify the mask\n"
"* Write 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_BIASMASK_MAP" : biaspixel mask calibration \n"
"\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_BIASMASK_MAP
Definition: gravi_dfs.h:84
#define GRAVI_UNOFFERED
Definition: gravi_dfs.h:36
#define GRAVI_RECIPE_INPUT
Definition: gravi_dfs.h:38
#define GRAVI_FLAT_RAW
Definition: gravi_dfs.h:50

Definition at line 57 of file gravity_biasmask.c.

Referenced by cpl_plugin_get_info().

◆ gravity_biasmask_short

char gravity_biasmask_short[] = GRAVI_UNOFFERED"Determine which pixels can be used to measure the bias of SC detector."
static

Definition at line 56 of file gravity_biasmask.c.

Referenced by cpl_plugin_get_info().