PCL
pcl::PSFFit Class Reference

Numerical Point Spread Function (PSF) fit to a source in an image. More...

#include <PSFFit.h>

Public Types

typedef PSFData::psf_fit_status psf_fit_status
 
typedef PSFData::psf_function psf_function
 

Public Member Functions

 PSFFit (const ImageVariant &image, const DPoint &center, const DRect &rect, psf_function function=PSFunction::Gaussian, bool circular=false)
 
 PSFFit (const PSFFit &)=default
 
 PSFFit (PSFFit &&)=default
 
 operator bool () const
 
PSFFitoperator= (const PSFFit &x)=default
 
PSFFitoperator= (PSFFit &&x)=default
 

Public Attributes

PSFData psf
 

Detailed Description

Definition at line 351 of file PSFFit.h.

Member Typedef Documentation

◆ psf_fit_status

typedef PSFData::psf_fit_status pcl::PSFFit::psf_fit_status

Represents a PSF fitting process status.

Definition at line 363 of file PSFFit.h.

◆ psf_function

typedef PSFData::psf_function pcl::PSFFit::psf_function

Represents a point spread function type.

Definition at line 358 of file PSFFit.h.

Constructor & Destructor Documentation

◆ PSFFit() [1/3]

pcl::PSFFit::PSFFit ( const ImageVariant image,
const DPoint center,
const DRect rect,
psf_function  function = PSFunction::Gaussian,
bool  circular = false 
)

Fits a point spread function to a source in the specified image.

Parameters
imageThe source image.
centerThe intial search point in image coordinates. For consistent results, these coordinates must be the result of a robust object detection process.
rectThe rectangular region of the image where the function fitting process will take place. PSF parameters will be evaluated from source pixel values acquired exclusively from this region.
functionThe point spread function type to be fitted. A Gaussian PSF is fitted by default.
circularWhether to fit a circular or an elliptical PSF. Elliptical functions are fitted by default.

The implementation of the Levenberg-Marquadt algorithm used internally by this function is extremely sensitive to the specified center and rect parameters. These starting parameters should always be calculated using robust procedures to achieve consistent results.

In the most frequent use case, where a star detection procedure is typically used to obtain these starting parameters, robustness to poorly sampled data and resilience to outlier pixels and noise are particularly important to this task.

◆ PSFFit() [2/3]

pcl::PSFFit::PSFFit ( const PSFFit )
default

Copy constructor.

◆ PSFFit() [3/3]

pcl::PSFFit::PSFFit ( PSFFit &&  )
default

Move constructor.

Member Function Documentation

◆ operator bool()

pcl::PSFFit::operator bool ( ) const
inline

Returns true iff this object contains a valid PSF fit, i.e. valid PSF fitted parameters.

Definition at line 428 of file PSFFit.h.

◆ operator=() [1/2]

PSFFit& pcl::PSFFit::operator= ( const PSFFit x)
default

Copy assignment opèrator. Returns a reference to this object.

◆ operator=() [2/2]

PSFFit& pcl::PSFFit::operator= ( PSFFit &&  x)
default

Move assignment operator. Returns a reference to this object.

Member Data Documentation

◆ psf

PSFData pcl::PSFFit::psf

Fitted PSF parameters.

Definition at line 368 of file PSFFit.h.


The documentation for this class was generated from the following file: