|
CR2RE Pipeline Reference Manual 1.6.7
|
This module provides algorithms to compute a master flatfield. Several methods are available to deal with different flatfield characteristics. More...
Functions | |
| hdrl_parameter * | hdrl_flat_parameter_create (cpl_size filter_size_x, cpl_size filter_size_y, hdrl_flat_method method) |
| Creates FLAT Parameters object. | |
| cpl_boolean | hdrl_flat_parameter_check (const hdrl_parameter *self) |
| Check that the parameter is a FLAT parameter. | |
| cpl_size | hdrl_flat_parameter_get_filter_size_x (const hdrl_parameter *p) |
| Access the filter_size_x in the FLAT parameter. | |
| cpl_size | hdrl_flat_parameter_get_filter_size_y (const hdrl_parameter *p) |
| Access the filter_size_y in the FLAT parameter. | |
| hdrl_flat_method | hdrl_flat_parameter_get_method (const hdrl_parameter *p) |
| Access the method in the FLAT parameter. | |
| cpl_parameterlist * | hdrl_flat_parameter_create_parlist (const char *base_context, const char *prefix, const hdrl_parameter *defaults) |
| Create a parameter list for the FLAT computation. | |
| hdrl_parameter * | hdrl_flat_parameter_parse_parlist (const cpl_parameterlist *parlist, const char *prefix) |
| Parse a parameterlist to create input parameters for the FLAT. | |
| cpl_error_code | hdrl_flat_compute (hdrl_imagelist *hdrl_data, const cpl_mask *stat_mask, const hdrl_parameter *collapse_params, hdrl_parameter *flat_params, hdrl_image **master, cpl_image **contrib_map) |
| compute high or low frequency master flat with median filtering | |
This module provides algorithms to compute a master flatfield. Several methods are available to deal with different flatfield characteristics.
The routines in this module can be used to derive a high frequency or a low frequency master flatfield.
The calculation is performed by calling the top-level function hdrl_flat_compute() and the parameters passed to this function can be created by calling hdrl_flat_parameter_create(). Additional one has to pass also the collapse parameter created e.g. via hdrl_collapse_mean_parameter_create(), ... Note that the function will overwrite the input imagelist in order to conserve memory. Its contents after the call are undefined and it must be deleted by the caller.
| cpl_error_code hdrl_flat_compute | ( | hdrl_imagelist * | hdrl_data, |
| const cpl_mask * | stat_mask, | ||
| const hdrl_parameter * | collapse_params, | ||
| hdrl_parameter * | flat_params, | ||
| hdrl_image ** | master, | ||
| cpl_image ** | contrib_map | ||
| ) |
compute high or low frequency master flat with median filtering
| hdrl_data | input flats, will be overwritten! |
| stat_mask | input mask to select the regions for statistics or smoothing |
| collapse_params | parameter controlling the collapse algorithm |
| flat_params | parameter controlling the flatfield algorithm |
| master | returned masterflat |
| contrib_map | returned contribution map |
Definition at line 405 of file hdrl_flat.c.
References hdrl_image_create(), hdrl_image_delete(), hdrl_image_get_error(), hdrl_image_get_image(), hdrl_image_get_image_const(), hdrl_imagelist_collapse(), hdrl_imagelist_get(), and hdrl_imagelist_get_size().
| cpl_boolean hdrl_flat_parameter_check | ( | const hdrl_parameter * | self | ) |
Check that the parameter is a FLAT parameter.
| self | The parameter to check |
Definition at line 197 of file hdrl_flat.c.
| hdrl_parameter * hdrl_flat_parameter_create | ( | cpl_size | filter_size_x, |
| cpl_size | filter_size_y, | ||
| hdrl_flat_method | method | ||
| ) |
Creates FLAT Parameters object.
PRIVATE
| filter_size_x | Smoothing filter size in x-direction |
| filter_size_y | Smoothing filter size in y-direction |
| method | used method |
It needs to be deallocated with hdrl_parameter_delete()
Definition at line 173 of file hdrl_flat.c.
References hdrl_parameter_delete().
Referenced by hdrl_flat_parameter_parse_parlist().
| cpl_parameterlist * hdrl_flat_parameter_create_parlist | ( | const char * | base_context, |
| const char * | prefix, | ||
| const hdrl_parameter * | defaults | ||
| ) |
Create a parameter list for the FLAT computation.
| base_context | base context of parameter (e.g. recipe name) |
| prefix | prefix of parameter, may be empty string |
| defaults | default values |
Creates a parameterlist with the FLAT parameters:
Definition at line 258 of file hdrl_flat.c.
References hdrl_flat_parameter_get_filter_size_x(), hdrl_flat_parameter_get_filter_size_y(), hdrl_flat_parameter_get_method(), and hdrl_join_string().
| cpl_size hdrl_flat_parameter_get_filter_size_x | ( | const hdrl_parameter * | p | ) |
Access the filter_size_x in the FLAT parameter.
| p | The FLAT parameter |
Definition at line 209 of file hdrl_flat.c.
Referenced by hdrl_flat_parameter_create_parlist().
| cpl_size hdrl_flat_parameter_get_filter_size_y | ( | const hdrl_parameter * | p | ) |
Access the filter_size_y in the FLAT parameter.
| p | The FLAT parameter |
Definition at line 223 of file hdrl_flat.c.
Referenced by hdrl_flat_parameter_create_parlist().
| hdrl_flat_method hdrl_flat_parameter_get_method | ( | const hdrl_parameter * | p | ) |
Access the method in the FLAT parameter.
| p | The FLAT parameter |
Definition at line 237 of file hdrl_flat.c.
Referenced by hdrl_flat_parameter_create_parlist().
| hdrl_parameter * hdrl_flat_parameter_parse_parlist | ( | const cpl_parameterlist * | parlist, |
| const char * | prefix | ||
| ) |
Parse a parameterlist to create input parameters for the FLAT.
| parlist | parameter list to parse |
| prefix | prefix of parameter name |
Reads a parameterlist in order to create FLAT image parameters. Expects a parameterlist containing:
Definition at line 331 of file hdrl_flat.c.
References hdrl_flat_parameter_create(), and hdrl_join_string().