NACO recipe parameters


Functions

cpl_error_code naco_parameter_set (cpl_parameterlist *self, const char *recipe, naco_parameter bitmask)
 Define the specified parameters.
cpl_boolean naco_parameterlist_get_bool (const cpl_parameterlist *self, const char *recipe, naco_parameter bitmask)
 Retrieve the value of a NACO boolean parameter.
int naco_parameterlist_get_int (const cpl_parameterlist *self, const char *recipe, naco_parameter bitmask)
 Retrieve the value of a NACO integer parameter.
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.
const char * naco_parameterlist_get_string (const cpl_parameterlist *self, const char *recipe, naco_parameter bitmask)
 Retrieve the value of a NACO string parameter.

Detailed Description

TBD

Function Documentation

cpl_error_code naco_parameter_set ( cpl_parameterlist *  self,
const char *  recipe,
naco_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 184 of file naco_parameter.c.

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:
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 419 of file naco_parameter.c.

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

Retrieve the value of a NACO 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 474 of file naco_parameter.c.

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:
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 538 of file naco_parameter.c.

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

Definition at line 604 of file naco_parameter.c.


Generated on Tue Mar 12 15:19:53 2013 for NACO Pipeline Reference Manual by  doxygen 1.4.7