GIRAFFE Pipeline Reference Manual

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

This file is part of the GIRAFFE Pipeline Reference Manual 2.16.10.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Thu Dec 15 2022 21:18:51 by doxygen 1.9.1 written by Dimitri van Heesch, © 1997-2004