IIINSTRUMENT Pipeline Reference Manual 4.5.1
Functions
VISIR recipe parameters

Functions

cpl_error_code visir_parameter_set (cpl_parameterlist *self, const char *recipe, visir_parameter bitmask)
 Define the specified parameters.
 
cpl_boolean visir_parameterlist_get_bool (const cpl_parameterlist *self, const char *recipe, visir_parameter bitmask)
 Retrieve the value of a VISIR boolean parameter.
 
int visir_parameterlist_get_int (const cpl_parameterlist *self, const char *recipe, visir_parameter bitmask)
 Retrieve the value of a VISIR integer parameter.
 
double visir_parameterlist_get_double (const cpl_parameterlist *self, const char *recipe, visir_parameter bitmask)
 Retrieve the value of a VISIR parameter of type double.
 
const char * visir_parameterlist_get_string (const cpl_parameterlist *self, const char *recipe, visir_parameter bitmask)
 Retrieve the value of a VISIR string parameter.
 

Detailed Description

TBD

Function Documentation

◆ visir_parameter_set()

cpl_error_code visir_parameter_set ( cpl_parameterlist *  self,
const char *  recipe,
visir_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 180 of file visir_parameter.c.

◆ visir_parameterlist_get_bool()

cpl_boolean visir_parameterlist_get_bool ( const cpl_parameterlist *  self,
const char *  recipe,
visir_parameter  bitmask 
)

Retrieve the value of a VISIR 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 562 of file visir_parameter.c.

Referenced by visir_img_recombine_list(), and visir_inputs_combine().

◆ visir_parameterlist_get_double()

double visir_parameterlist_get_double ( const cpl_parameterlist *  self,
const char *  recipe,
visir_parameter  bitmask 
)

Retrieve the value of a VISIR 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 678 of file visir_parameter.c.

Referenced by visir_img_collapse_beam(), and visir_inputs_combine().

◆ visir_parameterlist_get_int()

int visir_parameterlist_get_int ( const cpl_parameterlist *  self,
const char *  recipe,
visir_parameter  bitmask 
)

Retrieve the value of a VISIR 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 615 of file visir_parameter.c.

Referenced by visir_img_recombine_list(), and visir_inputs_combine().

◆ visir_parameterlist_get_string()

const char * visir_parameterlist_get_string ( const cpl_parameterlist *  self,
const char *  recipe,
visir_parameter  bitmask 
)

Retrieve the value of a VISIR string parameter.

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

Definition at line 758 of file visir_parameter.c.

Referenced by visir_img_recombine_list(), and visir_inputs_combine().