Common Pipeline Library Reference Manual  5.3.1
Functions
High-level functions that uses apertures

Functions

cpl_bivector * cpl_apertures_get_fwhm (const cpl_image *in, const cpl_apertures *aperts)
 Compute FWHM values in x and y for a list of apertures.

Function Documentation

cpl_bivector* cpl_apertures_get_fwhm ( const cpl_image *  in,
const cpl_apertures *  aperts 
)

Compute FWHM values in x and y for a list of apertures.

Parameters:
inthe input image
apertsthe list of apertures
Returns:
A newly allocated object containing the fwhms in x and y or NULL
See also:
cpl_image_get_fwhm()
Note:
On success the created cpl_bivector must be deallocated with cpl_bivector_delete().

Possible _cpl_error_code_ set in this function:

  • CPL_ERROR_NULL_INPUT if an input pointer is NULL
  • CPL_ERROR_ILLEGAL_INPUT if the number of apertures is lower than 1
  • CPL_ERROR_DATA_NOT_FOUND if no aperture has a valid FWHM
  • CPL_ERROR_ACCESS_OUT_OF_RANGE if an aperture specifies a pixel outside the image size range