CR2RE Pipeline Reference Manual 1.6.2
irplib_strehl.h
1/* $Id: irplib_strehl.h,v 1.12 2009-06-29 14:32:53 kmirny Exp $
2 *
3 * This file is part of the irplib package
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: kmirny $
23 * $Date: 2009-06-29 14:32:53 $
24 * $Revision: 1.12 $
25 * $Name: not supported by cvs2svn $
26 */
27
28#ifndef IRPLIB_STREHL_H
29#define IRPLIB_STREHL_H
30
31/*-----------------------------------------------------------------------------
32 Includes
33 -----------------------------------------------------------------------------*/
34
35#include <cpl.h>
36
37/*-----------------------------------------------------------------------------
38 Define
39 -----------------------------------------------------------------------------*/
40
41#ifndef IRPLIB_STREHL_BORDER
42#define IRPLIB_STREHL_BORDER 5
43#endif
44
45/*----------------------------------------------------------------------------*/
52/*----------------------------------------------------------------------------*/
53#define IRPLIB_STREHL_M1 8.0
54/*----------------------------------------------------------------------------*/
61/*----------------------------------------------------------------------------*/
62#define IRPLIB_STREHL_M2 1.1
63/*----------------------------------------------------------------------------*/
70/*----------------------------------------------------------------------------*/
71#define IRPLIB_STREHL_BOX_SIZE 64
72
73/*----------------------------------------------------------------------------*/
80/*----------------------------------------------------------------------------*/
81#define IRPLIB_STREHL_STAR_RADIUS 2.0
82/*----------------------------------------------------------------------------*/
89/*----------------------------------------------------------------------------*/
90#define IRPLIB_STREHL_BACKGROUND_R1 2.0
91/*----------------------------------------------------------------------------*/
98/*----------------------------------------------------------------------------*/
99#define IRPLIB_STREHL_BACKGROUND_R2 3.0
100
101typedef enum {
102 IRPLIB_BG_METHOD_AVER_REJ,
103 IRPLIB_BG_METHOD_MEDIAN
104} irplib_strehl_bg_method;
105
106/*-----------------------------------------------------------------------------
107 Function prototypes
108 -----------------------------------------------------------------------------*/
109
110cpl_error_code irplib_strehl_compute(const cpl_image *, double, double, double,
111 double, double, int, double, double,
112 double, double, double, int, int,
113 double *, double *, double *, double *,
114 double *, double *, double *, double *);
115
116double irplib_strehl_disk_flux(const cpl_image *, double, double, double,
117 double);
118
119double irplib_strehl_ring_background(const cpl_image *, double, double, double,
120 double, irplib_strehl_bg_method);
121
122cpl_image * irplib_strehl_generate_psf(double, double, double, double, double,
123 int);
124cpl_error_code irplib_strehl_disk_max(const cpl_image *, double, double,
125 double, double *);
126#endif