GIRAFFE Pipeline Reference Manual

Scattered Light Correction

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

TBD


Function 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 inter-spectrum regions of the input image image are used to construct a scattered light model for image, using the model provided by the task setup parameters config. The position of the spectra and their width are taken from the spectrum localization localization. Optionally a bad pixel map may be provided by bpixel.

The supported scattered light model are a polynomial and a polynomial fraction.

Definition at line 1205 of file gislight.c.

References giraffe_image_get(), giraffe_image_get_properties(), giraffe_image_set(), and giraffe_image_set_properties().

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.

TBD

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.

The function deallocates the memory used by the setup structure config.

Definition at line 1577 of file gislight.c.

Referenced by giraffe_slight_config_create().


This file is part of the GIRAFFE Pipeline Reference Manual 2.8.8.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Fri Mar 4 10:50:29 2011 by doxygen 1.6.3 written by Dimitri van Heesch, © 1997-2004