Scattered Light Correction
Typedefs | |
typedef GiSLightSetup | GiSLightSetup |
Functions | |
cxint | giraffe_adjust_scattered_light (GiImage *result, const GiImage *image, const GiLocalization *localization, const GiImage *bpixel, GiImage *phff, const GiSLightConfig *config) |
Compute a scattered light model for a given image. | |
GiSLightConfig * | giraffe_slight_config_create (cpl_parameterlist *list) |
Creates a setup structure for the scattered light computation. | |
void | giraffe_slight_config_destroy (GiSLightConfig *config) |
Destroys a scattered light setup structure. | |
void | giraffe_slight_config_add (cpl_parameterlist *list) |
Adds parameters for the scattered light computation. |
Detailed Description
TBDFunction Documentation
cxint giraffe_adjust_scattered_light | ( | GiImage * | result, | |
const GiImage * | image, | |||
const GiLocalization * | localization, | |||
const GiImage * | bpixel, | |||
GiImage * | phff, | |||
const GiSLightConfig * | config | |||
) |
Compute a scattered light model for a given image.
- Parameters:
-
result The computed scattered light model. image The image. localization The fiber localization. bpixel The bad pixel map. phff A photometric flat field image. config The task configuration paramters.
- Returns:
- The function returns 0 on success, or a non-zero value otherwise.
The supported scattered light model are a polynomial and a polynomial fraction.
Definition at line 1205 of file gislight.c.
References GiSLightConfig::ewidth, giraffe_image_get(), giraffe_image_get_properties(), giraffe_image_set(), giraffe_image_set_properties(), GiSLightConfig::istrim, GiSLightConfig::iswidth, GiLocalization::locw, GiLocalization::locy, GiSLightConfig::model, GiSLightConfig::xorder, GiSLightConfig::xstep, GiSLightConfig::yorder, and GiSLightConfig::ystep.
void giraffe_slight_config_add | ( | cpl_parameterlist * | list | ) |
Adds parameters for the scattered light computation.
- Parameters:
-
list Parameter list to which parameters are added.
- Returns:
- Nothing.
Definition at line 1609 of file gislight.c.
GiSLightConfig* giraffe_slight_config_create | ( | cpl_parameterlist * | list | ) |
Creates a setup structure for the scattered light computation.
- Parameters:
-
list Parameter list from which the setup informations is read.
- Returns:
- A newly allocated and initialized setup structure if no errors occurred, or
NULL
otherwise.
Definition at line 1387 of file gislight.c.
References giraffe_slight_config_destroy().
void giraffe_slight_config_destroy | ( | GiSLightConfig * | config | ) |
Destroys a scattered light setup structure.
- Parameters:
-
config The setup structure to destroy.
- Returns:
- Nothing.
Definition at line 1577 of file gislight.c.
References GiSLightConfig::model.
Referenced by giraffe_slight_config_create().