fors_std_star.h

00001 /* $Id: fors_std_star.h,v 1.14 2010/09/14 07:49:30 cizzo Exp $
00002  *
00003  * This file is part of the FORS Library
00004  * Copyright (C) 2002-2010 European Southern Observatory
00005  *
00006  * This program is free software; you can redistribute it and/or modify
00007  * it under the terms of the GNU General Public License as published by
00008  * the Free Software Foundation; either version 2 of the License, or
00009  * (at your option) any later version.
00010  *
00011  * This program is distributed in the hope that it will be useful,
00012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  * GNU General Public License for more details.
00015  *
00016  * You should have received a copy of the GNU General Public License
00017  * along with this program; if not, write to the Free Software
00018  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
00019  */
00020 
00021 /*
00022  * $Author: cizzo $
00023  * $Date: 2010/09/14 07:49:30 $
00024  * $Revision: 1.14 $
00025  * $Name: fors-4_8_6 $
00026  */
00027 
00028 #ifndef FORS_STD_STAR_H
00029 #define FORS_STD_STAR_H
00030 
00031 #include <fors_point.h>
00032 
00033 #include <cpl.h>
00034 
00035 #include <stdbool.h>
00036 
00037 CPL_BEGIN_DECLS
00038 
00039 typedef struct _fors_std_star 
00040 {
00041     fors_point  *pixel;
00042     double      ra, dec;
00043     double      magnitude;      /* Color corrected according to filter used */
00044     double      dmagnitude;     /* 1 sigma error */
00045     double      cat_magnitude;  /* From catalog */
00046     double      dcat_magnitude; /* From catalog */
00047     double      color;          /* color, defined as difference between bands */
00048     double      dcolor;         /* 1 sigma color error */
00049     double      cov_catm_color; /* covariance(cat_magnitude, color) */
00050     const char  *name;
00051     bool        trusted;
00052 } fors_std_star;
00053 
00054 #undef LIST_ELEM
00055 #define LIST_ELEM fors_std_star
00056 #include <list.h>
00057 
00058 fors_std_star   *fors_std_star_new(         double ra, double dec,
00059                                             double m, double dm,
00060                                             double cat_m, double dcat_m,
00061                                             double col, double dcol,
00062                                             double cov_catm_col,
00063                                             const char *name);
00064 
00065 fors_std_star   *fors_std_star_new_from_table(
00066                                             const cpl_table *tab,
00067                                             unsigned int    row,
00068                                             const char      *ra_col,
00069                                             const char      *dec_col,
00070                                             const char      *mag_col,
00071                                             const char      *dmag_col,
00072                                             const char      *catmag_col,
00073                                             const char      *dcatmag_col,
00074                                             const char      *color_col,
00075                                             const char      *dcolor_col,
00076                                             const char      *cov_catm_color_col,
00077                                             const char      *x_col,
00078                                             const char      *y_col,
00079                                             const char      *name_col);
00080 
00081 void            fors_std_star_delete(       fors_std_star **s);
00082 
00083 void            fors_std_star_delete_const( const fors_std_star **s);
00084 
00085 fors_std_star   *fors_std_star_duplicate(   const fors_std_star *s);
00086 
00087 void            fors_std_star_set_name(     fors_std_star   *s,
00088                                             const char      *name);
00089 
00090 bool            fors_std_star_equal(        const fors_std_star *s,
00091                                             const fors_std_star *t);
00092 
00093 void            fors_std_star_print(        cpl_msg_severity level,
00094                                             const fors_std_star *star);
00095 
00096 void            fors_std_star_print_list(   cpl_msg_severity level,
00097                                             const fors_std_star_list *sl);
00098 
00099 bool            fors_std_star_brighter_than(const fors_std_star *s,
00100                                             const fors_std_star *t,
00101                                             void *data);
00102 
00103 double          fors_std_star_dist_arcsec(  const fors_std_star *s,
00104                                             const fors_std_star *t);
00105 
00106 void            fors_std_star_compute_corrected_mag(
00107                                             fors_std_star   *s,
00108                                             double          color_term,
00109                                             double          dcolor_term);
00110 
00111 CPL_END_DECLS
00112 
00113 #endif

Generated on Fri Mar 4 09:46:01 2011 for FORS Pipeline Reference Manual by  doxygen 1.4.7