GIRAFFE Pipeline Reference Manual

gistacking.h
1 /* $Id$
2  *
3  * This file is part of the GIRAFFE Pipeline
4  * Copyright (C) 2002-2006 European Southern Observatory
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 /*
22  * $Author$
23  * $Date$
24  * $Revision$
25  * $Name$
26  */
27 
28 #ifndef GISTACKING_H
29 #define GISTACKING_H
30 
31 #include <cxtypes.h>
32 
33 #include <cpl_macros.h>
34 #include <cpl_frame.h>
35 #include <cpl_table.h>
36 #include <cpl_parameterlist.h>
37 
38 #include "giimage.h"
39 
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 
46 enum GiStackingMethod {
47  GISTACKING_METHOD_UNDEFINED = 0,
48  GISTACKING_METHOD_AVERAGE = 1,
49  GISTACKING_METHOD_MEDIAN = 2,
50  GISTACKING_METHOD_MINMAX = 3,
51  GISTACKING_METHOD_KSIGMA = 4
52 };
53 
54 typedef enum GiStackingMethod GiStackingMethod;
55 
56 struct GiStackingConfig {
57  GiStackingMethod stackmethod;
58  cxdouble ksigmalow;
59  cxdouble ksigmahigh;
60  cxint rejectmax;
61  cxint rejectmin;
62  cxint min_nr_frames;
63 };
64 
65 typedef struct GiStackingConfig GiStackingConfig;
66 
67 
68 GiImage* giraffe_stacking_average(GiImage**, const GiStackingConfig*);
69 GiImage* giraffe_stacking_median(GiImage**, const GiStackingConfig*);
70 GiImage* giraffe_stacking_minmax(GiImage**, const GiStackingConfig*);
71 GiImage* giraffe_stacking_ksigma(GiImage**, const GiStackingConfig*);
72 GiImage* giraffe_stacking_stack_images(GiImage**, const GiStackingConfig*);
73 GiStackingConfig* giraffe_stacking_config_create(cpl_parameterlist*);
74 
75 void giraffe_stacking_config_destroy(GiStackingConfig*);
76 void giraffe_stacking_config_add(cpl_parameterlist*);
77 
78 
79 #ifdef __cplusplus
80 }
81 #endif
82 
83 #endif /* GISTACKING_H */
GiImage * giraffe_stacking_stack_images(GiImage **, const GiStackingConfig *)
Stack a list of images using one of four different kinds of stacking and return the resulting image...
Definition: gistacking.c:579
GiImage * giraffe_stacking_average(GiImage **, const GiStackingConfig *)
Stack a list of images using averaging and return the resulting image.
Definition: gistacking.c:137
void giraffe_stacking_config_destroy(GiStackingConfig *)
Destroys a setup structure for the stacking of images.
Definition: gistacking.c:797
GiImage * giraffe_stacking_minmax(GiImage **, const GiStackingConfig *)
Stack a list of images using minmax rejection and return the resulting image.
Definition: gistacking.c:314
GiStackingConfig * giraffe_stacking_config_create(cpl_parameterlist *)
Creates a setup structure for the stacking of images.
Definition: gistacking.c:681
GiImage * giraffe_stacking_ksigma(GiImage **, const GiStackingConfig *)
Stack a list of images using Kappa Sigma Clipping and return the resulting image. ...
Definition: gistacking.c:441
void giraffe_stacking_config_add(cpl_parameterlist *)
Adds parameters for the stacking of images.
Definition: gistacking.c:820
GiImage * giraffe_stacking_median(GiImage **, const GiStackingConfig *)
Stack a list of images using median and return the resulting image.
Definition: gistacking.c:213

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