File: cpl_apertures.h

package info (click to toggle)
cpl 7.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 14,808 kB
  • sloc: ansic: 132,627; javascript: 6,382; sh: 4,232; makefile: 637
file content (105 lines) | stat: -rw-r--r-- 4,832 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/*
 * This file is part of the ESO Common Pipeline Library
 * Copyright (C) 2001-2017 European Southern Observatory
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef CPL_APERTURES_H
#define CPL_APERTURES_H

/*-----------------------------------------------------------------------------
                                   Includes
 -----------------------------------------------------------------------------*/

#include <stdio.h>
#include <cpl_vector.h>
#include <cpl_image.h>

CPL_BEGIN_DECLS

/*-----------------------------------------------------------------------------
                                   New types
 -----------------------------------------------------------------------------*/

typedef struct _cpl_apertures_ cpl_apertures;

/*-----------------------------------------------------------------------------
                            Function prototypes
 -----------------------------------------------------------------------------*/

/* IO functions */
void cpl_apertures_delete(cpl_apertures *);
void cpl_apertures_dump(const cpl_apertures *, FILE *);

/* Statistics computation */
cpl_apertures * cpl_apertures_new_from_image(const cpl_image *,
                                             const cpl_image *) CPL_ATTR_ALLOC;

/* Accessor functions */
cpl_size cpl_apertures_get_size(const cpl_apertures *);
double cpl_apertures_get_pos_x(const cpl_apertures *, cpl_size);
double cpl_apertures_get_pos_y(const cpl_apertures *, cpl_size);
double cpl_apertures_get_max_x(const cpl_apertures *, cpl_size)
    CPL_ATTR_DEPRECATED;
double cpl_apertures_get_max_y(const cpl_apertures *, cpl_size)
    CPL_ATTR_DEPRECATED;
double cpl_apertures_get_centroid_x(const cpl_apertures *, cpl_size);
double cpl_apertures_get_centroid_y(const cpl_apertures *, cpl_size);
cpl_size cpl_apertures_get_maxpos_x(const cpl_apertures *, cpl_size);
cpl_size cpl_apertures_get_maxpos_y(const cpl_apertures *, cpl_size);
cpl_size cpl_apertures_get_minpos_x(const cpl_apertures *, cpl_size);
cpl_size cpl_apertures_get_minpos_y(const cpl_apertures *, cpl_size);
cpl_size cpl_apertures_get_npix(const cpl_apertures *, cpl_size);
cpl_size cpl_apertures_get_left(const cpl_apertures *, cpl_size);
cpl_size cpl_apertures_get_left_y(const cpl_apertures *, cpl_size);
cpl_size cpl_apertures_get_right(const cpl_apertures *, cpl_size);
cpl_size cpl_apertures_get_right_y(const cpl_apertures *, cpl_size);
cpl_size cpl_apertures_get_top_x(const cpl_apertures *, cpl_size);
cpl_size cpl_apertures_get_top(const cpl_apertures *, cpl_size);
cpl_size cpl_apertures_get_bottom_x(const cpl_apertures *, cpl_size);
cpl_size cpl_apertures_get_bottom(const cpl_apertures *, cpl_size);
double cpl_apertures_get_max(const cpl_apertures *, cpl_size);
double cpl_apertures_get_min(const cpl_apertures *, cpl_size);
double cpl_apertures_get_mean(const cpl_apertures *, cpl_size);
double cpl_apertures_get_median(const cpl_apertures *, cpl_size);
double cpl_apertures_get_stdev(const cpl_apertures *, cpl_size);
double cpl_apertures_get_flux(const cpl_apertures *, cpl_size);

/* Sorting functions */
cpl_error_code cpl_apertures_sort_by_npix(cpl_apertures *);
cpl_error_code cpl_apertures_sort_by_max(cpl_apertures  *);
cpl_error_code cpl_apertures_sort_by_flux(cpl_apertures *);

/* Detection functions */
cpl_apertures * cpl_apertures_extract(const cpl_image *, const cpl_vector *,
                                      cpl_size *) CPL_ATTR_ALLOC;
cpl_apertures * cpl_apertures_extract_window(const cpl_image *,
                                             const cpl_vector *, cpl_size,
                                             cpl_size, cpl_size,
                                             cpl_size, cpl_size *)
    CPL_ATTR_ALLOC;

cpl_apertures * cpl_apertures_extract_mask(const cpl_image *,
                                           const cpl_mask *) CPL_ATTR_ALLOC;
cpl_apertures * cpl_apertures_extract_sigma(const cpl_image *,
                                            double) CPL_ATTR_ALLOC;

cpl_bivector* cpl_apertures_get_fwhm(const cpl_image*,
                                     const cpl_apertures*) CPL_ATTR_DEPRECATED;

CPL_END_DECLS

#endif