IIINSTRUMENT Pipeline Reference Manual  1.3.10
detmon_pernoise.h
1 /* $Id: detmon.h,v 1.3 2013-01-25 16:08:41 jtaylor Exp $
2  *
3  * This file is part of the irplib package
4  * Copyright (C) 2002, 2003 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 02111-1307 USA
19  */
20 
21 /*
22  * $Author: jtaylor $
23  * $Date: 2013-01-25 16:08:41 $
24  * $Revision: 1.3 $
25  * $Name: not supported by cvs2svn $
26  */
27 
28 #ifndef IRPLIB_DETMON_PERNOISE_H
29 #define IRPLIB_DETMON_PERNOISE_H
30 
31 /*----------------------------------------------------------------------------
32  Includes
33  ----------------------------------------------------------------------------*/
34 
35 #include <cpl.h>
36 
37 /*----------------------------------------------------------------------------
38  Defines
39  ----------------------------------------------------------------------------*/
40 
41 
42 #define DETMON_QC_FREQ "ESO QC FREQ"
43 #define DETMON_QC_FREQ_C "Spectrum frequency"
44 
45 #define DETMON_QC_POW "ESO QC POW"
46 #define DETMON_QC_POW_C "Spectrum power"
47 
48 
49 #define detmon_pernoise_get_description(RECIPE_NAME, PIPE_NAME, \
50  DETMON_PERNOISE_RAW) \
51  RECIPE_NAME " -- " PIPE_NAME " Recipe for Periodic Noise Characterisation.\n" \
52  "The files listed in the Set Of Frames must be tagged:\n" \
53  "raw-file.fits "DETMON_PERNOISE_RAW"\n"
54 
55 /*----------------------------------------------------------------------------
56  Prototypes
57  ----------------------------------------------------------------------------*/
58 
59 cpl_error_code
60 detmon_fill_pernoise_params(cpl_parameterlist *,
61  const char *,
62  const char *,
63  int mode,
64  const char *direction,
65  double speed,
66  int llx,
67  int lly,
68  int urx,
69  int ury,
70  double kappa,
71  int exts);
72 
73 int detmon_fill_pernoise_params_default(cpl_parameterlist *,
74  const char *,
75  const char *);
76 
77 cpl_error_code
78 detmon_pernoise(cpl_frameset *,
79  const cpl_parameterlist *,
80  const char *,
81  const char *,
82  const char *,
83  const char *,
84  const char *,
85  int (*)(const cpl_frame *,
86  const cpl_frame *));
87 
88 cpl_table *
89 detmon_pernoise_reduce(cpl_image *);
90 
91 
92 #endif