Main Page | Modules | Alphabetical List | Class List | Class Members

Images quality estimator routines


Functions

cpl_bivector * cpl_image_iqe (const cpl_image *in, int llx, int lly, int urx, int ury)
 Compute an image quality estimation for an object.

Detailed Description

Synopsis:
   #include "cpl_image_iqe.h"

Function Documentation

cpl_bivector* cpl_image_iqe const cpl_image *  in,
int  llx,
int  lly,
int  urx,
int  ury
 

Compute an image quality estimation for an object.

Parameters:
in the input image
llx 
lly the zone to analyse ((1, 1) for the first pixel)
urx 
ury 
Returns:
a newly allocated cpl_bivector containing the results or NULL in error case.
This function makes internal use of the iqe() MIDAS function (called here cpl_iqe()) written by P. Grosbol. The code should not be changed, it is duplicated from the MIDAS package. Refer to the MIDAS documentation for more details. This function has proven to give good results over the years when called from RTD. The goal is to provide the exact same functionality in CPL as the one provided in RTD. The code is just copied, it is not maintained by the CPL team.

The returned object must be deallocated with cpl_bivector_delete(). It contains in the first vector the computed values, and in the second one, the associated errors. The computed values are:

  • x position of the object
  • y position of the object
  • FWHM along the first axis
  • FWHM along the second axis
  • the angle of the first axis with the horizontal in degrees
  • the peak value of the object
  • the background computed

The bad pixels map of the image is not taken into account. The input image must be of type float.

Possible _cpl_error_code_ set in this function:

  • CPL_ERROR_NULL_INPUT if (one of) the input pointer(s) is NULL
  • CPL_ERROR_ILLEGAL_INPUT if the specified zone is not valid or if the computation fails on this zone
  • CPL_ERROR_TYPE_MISMATCH if the input image has the wrong type


Generated on Tue Sep 11 15:18:27 2007 for Common Pipeline Library Reference Manual by  doxygen 1.3.9.1