ifw-odp  2.0.0-alpha
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
clipm_priv_checks.h
Go to the documentation of this file.
1 
2 /*********************************************************************
3  * E.S.O. - VLT project
4  *
5  * "@(#) $Id: clipm_priv_checks.h 262680 2014-12-08 13:29:46Z cgarcia $"
6  *
7  * Private functions for checking parameters
8  *
9  * who when what
10  * -------- ---------- ----------------------------------------------
11  * hlorch 2006-08-12 created
12  */
13 
14 #ifndef CLIPM_PRIV_CHECKS_H
15 #define CLIPM_PRIV_CHECKS_H
16 
17 /*-----------------------------------------------------------------------------
18  Includes
19  -----------------------------------------------------------------------------*/
20 
21 #include <cpl.h>
22 
23 /*-----------------------------------------------------------------------------
24  Declaration Block
25  -----------------------------------------------------------------------------*/
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 /*-----------------------------------------------------------------------------
32  Prototypes
33  -----------------------------------------------------------------------------*/
34 
35 int clipm_priv_checks_is_window_full_image(
36  const cpl_size window_xxyy[4],
37  const cpl_image *image);
38 cpl_error_code clipm_priv_checks_window_image(
39  const cpl_size window_xxyy[4],
40  const cpl_image *image,
41  int allow_window_NULL,
42  cpl_size *img_size_xy,
43  cpl_size *window_size_xy,
44  cpl_size *buffer_start_xy);
45 cpl_error_code clipm_priv_checks_window_minmax(
46  const int window_xxyy[4],
47  int ndims,
48  int allow_window_NULL);
49 cpl_error_code clipm_priv_checks_window_guarantee(
50  cpl_size window_xxyy[4],
51  cpl_size xsize,
52  cpl_size ysize,
53  cpl_size min_wsize);
54 cpl_error_code clipm_priv_checks_window_guarantee_image(
55  cpl_size window_xxyy[4],
56  const cpl_image *image,
57  cpl_size min_wsize);
58 cpl_error_code clipm_priv_checks_window_guarantee_window(
59  cpl_size window_xxyy[4],
60  const cpl_size *ref_window,
61  cpl_size min_wsize);
62 cpl_error_code clipm_priv_checks_images_match(
63  const cpl_image *img1,
64  const cpl_image *img2,
65  cpl_type *type,
66  cpl_size *xsize,
67  cpl_size *ysize);
68 cpl_error_code clipm_priv_checks_imtype_any(
69  const cpl_image *image,
70  cpl_type *out_type);
71 cpl_error_code clipm_priv_checks_imtype_float(
72  const cpl_image *image,
73  cpl_type *out_type);
74 
75 /*----------------------------------------------------------------------------*/
76 
77 #ifdef __cplusplus
78 } /* extern "C" */
79 #endif
80 
81 #endif /* CLIPM_PRIV_CHECKS_H */
clipm_priv_checks_window_guarantee_window
cpl_error_code clipm_priv_checks_window_guarantee_window(cpl_size window_xxyy[4], const cpl_size *ref_window, cpl_size min_wsize)
Cut window coordinates to an existing reference window range, expand if necessary.
Definition: clipm_priv_checks.c:459
clipm_priv_checks_window_guarantee_image
cpl_error_code clipm_priv_checks_window_guarantee_image(cpl_size window_xxyy[4], const cpl_image *image, cpl_size min_wsize)
Cut window coordinates to a FITS image range if outside, expand if necessary.
Definition: clipm_priv_checks.c:414
clipm_priv_checks_imtype_float
cpl_error_code clipm_priv_checks_imtype_float(const cpl_image *image, cpl_type *out_type)
Check whether an image is of a floating-point type.
Definition: clipm_priv_checks.c:657
clipm_priv_checks_window_guarantee
cpl_error_code clipm_priv_checks_window_guarantee(cpl_size window_xxyy[4], cpl_size xsize, cpl_size ysize, cpl_size min_wsize)
Cut window coordinates to a FITS image range if outside, expand if necessary.
Definition: clipm_priv_checks.c:322
clipm_priv_checks_window_minmax
cpl_error_code clipm_priv_checks_window_minmax(const int window_xxyy[4], int ndims, int allow_window_NULL)
Check coordinates for min/max condition.
Definition: clipm_priv_checks.c:264
clipm_priv_checks_images_match
cpl_error_code clipm_priv_checks_images_match(const cpl_image *img1, const cpl_image *img2, cpl_type *type, cpl_size *xsize, cpl_size *ysize)
Check whether two images match in the requested features.
Definition: clipm_priv_checks.c:528
clipm_priv_checks_is_window_full_image
int clipm_priv_checks_is_window_full_image(const cpl_size window_xxyy[4], const cpl_image *image)
Check if window coordinates represent the whole image.
Definition: clipm_priv_checks.c:70
clipm_priv_checks_imtype_any
cpl_error_code clipm_priv_checks_imtype_any(const cpl_image *image, cpl_type *out_type)
Check whether an image is of an allowed type.
Definition: clipm_priv_checks.c:611
clipm_priv_checks_window_image
cpl_error_code clipm_priv_checks_window_image(const cpl_size window_xxyy[4], const cpl_image *image, int allow_window_NULL, cpl_size *img_size_xy, cpl_size *window_size_xy, cpl_size *buffer_start_xy)
Check window coordinates with the corresponding image.
Definition: clipm_priv_checks.c:148
Generated by   doxygen 1.8.5