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

Macros

#define N_EPOCH   3
 

Functions

static int gravity_pcacal_create (cpl_plugin *plugin)
 Setup the recipe options.
 
static int gravity_pcacal_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
 
static int gravity_pcacal_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
 
static int gravity_pcacal (cpl_frameset *frameset, const cpl_parameterlist *parlist)
 Compute the PCA model from the provided calibration data.
 
int cpl_plugin_get_info (cpl_pluginlist *list)
 Build the list of available plugins, for this module.
 
static cpl_boolean gravi_test_tracking_ratio (const cpl_propertylist *hdr, int min_ratio)
 Test whether tracking ratio for all baselines exceeds a limit.
 

Variables

static char gravity_pcacal_short [] = "Generate static calibration files for flattening phase visibility data using the PCA method."
 
static char gravity_pcacal_description []
 
static double TIME_MJD_EPOCH_START [N_EPOCH]
 
static cpl_size MIN_CALIB_FRAMES = 20
 

Macro Definition Documentation

◆ N_EPOCH

#define N_EPOCH   3

Definition at line 65 of file gravity_pcacal.c.

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 90 of file gravity_pcacal.c.

References gravi_get_license(), gravity_pcacal_create(), gravity_pcacal_description, gravity_pcacal_destroy(), gravity_pcacal_exec(), and gravity_pcacal_short.

◆ gravi_test_tracking_ratio()

static cpl_boolean gravi_test_tracking_ratio ( const cpl_propertylist *  hdr,
int  min_ratio 
)
static

Test whether tracking ratio for all baselines exceeds a limit.

Parameters
hdrHeader to extract ratios from.
min_ratioThe threshold tracking ratio for acceptance.
Returns
CPL_TRUE if accepted.

Definition at line 277 of file gravity_pcacal.c.

References GRAVI_BASE_NAME.

Referenced by gravity_pcacal().

◆ gravity_pcacal()

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

◆ gravity_pcacal_create()

static int gravity_pcacal_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 132 of file gravity_pcacal.c.

References gravi_parameter_add_pcacalib(), and gravi_parameter_add_static_name().

Referenced by cpl_plugin_get_info().

◆ gravity_pcacal_destroy()

static int gravity_pcacal_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 244 of file gravity_pcacal.c.

Referenced by cpl_plugin_get_info().

◆ gravity_pcacal_exec()

static int gravity_pcacal_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 182 of file gravity_pcacal.c.

References gravity_pcacal().

Referenced by cpl_plugin_get_info().

Variable Documentation

◆ gravity_pcacal_description

char gravity_pcacal_description[]
static
Initial value:
=
"This recipe produces a PCA calibration file from a set of calibration frames to be used for flattening phase visibility data.\n"
"* Select good input frames using tracking ratio criterion.\n"
"* Compute PCA decomposition for each baseline and polarisation channel\n"
"* Fit component model and write calibration product\n"
GRAVI_VIS_SINGLE_CALIB" ≥20 : input frames\n"
GRAVI_PHASE_PCA" : PCA calibration\n"
""
#define GRAVI_RECIPE_OUTPUT
Definition: gravi_dfs.h:39
#define GRAVI_RECIPE_FLOW
Definition: gravi_dfs.h:37
#define GRAVI_RECIPE_INPUT
Definition: gravi_dfs.h:38
#define GRAVI_VIS_SINGLE_CALIB
Definition: gravi_dfs.h:97
#define GRAVI_PHASE_PCA
Definition: gravi_dfs.h:87

Definition at line 52 of file gravity_pcacal.c.

Referenced by cpl_plugin_get_info().

◆ gravity_pcacal_short

char gravity_pcacal_short[] = "Generate static calibration files for flattening phase visibility data using the PCA method."
static

Definition at line 51 of file gravity_pcacal.c.

Referenced by cpl_plugin_get_info().

◆ MIN_CALIB_FRAMES

cpl_size MIN_CALIB_FRAMES = 20
static

Definition at line 73 of file gravity_pcacal.c.

Referenced by gravity_pcacal().

◆ TIME_MJD_EPOCH_START

double TIME_MJD_EPOCH_START[N_EPOCH]
static
Initial value:
= {
57754.000000,
58758.000000,
59178.000000,
}

Definition at line 66 of file gravity_pcacal.c.

Referenced by gravity_pcacal().