GIRAFFE Pipeline Reference Manual

Stacking of Giraffe Images

Functions

GiImage * giraffe_stacking_average (GiImage **img_array, const GiStackingConfig *config)
 Stack a list of images using averaging and return the resulting image. More...
 
GiImage * giraffe_stacking_median (GiImage **img_array, const GiStackingConfig *config)
 Stack a list of images using median and return the resulting image. More...
 
GiImage * giraffe_stacking_minmax (GiImage **img_array, const GiStackingConfig *config)
 Stack a list of images using minmax rejection and return the resulting image. More...
 
GiImage * giraffe_stacking_ksigma (GiImage **img_array, const GiStackingConfig *config)
 Stack a list of images using Kappa Sigma Clipping and return the resulting image. More...
 
GiImage * giraffe_stacking_stack_images (GiImage **img_array, const GiStackingConfig *config)
 Stack a list of images using one of four different kinds of stacking and return the resulting image. More...
 
GiStackingConfig * giraffe_stacking_config_create (cpl_parameterlist *list)
 Creates a setup structure for the stacking of images. More...
 
void giraffe_stacking_config_destroy (GiStackingConfig *config)
 Destroys a setup structure for the stacking of images. More...
 
void giraffe_stacking_config_add (cpl_parameterlist *list)
 Adds parameters for the stacking of images. More...
 

Detailed Description

The module implements a way of stacking Giraffe Images stored in a list in different ways. Given a list of images they can be combined using averaging, median, Minimum-Maximum rejection and Kappa-Sigma Clipping.

#include <gistacking.h>

Function Documentation

GiImage* giraffe_stacking_average ( GiImage **  img_array,
const GiStackingConfig *  config 
)

Stack a list of images using averaging and return the resulting image.

Parameters
img_arrayArray of input images, last arrayentry should be NULL
configConfiguration data for stacking method
See also
GiStackingMethod
Returns
Pointer to the newly created image.

Function creates an output image which is the average of all of the input images on a pixel by pixel basis.

Definition at line 137 of file gistacking.c.

References giraffe_image_create(), and giraffe_image_get().

Referenced by giraffe_stacking_stack_images().

void giraffe_stacking_config_add ( cpl_parameterlist *  list)

Adds parameters for the stacking of images.

Parameters
listParameter list to which parameters are added.
Returns
Nothing.

TBD

Definition at line 820 of file gistacking.c.

GiStackingConfig* giraffe_stacking_config_create ( cpl_parameterlist *  list)

Creates a setup structure for the stacking of images.

Parameters
listParameter list.
Returns
A newly allocated and initialized setup structure if no errors occurred, or NULL otherwise.

The function creates and initializes a setup structure with the values taken from the parameter list list. If an invalid stacking method is found in the parameter list the function fails returning NULL. In addition the error code CPL_ERROR_ILLEGAL_INPUT is set.

Definition at line 681 of file gistacking.c.

References giraffe_stacking_config_destroy().

void giraffe_stacking_config_destroy ( GiStackingConfig *  config)

Destroys a setup structure for the stacking of images.

Parameters
configThe setup structure to destroy.
Returns
Nothing.

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

Definition at line 797 of file gistacking.c.

Referenced by giraffe_stacking_config_create().

GiImage* giraffe_stacking_ksigma ( GiImage **  img_array,
const GiStackingConfig *  config 
)

Stack a list of images using Kappa Sigma Clipping and return the resulting image.

Parameters
img_arrayArray of input images, last arrayentry should be NULL
configConfiguration data for stacking method
See also
GiStackingMethod
Returns
Pointer to the newly created image.

Function creates an output image which is the Kappa Sigma Clipped value of all of the input images on a pixel by pixel basis.

Kappa Sigma Clipping is based on finding first the median for a specific pixel coordinate x,y and secondly determining the sigma value around this median. All values less than median - ( config->ksigmalow * sigma ) are discarded as well as all values larger than median + ( config->ksigmahigh * sigma ). The resulting pixel value is the average value of the remaining pixel values after the discard has taken place.

Definition at line 441 of file gistacking.c.

References giraffe_image_create(), and giraffe_image_get().

Referenced by giraffe_stacking_stack_images().

GiImage* giraffe_stacking_median ( GiImage **  img_array,
const GiStackingConfig *  config 
)

Stack a list of images using median and return the resulting image.

Parameters
img_arrayArray of input images, last arrayentry should be NULL
configConfiguration data for stacking method
See also
GiStackingMethod
Returns
Pointer to the newly created image.

Function creates an output image which is the median value of all of the input images on a pixel by pixel basis.

Definition at line 213 of file gistacking.c.

References giraffe_image_create(), and giraffe_image_get().

Referenced by giraffe_stacking_stack_images().

GiImage* giraffe_stacking_minmax ( GiImage **  img_array,
const GiStackingConfig *  config 
)

Stack a list of images using minmax rejection and return the resulting image.

Parameters
img_arrayArray of input images, last arrayentry should be NULL
configConfiguration data for stacking method
See also
GiStackingMethod
Returns
Pointer to the newly created image.

Function creates an output image which is the minmax rejected value of all of the input images on a pixel by pixel basis.

MinMax rejection is based on sorting the values for a specific pixel coordinate x,y and discarding the config->rejectmin lowest values and the config->rejectmax highest values. The resulting pixel value is the average value of the remaining pixel values after the discard has taken place.

Constraints: config->rejectmin + config->rejectmax < total number of images, config->rejectmin > 0 and config->rejectmax > 0

Definition at line 314 of file gistacking.c.

References giraffe_image_create(), and giraffe_image_get().

Referenced by giraffe_stacking_stack_images().

GiImage* giraffe_stacking_stack_images ( GiImage **  img_array,
const GiStackingConfig *  config 
)

Stack a list of images using one of four different kinds of stacking and return the resulting image.

Parameters
img_arrayArray of input images, last arrayentry should be NULL
configConfiguration data for stacking method
See also
GiStackingMethod
Returns
Pointer to the newly created image.

Function creates an output image which is the result of stacking i.e. combining the list of input images.

Possible stacking methods are:

  • Averaging
  • Median
  • Min Max Rejection
  • Kappa-Sigma Clipping
See also
giraffe_stacking_average
giraffe_stacking_median
giraffe_stacking_minmax
giraffe_stacking_ksigma

Definition at line 579 of file gistacking.c.

References giraffe_stacking_average(), giraffe_stacking_ksigma(), giraffe_stacking_median(), and giraffe_stacking_minmax().


This file is part of the GIRAFFE Pipeline Reference Manual 2.14.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Wed Mar 11 2015 13:19:42 by doxygen 1.8.9.1 written by Dimitri van Heesch, © 1997-2004