Common Pipeline Library Reference Manual
5.3.1
|
Functions | |
void | cpl_apertures_dump (const cpl_apertures *aperts, FILE *fp) |
Dump a cpl_apertures to an opened file pointer. | |
cpl_apertures * | cpl_apertures_extract (const cpl_image *in, const cpl_vector *sigmas, int *pisigma) |
Simple detection of apertures in an image. | |
cpl_apertures * | cpl_apertures_extract_sigma (const cpl_image *in, double sigma) |
Simple apertures detection in an image using a provided sigma. | |
cpl_apertures * | cpl_apertures_extract_window (const cpl_image *in, const cpl_vector *sigmas, int llx, int lly, int urx, int ury, int *pisigma) |
Simple detection of apertures in an image window. | |
int | cpl_apertures_get_bottom (const cpl_apertures *in, int ind) |
Get the bottommost y position in an aperture. | |
int | cpl_apertures_get_bottom_x (const cpl_apertures *in, int ind) |
Get the x position of the bottommost y position in an aperture. | |
double | cpl_apertures_get_centroid_x (const cpl_apertures *in, int ind) |
Get the x centroid of an aperture. | |
double | cpl_apertures_get_centroid_y (const cpl_apertures *in, int ind) |
Get the y centroid of an aperture. | |
double | cpl_apertures_get_flux (const cpl_apertures *in, int ind) |
Get the flux of an aperture. | |
int | cpl_apertures_get_left (const cpl_apertures *in, int ind) |
Get the leftmost x position in an aperture. | |
int | cpl_apertures_get_left_y (const cpl_apertures *in, int ind) |
Get the y position of the leftmost x position in an aperture. | |
double | cpl_apertures_get_max (const cpl_apertures *in, int ind) |
Get the maximum value of an aperture. | |
double | cpl_apertures_get_max_x (const cpl_apertures *in, int ind) |
Get the x position of an aperture. | |
double | cpl_apertures_get_max_y (const cpl_apertures *in, int ind) |
Get the y position of an aperture. | |
double | cpl_apertures_get_mean (const cpl_apertures *in, int ind) |
Get the mean value of an aperture. | |
double | cpl_apertures_get_median (const cpl_apertures *in, int ind) |
Get the median value of an aperture. | |
double | cpl_apertures_get_min (const cpl_apertures *in, int ind) |
Get the minimum value of an aperture. | |
int | cpl_apertures_get_npix (const cpl_apertures *in, int ind) |
Get the number of pixels of an aperture. | |
int | cpl_apertures_get_right (const cpl_apertures *in, int ind) |
Get the rightmost x position in an aperture. | |
int | cpl_apertures_get_right_y (const cpl_apertures *in, int ind) |
Get the y position of the rightmost x position in an aperture. | |
int | cpl_apertures_get_size (const cpl_apertures *in) |
Get the number of apertures. | |
double | cpl_apertures_get_stdev (const cpl_apertures *in, int ind) |
Get the std dev. value of an aperture. | |
int | cpl_apertures_get_top (const cpl_apertures *in, int ind) |
Get the topmost y position in an aperture. | |
int | cpl_apertures_get_top_x (const cpl_apertures *in, int ind) |
Get the x position of the topmost y position in an aperture. | |
cpl_apertures * | cpl_apertures_new_from_image (const cpl_image *in, const cpl_image *lab) |
Compute statistics on selected apertures. | |
cpl_error_code | cpl_apertures_sort_by_flux (cpl_apertures *in) |
Sort by decreasing aperture flux. | |
cpl_error_code | cpl_apertures_sort_by_max (cpl_apertures *in) |
Sort by decreasing aperture peak value. | |
cpl_error_code | cpl_apertures_sort_by_npix (cpl_apertures *in) |
Sort by decreasing aperture size. |
The aperture object contains a list of zones in an image. It is typically used to contain the results of an objects detection, or if one wants to work on a very specific zone in an image.
This module provides functions to handle cpl_apertures.
void cpl_apertures_dump | ( | const cpl_apertures * | aperts, |
FILE * | fp | ||
) |
Dump a cpl_apertures to an opened file pointer.
aperts | cpl_apertures to dump |
fp | Opened file pointer, ready to receive data |
This function dumps all informations contained into a cpl_apertures to the passed (opened) file pointer. It is Ok to pass stdout or stderr. If the object is unallocated or contains nothing, this function does nothing.
cpl_apertures* cpl_apertures_extract | ( | const cpl_image * | in, |
const cpl_vector * | sigmas, | ||
int * | pisigma | ||
) |
Simple detection of apertures in an image.
in | Input image |
sigmas | Positive, decreasing sigmas to apply |
pisigma | Index of the sigma that was used or unchanged on error |
pisigma may be NULL.
Possible _cpl_error_code_ set in this function:
cpl_apertures* cpl_apertures_extract_sigma | ( | const cpl_image * | in, |
double | sigma | ||
) |
Simple apertures detection in an image using a provided sigma.
in | Input image |
sigma | detection level |
The threshold used for the detection is the median plus the average distance to the median times sigma.
The input image type can be CPL_TYPE_DOUBLE, CPL_TYPE_FLOAT or CPL_TYPE_INT.
Possible _cpl_error_code_ set in this function:
cpl_apertures* cpl_apertures_extract_window | ( | const cpl_image * | in, |
const cpl_vector * | sigmas, | ||
int | llx, | ||
int | lly, | ||
int | urx, | ||
int | ury, | ||
int * | pisigma | ||
) |
Simple detection of apertures in an image window.
in | Input image |
sigmas | Positive, decreasing sigmas to apply |
llx | Lower left x position (FITS convention) |
lly | Lower left y position (FITS convention) |
urx | Upper right x position (FITS convention) |
ury | Upper right y position (FITS convention) |
pisigma | Index of the sigma that was used or undefined on error |
int cpl_apertures_get_bottom | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the bottommost y position in an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
Possible _cpl_error_code_ set in this function:
int cpl_apertures_get_bottom_x | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the x position of the bottommost y position in an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
Possible _cpl_error_code_ set in this function:
double cpl_apertures_get_centroid_x | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the x centroid of an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
In case of error, the _cpl_error_code_ code is set, and the returned double is undefined.
Possible _cpl_error_code_ set in this function:
double cpl_apertures_get_centroid_y | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the y centroid of an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
In case of error, the _cpl_error_code_ code is set, and the returned double is undefined.
Possible _cpl_error_code_ set in this function:
double cpl_apertures_get_flux | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the flux of an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
int cpl_apertures_get_left | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the leftmost x position in an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
Possible _cpl_error_code_ set in this function:
int cpl_apertures_get_left_y | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the y position of the leftmost x position in an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
Possible _cpl_error_code_ set in this function:
double cpl_apertures_get_max | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the maximum value of an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
In case of error, the _cpl_error_code_ code is set, and the returned double is undefined.
Possible _cpl_error_code_ set in this function:
double cpl_apertures_get_max_x | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the x position of an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
In case of error, the _cpl_error_code_ code is set, and the returned double is undefined.
Possible _cpl_error_code_ set in this function:
double cpl_apertures_get_max_y | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the y position of an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
double cpl_apertures_get_mean | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the mean value of an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
In case of error, the _cpl_error_code_ code is set, and the returned double is undefined.
Possible _cpl_error_code_ set in this function:
double cpl_apertures_get_median | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the median value of an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
double cpl_apertures_get_min | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the minimum value of an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
In case of error, the _cpl_error_code_ code is set, and the returned double is undefined.
Possible _cpl_error_code_ set in this function:
int cpl_apertures_get_npix | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the number of pixels of an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
Possible _cpl_error_code_ set in this function:
int cpl_apertures_get_right | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the rightmost x position in an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
Possible _cpl_error_code_ set in this function:
int cpl_apertures_get_right_y | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the y position of the rightmost x position in an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
Possible _cpl_error_code_ set in this function:
int cpl_apertures_get_size | ( | const cpl_apertures * | in | ) |
Get the number of apertures.
in | a cpl_apertures object |
Possible _cpl_error_code_ set in this function:
double cpl_apertures_get_stdev | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the std dev. value of an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
int cpl_apertures_get_top | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the topmost y position in an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
Possible _cpl_error_code_ set in this function:
int cpl_apertures_get_top_x | ( | const cpl_apertures * | in, |
int | ind | ||
) |
Get the x position of the topmost y position in an aperture.
in | a cpl_apertures object |
ind | the aperture index (1 for the first one) |
Possible _cpl_error_code_ set in this function:
cpl_apertures* cpl_apertures_new_from_image | ( | const cpl_image * | in, |
const cpl_image * | lab | ||
) |
Compute statistics on selected apertures.
in | Reference image. |
lab | labelized image (type CPL_TYPE_INT) |
The returned object must be deleted using cpl_apertures_delete().
The labelized image must contain at least one pixel for each successive values from 1 to its maximum value.
For the centroiding computation of an aperture, if some pixels have values lower or equal to 0, all the values of the aperture are locally shifted such as the minimum value of the aperture has a value of epsilon. The centroid is then computed on these positive values. In principle, centroid should always be computed on positive values, this is done to avoid raising an error in case the caller of the function wants to use it on negative values images without caring about the centroid results. In such cases, the centroid result would be meaningful, but slightly depend on the hardcoded value chosen for epsilon (1e-8).
Possible _cpl_error_code_ set in this function:
cpl_error_code cpl_apertures_sort_by_flux | ( | cpl_apertures * | in | ) |
Sort by decreasing aperture flux.
in | Apertures to sort (MODIFIED) |
cpl_error_code cpl_apertures_sort_by_max | ( | cpl_apertures * | in | ) |
Sort by decreasing aperture peak value.
in | Apertures to sort (MODIFIED) |
cpl_error_code cpl_apertures_sort_by_npix | ( | cpl_apertures * | in | ) |
Sort by decreasing aperture size.
in | Apertures to sort (MODIFIED) |
Possible _cpl_error_code_ set in this function: