GIRAFFE Pipeline Reference Manual

gidark.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 GIDARK_H
21 #define GIDARK_H
22 
23 #include <giimage.h>
24 
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
30  enum GiDarkMethod {
31  GIDARK_METHOD_UNIFORM = 0,
32  GIDARK_METHOD_MASTER = 1,
33  GIDARK_METHOD_ZMASTER = 2
34  };
35 
36  typedef enum GiDarkMethod GiDarkMethod;
37 
38 
39  struct GiDarkResults {
40  cxdouble value;
41  cxdouble expected;
42  cxdouble mode;
43  cxdouble maximum;
44  };
45 
46  typedef struct GiDarkResults GiDarkResults;
47 
48  struct GiDarkConfig {
49  GiDarkMethod method;
50  cxdouble threshold;
51  };
52 
53  typedef struct GiDarkConfig GiDarkConfig;
54 
55 
56  cxint giraffe_subtract_dark(GiImage* image, const GiImage* dark,
57  const GiImage* bpixel, GiDarkResults* data,
58  const GiDarkConfig* config);
59 
60 #ifdef __cplusplus
61 }
62 #endif
63 
64 #endif /* GIDARK_H */
cxint giraffe_subtract_dark(GiImage *image, const GiImage *dark, const GiImage *bpixel, GiDarkResults *data, const GiDarkConfig *config)
Subtract the dark current from a bias corrected image.
Definition: gidark.c:478

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