FORS Pipeline Reference Manual  5.0.9
fors_extract.h
1 /* $Id: fors_extract.h,v 1.11 2011-06-11 06:16:24 cizzo Exp $
2  *
3  * This file is part of the FORS Library
4  * Copyright (C) 2002-2010 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 02110-1301 USA
19  */
20 
21 /*
22  * $Author: cizzo $
23  * $Date: 2011-06-11 06:16:24 $
24  * $Revision: 1.11 $
25  * $Name: not supported by cvs2svn $
26  */
27 
28 #ifndef FORS_EXTRACT_H
29 #define FORS_EXTRACT_H
30 
31 #include <fors_star.h>
32 #include <fors_image.h>
33 
34 #include <cpl.h>
35 
36 CPL_BEGIN_DECLS
37 
38 typedef struct _extract_method extract_method;
39 
40 typedef struct fors_extract_sky_stats {
41  double mean, median, rms;
43 
44 void
45 fors_extract_define_parameters( cpl_parameterlist *parameters,
46  const char *context);
47 
48 bool
49 fors_extract_check_sex_flag( unsigned int sex_flag);
50 
51 bool
53  const cpl_image *ref_img);
54 
55 
56 extract_method *
57 fors_extract_method_new( const cpl_parameterlist *parameters,
58  const char *context);
59 
60 void
61 fors_extract_method_delete( extract_method **em);
62 
63 fors_star_list *
64 fors_extract( const fors_image *image,
65  const fors_setting *setting,
66  const extract_method *em,
67  double magsyserr,
68  fors_extract_sky_stats *sky_stats,
69  cpl_image **background,
70  cpl_table **extracted_sources);
71 
72 
73 CPL_END_DECLS
74 
75 #endif
void fors_extract_method_delete(extract_method **em)
Deallocate extraction method and set the pointer to NULL.
void fors_extract_define_parameters(cpl_parameterlist *parameters, const char *context)
Define recipe parameters.
bool fors_extract_check_sex_flag(unsigned int sex_flag)
Check SExtractor object feature: FLAG.
fors_star_list * fors_extract(const fors_image *image, const fors_setting *setting, const extract_method *em, double magsyserr, fors_extract_sky_stats *sky_stats, cpl_image **background, cpl_table **extracted_sources)
Extract sources.
extract_method * fors_extract_method_new(const cpl_parameterlist *parameters, const char *context)
Get extraction method from parameter list.
bool fors_extract_check_sex_star(const fors_star *star, const cpl_image *ref_img)
Check a sextracted star for validity.