IIINSTRUMENT Pipeline Reference Manual  1.5.13
sofi_utils.h
1 /* $Id: sofi_utils.h,v 1.9 2013-03-12 08:04:54 llundin Exp $
2  *
3  * This file is part of the SOFI Pipeline
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: llundin $
23  * $Date: 2013-03-12 08:04:54 $
24  * $Revision: 1.9 $
25  * $Name: not supported by cvs2svn $
26  */
27 
28 #ifndef SOFI_UTILS_H
29 #define SOFI_UTILS_H
30 
31 /*-----------------------------------------------------------------------------
32  Includes
33  -----------------------------------------------------------------------------*/
34 
35 #include <cpl.h>
36 
37 /*-----------------------------------------------------------------------------
38  Includes
39  -----------------------------------------------------------------------------*/
40 
41 typedef enum _SOFI_BAND_ {
42  SOFI_BAND_J,
43  SOFI_BAND_JS,
44  SOFI_BAND_JBLOCK,
45  SOFI_BAND_H,
46  SOFI_BAND_K,
47  SOFI_BAND_KS,
48  SOFI_BAND_L,
49  SOFI_BAND_M,
50  SOFI_BAND_LP,
51  SOFI_BAND_MP,
52  SOFI_BAND_Z,
53  SOFI_BAND_SZ,
54  SOFI_BAND_SH,
55  SOFI_BAND_SK,
56  SOFI_BAND_SL,
57  SOFI_BAND_UNKNOWN
58 } sofi_band ;
59 
60 /*-----------------------------------------------------------------------------
61  Prototypes
62  -----------------------------------------------------------------------------*/
63 
64 const char * sofi_get_license(void) ;
65 cpl_bivector * sofi_get_offsets(cpl_frameset *) ;
66 sofi_band sofi_get_bbfilter(char *) ;
67 const char * sofi_std_band_name(sofi_band) ;
68 int sofi_correct_crosstalk(cpl_image *) ;
69 int sofi_correct_crosstalk_list(cpl_imagelist *) ;
70 cpl_frameset * sofi_extract_frameset(const cpl_frameset *, const char *) ;
71 const char * sofi_extract_filename(const cpl_frameset *, const char *) ;
72 int sofi_detlin_correct(cpl_imagelist *, const char *, const char *,
73  const char *) ;
74 
75 #endif
sofi_detlin_correct
int sofi_detlin_correct(cpl_imagelist *, const char *, const char *, const char *)
Apply the detector linearity correction.
Definition: sofi_utils.c:363
sofi_correct_crosstalk_list
int sofi_correct_crosstalk_list(cpl_imagelist *)
Remove the Cross-talk effect from an image list.
Definition: sofi_utils.c:91
sofi_std_band_name
const char * sofi_std_band_name(sofi_band)
Return a band name.
Definition: sofi_utils.c:266
sofi_extract_frameset
cpl_frameset * sofi_extract_frameset(const cpl_frameset *, const char *)
Extract the frames with the given tag from a frameset.
Definition: sofi_utils.c:298
sofi_get_offsets
cpl_bivector * sofi_get_offsets(cpl_frameset *)
Get the offsets from a set of frames.
Definition: sofi_utils.c:181
sofi_get_license
const char * sofi_get_license(void)
Get the pipeline copyright and license.
Definition: sofi_utils.c:60
sofi_get_bbfilter
sofi_band sofi_get_bbfilter(char *)
Get the broad band filter.
Definition: sofi_utils.c:233
sofi_correct_crosstalk
int sofi_correct_crosstalk(cpl_image *)
Remove the Cross-talk effect.
Definition: sofi_utils.c:124
sofi_extract_filename
const char * sofi_extract_filename(const cpl_frameset *, const char *)
Extract the filename ffor the first frame of the given tag.
Definition: sofi_utils.c:342