IIINSTRUMENT Pipeline Reference Manual  4.4.10
Functions
NACO recipe parameters

Functions

cpl_error_code naco_parameter_set (cpl_parameterlist *self, const char *recipe, naco_parameter bitmask)
 Define the specified parameters. More...
 
cpl_boolean naco_parameterlist_get_bool (const cpl_parameterlist *self, const char *recipe, naco_parameter bitmask)
 Retrieve the value of a NACO boolean parameter. More...
 
int naco_parameterlist_get_int (const cpl_parameterlist *self, const char *recipe, naco_parameter bitmask)
 Retrieve the value of a NACO integer parameter. More...
 
double naco_parameterlist_get_double (const cpl_parameterlist *self, const char *recipe, naco_parameter bitmask)
 Retrieve the value of a NACO parameter of type double. More...
 
const char * naco_parameterlist_get_string (const cpl_parameterlist *self, const char *recipe, naco_parameter bitmask)
 Retrieve the value of a NACO string parameter. More...
 

Detailed Description

TBD

Function Documentation

◆ naco_parameter_set()

cpl_error_code naco_parameter_set ( cpl_parameterlist *  self,
const char *  recipe,
naco_parameter  bitmask 
)

Define the specified parameters.

Parameters
selfThe parameterlist to set
recipeThe recipe name
bitmaskparameter specification
Returns
CPL_ERROR_NONE or the relevant CPL error code on error

Definition at line 184 of file naco_parameter.c.

◆ naco_parameterlist_get_bool()

cpl_boolean naco_parameterlist_get_bool ( const cpl_parameterlist *  self,
const char *  recipe,
naco_parameter  bitmask 
)

Retrieve the value of a NACO boolean parameter.

Parameters
selfThe parameterlist to get from
recipeThe recipe name
bitmaskparameter specification
Returns
The boolean value, or CPL_FALSE on error
Note
If called with a pre-existing error, the function will do nothing.

Definition at line 419 of file naco_parameter.c.

◆ naco_parameterlist_get_double()

double naco_parameterlist_get_double ( const cpl_parameterlist *  self,
const char *  recipe,
naco_parameter  bitmask 
)

Retrieve the value of a NACO parameter of type double.

Parameters
selfThe parameterlist to get from
recipeThe recipe name
bitmaskparameter specification
Returns
The value, or undefined on error
Note
If called with a pre-existing error, the function will do nothing.

Definition at line 538 of file naco_parameter.c.

Referenced by naco_strehl_compute().

◆ naco_parameterlist_get_int()

int naco_parameterlist_get_int ( const cpl_parameterlist *  self,
const char *  recipe,
naco_parameter  bitmask 
)

Retrieve the value of a NACO integer parameter.

Parameters
selfThe parameterlist to get from
recipeThe recipe name
bitmaskparameter specification
Returns
The integer value, or zero on error
Note
If called with a pre-existing error, the function will do nothing.

Definition at line 474 of file naco_parameter.c.

◆ naco_parameterlist_get_string()

const char* naco_parameterlist_get_string ( const cpl_parameterlist *  self,
const char *  recipe,
naco_parameter  bitmask 
)

Retrieve the value of a NACO string parameter.

Parameters
selfThe parameterlist to get from
recipeThe recipe name
bitmaskparameter specification
Returns
The string, or NULL on error

Definition at line 604 of file naco_parameter.c.