GIRAFFE Pipeline Reference Manual

gipsf.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 GIPSF_H
21 #define GIPSF_H
22 
23 #include <cpl_macros.h>
24 #include <cpl_parameterlist.h>
25 
26 #include <giimage.h>
27 #include <gipsfdata.h>
28 #include <gimodel.h>
29 #include <giclip.h>
30 
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36  struct GiPsfConfig {
37  const cxchar* profile;
38  cxint binsize;
39  cxint maxwidth;
40  cxint width;
41  cxint exponent;
42  cxint yorder;
43  cxint worder;
44  cxbool normalize;
45  cxbool parameter_fit;
46  GiFitSetup fit;
47  GiClipParams clip;
48  };
49 
50  typedef struct GiPsfConfig GiPsfConfig;
51 
52  cxint giraffe_compute_fiber_profiles(GiLocalization* result,
53  GiImage* image,
54  GiTable* fibers,
55  GiLocalization* master,
56  GiImage* bpixel,
57  GiPsfConfig* config);
58 
59  /*
60  * Convenience functions
61  */
62 
63  GiPsfConfig* giraffe_psf_config_create(cpl_parameterlist* list);
64  void giraffe_psf_config_destroy(GiPsfConfig* self);
65 
66  void giraffe_psf_config_add(cpl_parameterlist* list);
67 
68 
69 #ifdef __cplusplus
70 }
71 #endif
72 
73 #endif /* GIPSF_H */
void giraffe_psf_config_destroy(GiPsfConfig *self)
Destroys a PSF profile fit setup object.
Definition: gipsf.c:3254
GiPsfConfig * giraffe_psf_config_create(cpl_parameterlist *list)
Creates a setup object for the PSF profile fit.
Definition: gipsf.c:3150
cxint giraffe_compute_fiber_profiles(GiLocalization *result, GiImage *image, GiTable *fibers, GiLocalization *master, GiImage *bpixel, GiPsfConfig *config)
Compute the position and width of the spectra from the fiber profile.
Definition: gipsf.c:2601
void giraffe_psf_config_add(cpl_parameterlist *list)
Adds parameters for the PSF profile computation of the fibers.
Definition: gipsf.c:3283

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