Estimation of relative image scale based on PSF photometry. More...
#include <PSFScaleEstimator.h>
Inheritance diagram for pcl::PSFScaleEstimator:
Classes | |
| struct | Estimates |
| Structure to hold a PSF relative scale estimate. More... | |
Public Types | |
| using | psf_function = PSFEstimator::psf_function |
| Public Types inherited from pcl::PSFEstimator | |
| using | psf_function = StarDetector::psf_function |
Detailed Description
- See also
- PSFEstimator, PSFSignalEstimator, StarDetector, PSFFit
Definition at line 72 of file PSFScaleEstimator.h.
Member Typedef Documentation
◆ psf_function
| using pcl::PSFScaleEstimator::psf_function = PSFEstimator::psf_function |
Represents a point spread function type.
Definition at line 79 of file PSFScaleEstimator.h.
Constructor & Destructor Documentation
◆ PSFScaleEstimator() [1/2]
|
default |
Default constructor.
◆ PSFScaleEstimator() [2/2]
|
default |
Copy constructor.
◆ ~PSFScaleEstimator()
|
inlineoverride |
Destroys a PSFScaleEstimator object.
Definition at line 125 of file PSFScaleEstimator.h.
Member Function Documentation
◆ DisableLocalModel()
|
inline |
Disables generation of local scale variation models.
Definition at line 233 of file PSFScaleEstimator.h.
◆ EnableLocalModel()
|
inline |
Enables generation of local scale variation models.
Definition at line 225 of file PSFScaleEstimator.h.
◆ EstimateScale()
| Estimates pcl::PSFScaleEstimator::EstimateScale | ( | const ImageVariant & | image | ) | const |
Evaluates the mean relative scaling factor of the currently selected reference image with respect to the specified target image.
A successful call to SetReference() is required to select a reference image before calling this function; otherwise an Error exception will be thrown. The specified target image must be accurately registered with respect to the reference image.
The returned object contains the estimated mean ratio of the reference signal to the target signal, as well as the number of PSF measurements used for scale evaluation. All PSF signal measurements exclude local background estimates.
- Note
- This function is thread-safe.
◆ IsLocalModelEnabled()
|
inline |
Returns true iff generation of models of local relative scale variations is enabled for this object.
When this option is enabled, local scale variations are modeled with an approximating thin plate spline during relative scale estimation. This feature is disabled by default.
Definition at line 217 of file PSFScaleEstimator.h.
◆ operator()()
|
inline |
Evaluates the mean relative scaling factor of the currently selected reference image with respect to the specified target image.
This operator is equivalent to the EstimateScale( const ImageVariant& ) const member function.
- Note
- This function is thread-safe.
Definition at line 265 of file PSFScaleEstimator.h.
◆ operator=()
|
default |
Copy assignment operator. Returns a reference to this object.
◆ PSFSearchTolerance()
|
inline |
Returns the search tolerance in pixels.
For evaluation of relative scale finding a set of matched pairs of PSF measurements, i.e. matched stars, is necessary to ensure robustness of the computed scale estimate. The search tolerance is the half side in pixels of a square region around each fitted PSF used to find matched pairs of stars by proximity search.
In theory a very small search tolerance (about 0.01 - 0.05 pixels, depending on the scale of the image) should be applicable, since the reference and target images are assumed to be registered and our standard image registration processes, such as StarAlignment for example, sport centipixel accuracy. However, in practice we may have to deal with larger registration errors, especially for wide field images if the user has not defined the necessary parameters to apply distortion corrections.
The default search tolerance is 4 pixels.
Definition at line 153 of file PSFScaleEstimator.h.
◆ RejectionLimit()
|
inline |
Returns the limit for the altered Chauvenet rejection criterion.
A Robust Chauvenet Rejection (RCR) routine is used internally by this implementation for rejection of outlier relative scale samples. The larger the value of this parameter, the more samples will be rejected by the RCR algorithm. The original Chauvenet rejection criterion is N*P(x > |z|) < 0.5, where N is the number of measurements and P() represents the probability of x being more than z standard deviations from the mean. This parameter alters the rejection criterion by replacing 0.5 with an arbitrary limit in the [0,1] range, in order to make the algorithm controllable. The default rejection limit is 0.3.
Definition at line 181 of file PSFScaleEstimator.h.
◆ SetPSFSearchTolerance()
|
inline |
Sets the search tolerance in pixels. See PSFSearchTolerance() for a description of this parameter.
Definition at line 162 of file PSFScaleEstimator.h.
References pcl::Max().
◆ SetReference()
| int pcl::PSFScaleEstimator::SetReference | ( | const ImageVariant & | image | ) |
Sets a new reference image for relative scale estimation.
This function performs the star detection and PSF fitting tasks for the specified image. The resulting set of PSF signal measurements will be stored in this object for relative scale evaluation by subsequent calls to EstimateScale().
Returns the number of valid PSF signal measurements gathered for the specified reference image.
◆ SetRejectionLimit()
|
inline |
Sets the limit for the altered Chauvenet rejection criterion. See RejectionLimit() for a description of this parameter.
Definition at line 190 of file PSFScaleEstimator.h.
References pcl::Range().
The documentation for this class was generated from the following file:
