MUSE Pipeline Reference Manual  0.18.5
muclipm_make_image.h
1 /* -*- Mode: C; tab-width: 8; c-basic-offset: 4 -*- */
2 /* vim:set sw=4 ts=8: */
3 /*
4  * This file is part of the MUSE Instrument Pipeline
5  * Copyright (C) 2008-2014 European Southern Observatory
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  */
21 
22 /*********************************************************************
23  * E.S.O. - VLT project
24  *
25  * "@(#)"
26  *
27  * who when what
28  * -------- ---------- ----------------------------------------------
29  * apeconta 2012-10-08 added MUCLIPM_OVERSCAN definition and header parameter
30  * gzins 2011-03-09 added MUCLIPM_NB_IFU definition
31  * gzins 2011-03-09 suppressed muclipm_make_image_zero declaration
32  * gzins 2011-03-05 re-declared muclipm_make_image_zero
33  * gzins 2011-03-03 moved defines from C file and renamed them
34  * sbn/ape 2010-03-15 updated and tested for MUSE
35  * sdd-team 2009-12-15 created
36  */
37 
38 #ifndef MUCLIPM_MAKE_IMAGE_H
39 #define MUCLIPM_MAKE_IMAGE_H
40 
41 /*-----------------------------------------------------------------------------
42  Includes
43  -----------------------------------------------------------------------------*/
44 #include <cpl.h>
45 
46 /*-----------------------------------------------------------------------------
47  Declaration Block
48  -----------------------------------------------------------------------------*/
49 
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
53 
54 /*-----------------------------------------------------------------------------
55  Defines
56  -----------------------------------------------------------------------------*/
57 #define MUCLIPM_NB_SUBSLICERS 4 /* number of sub-slicers */
58 #define MUCLIPM_NB_SPEC_PER_SLICE 75 /* number of pixels per slice */
59 #define MUCLIPM_NB_SLICES 12 /* number of slices per sub-slicer */
60 #define MUCLIPM_INTERSPEC 7 /* inter-spectrum distance in pixel */
61 #define MUCLIPM_NB_IFU 24 /* number of IFU */
62 #define MUCLIPM_OVERSCAN 32 /* overscan width in pixel */
63 
64 /*-----------------------------------------------------------------------------
65  Procedures implemented by APE/SBN adapted to MUSE requirements
66  -----------------------------------------------------------------------------*/
67 cpl_error_code muclipm_make_image(const cpl_image *raw_img,
68  const cpl_image *offset,
69  const cpl_image *flat,
70  const cpl_image *mask,
71  const long *slice_xstart,
72  const long *slice_xend,
73  cpl_image **out_img);
74 
75 /*----------------------------------------------------------------------------*/
76 #ifdef __cplusplus
77 } /* extern "C" */
78 #endif
79 
80 #endif /* MUCLIPM_MAKE_IMAGE_H */
cpl_error_code muclipm_make_image(const cpl_image *raw_img, const cpl_image *offset, const cpl_image *flat, const cpl_image *mask, const long *slice_xstart, const long *slice_xend, cpl_image **out_img)
Collapses spectra over the spectral direction.