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

cpl_error_code visir_parameter_set ( cpl_parameterlist *  self,
const char *  recipe,
visir_parameter  bitmask 
)

Define the specified parameters.

Parameters:
self The parameterlist to set
recipe The recipe name
bitmask parameter specification
Returns:
CPL_ERROR_NONE or the relevant CPL error code on error

Definition at line 180 of file visir_parameter.c.

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:
self The parameterlist to get from
recipe The recipe name
bitmask parameter 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 493 of file visir_parameter.c.

Referenced by visir_img_recombine(), and visir_inputs_combine().

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

Retrieve the value of a VISIR integer parameter.

Parameters:
self The parameterlist to get from
recipe The recipe name
bitmask parameter 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 543 of file visir_parameter.c.

Referenced by visir_img_recombine(), visir_inputs_combine(), and visir_spc_phot_sensit().

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:
self The parameterlist to get from
recipe The recipe name
bitmask parameter specification
Returns:
The value, or undefined on error
Note:
If called with a pre-existing error, the function will do nothing.

Definition at line 597 of file visir_parameter.c.

Referenced by visir_img_collapse_beam(), and visir_inputs_combine().

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:
self The parameterlist to get from
recipe The recipe name
bitmask parameter specification
Returns:
The string, or NULL on error

Definition at line 668 of file visir_parameter.c.

Referenced by visir_img_recombine(), and visir_inputs_combine().


Generated on Mon Feb 6 15:23:49 2012 for VISIR Pipeline Reference Manual by  doxygen 1.5.8