GRAVI Pipeline Reference Manual 1.9.2
Loading...
Searching...
No Matches
Functions | Variables
gravity_astrometry.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_vis.h"
#include "gravi_utils.h"
#include "gravi_astrometry.h"

Go to the source code of this file.

Functions

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

 
static int gravity_astrometry_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
 
static int gravity_astrometry_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
 
static int gravity_astrometry (cpl_frameset *frameset, cpl_parameterlist *parlist)
 TODO.
 
int cpl_plugin_get_info (cpl_pluginlist *list)
 Build the list of available plugins, for this module.
 
static astro_data ** load_data (cpl_frameset *frameset, cpl_frameset *used_frameset, gravi_data **out_data)
 Load input astrometric quantities from ASTROREDUCED file(s).
 

Variables

static char gravity_astro_short [] = "Compute astrometric phase reference"
 
static char gravity_astro_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_astrometry.c.

References gravi_get_license(), gravity_astro_description, gravity_astro_short, gravity_astrometry_create(), gravity_astrometry_destroy(), and gravity_astrometry_exec().

◆ gravity_astrometry()

static int gravity_astrometry ( cpl_frameset *  frameset,
cpl_parameterlist *  parlist 
)
static

◆ gravity_astrometry_create()

static int gravity_astrometry_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_astrometry.c.

References gravi_parameter_add_astrometry(), and gravi_parameter_add_static_name().

Referenced by cpl_plugin_get_info().

◆ gravity_astrometry_destroy()

static int gravity_astrometry_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 238 of file gravity_astrometry.c.

Referenced by cpl_plugin_get_info().

◆ gravity_astrometry_exec()

static int gravity_astrometry_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_astrometry.c.

References gravity_astrometry().

Referenced by cpl_plugin_get_info().

◆ load_data()

static astro_data ** load_data ( cpl_frameset *  frameset,
cpl_frameset *  used_frameset,
gravi_data **  out_data 
)
static

Load input astrometric quantities from ASTROREDUCED file(s).

Parameters
framesetFrameset to load from.
used_framesetFrameset to store used frames in.
out_dataOutput array to receive loaded gravi_data objects. Must be allocated, or NULL to skip.
Returns
Array of astro_data objects. Will be allocated by this function.

Definition at line 270 of file gravity_astrometry.c.

References CPLCHECK_CLEAN, FREE, FREELOOP, gravi_astrometry_delete(), gravi_astrometry_load(), gravi_data_delete(), and gravi_data_load_frame().

Referenced by gravity_astrometry().

Variable Documentation

◆ gravity_astro_description

char gravity_astro_description[]
static
Initial value:
=
"This recipe computes phase and amplitude referencing for dual-field astrometric observations.\n"
"It supports on-axis, off-axis and off-axis swap observing strategies.\n"
"* If swaps are present: obtain astrometric solution and compute swap phase reference\n"
"* Compute phase reference for the target.\n"
"* Write output product with correctly referenced phase.\n"
GRAVI_ASTRO_CAL_PHASEREF" : star frames to use for phase referencing\n"
GRAVI_ASTRO_TARGET":\tplanet frames to be referenced\n"
GRAVI_ASTRO_SWAP":\talternating star/planet frames for swap observing mode\n"
GRAVI_ASTRO_PHASE_CALIBRATED" : output astroreduced file with correctly referenced phase\n"
""
#define GRAVI_RECIPE_OUTPUT
Definition: gravi_dfs.h:39
#define GRAVI_ASTRO_TARGET
Definition: gravi_dfs.h:122
#define GRAVI_RECIPE_FLOW
Definition: gravi_dfs.h:37
#define GRAVI_ASTRO_PHASE_CALIBRATED
Definition: gravi_dfs.h:125
#define GRAVI_RECIPE_INPUT
Definition: gravi_dfs.h:38
#define GRAVI_ASTRO_SWAP
Definition: gravi_dfs.h:123
#define GRAVI_ASTRO_CAL_PHASEREF
Definition: gravi_dfs.h:124

Definition at line 54 of file gravity_astrometry.c.

Referenced by cpl_plugin_get_info().

◆ gravity_astro_short

char gravity_astro_short[] = "Compute astrometric phase reference"
static

Definition at line 53 of file gravity_astrometry.c.

Referenced by cpl_plugin_get_info().