C++ control object for Kron flux. More...

#include <photometryKron.h>

Public Member Functions
	KronFluxControl ()

Public Attributes
bool	fixed
	"if true, use existing shape and centroid measurements instead of fitting" ;

double	nSigmaForRadius
	"Multiplier of rms size for aperture used to initially estimate the Kron radius" ;

int	nIterForRadius
	"Number of times to iterate when setting the Kron radius" ;

double	nRadiusForFlux
	"Number of Kron radii for Kron flux" ;

double	maxSincRadius
	"Largest aperture for which to use the slow, accurate, sinc aperture code" ;

double	minimumRadius
	"Minimum Kron radius (if == 0.0 use PSF's Kron radius) if enforceMinimumRadius. " "Also functions as fallback aperture radius if set." ;

bool	enforceMinimumRadius
	"If true check that the Kron radius exceeds some minimum" ;

bool	useFootprintRadius
	"Use the Footprint size as part of initial estimate of Kron radius" ;

double	smoothingSigma
	"Smooth image with N(0, smoothingSigma^2) Gaussian while estimating R_K" ;

std::string	refRadiusName
	"Name of field specifying reference Kron radius for forced measurement" ;

double	maxRadius
	"Maximum aperture radius in pixels; used to avoid excess memory consumption for faint objects" ;

Detailed Description

C++ control object for Kron flux.

See also: KronFluxConfig.

Definition at line 48 of file photometryKron.h.

Constructor & Destructor Documentation

◆ KronFluxControl()

lsst::meas::extensions::photometryKron::KronFluxControl::KronFluxControl ( )

inline

Definition at line 72 of file photometryKron.h.

                      :
        fixed(false),
        nSigmaForRadius(6.0),
        nIterForRadius(1),
        nRadiusForFlux(2.5),
        maxSincRadius(10.0),
        minimumRadius(0.0),
        enforceMinimumRadius(true),
        useFootprintRadius(false),
        smoothingSigma(-1.0),
        refRadiusName("ext_photometryKron_KronFlux_radius"),
        maxRadius(200.0)
    {}

Member Data Documentation

◆ enforceMinimumRadius

bool lsst::meas::extensions::photometryKron::KronFluxControl::enforceMinimumRadius

"If true check that the Kron radius exceeds some minimum" ;

Definition at line 62 of file photometryKron.h.

◆ fixed

bool lsst::meas::extensions::photometryKron::KronFluxControl::fixed

"if true, use existing shape and centroid measurements instead of fitting" ;

Definition at line 52 of file photometryKron.h.

◆ maxRadius

double lsst::meas::extensions::photometryKron::KronFluxControl::maxRadius

"Maximum aperture radius in pixels; used to avoid excess memory consumption for faint objects" ;

Definition at line 70 of file photometryKron.h.

◆ maxSincRadius

double lsst::meas::extensions::photometryKron::KronFluxControl::maxSincRadius

"Largest aperture for which to use the slow, accurate, sinc aperture code" ;

Definition at line 58 of file photometryKron.h.

◆ minimumRadius

double lsst::meas::extensions::photometryKron::KronFluxControl::minimumRadius

"Minimum Kron radius (if == 0.0 use PSF's Kron radius) if enforceMinimumRadius. " "Also functions as fallback aperture radius if set." ;

Definition at line 61 of file photometryKron.h.

◆ nIterForRadius

int lsst::meas::extensions::photometryKron::KronFluxControl::nIterForRadius

"Number of times to iterate when setting the Kron radius" ;

Definition at line 55 of file photometryKron.h.

◆ nRadiusForFlux

double lsst::meas::extensions::photometryKron::KronFluxControl::nRadiusForFlux

"Number of Kron radii for Kron flux" ;

Definition at line 56 of file photometryKron.h.

◆ nSigmaForRadius

double lsst::meas::extensions::photometryKron::KronFluxControl::nSigmaForRadius

"Multiplier of rms size for aperture used to initially estimate the Kron radius" ;

Definition at line 54 of file photometryKron.h.

◆ refRadiusName

std::string lsst::meas::extensions::photometryKron::KronFluxControl::refRadiusName

"Name of field specifying reference Kron radius for forced measurement" ;

Definition at line 68 of file photometryKron.h.

◆ smoothingSigma

double lsst::meas::extensions::photometryKron::KronFluxControl::smoothingSigma

"Smooth image with N(0, smoothingSigma^2) Gaussian while estimating R_K" ;

Definition at line 66 of file photometryKron.h.

◆ useFootprintRadius

bool lsst::meas::extensions::photometryKron::KronFluxControl::useFootprintRadius

"Use the Footprint size as part of initial estimate of Kron radius" ;

Definition at line 64 of file photometryKron.h.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_extensions_photometryKron/g858d7b2824+fa3a7a026e/include/lsst/meas/extensions/photometryKron.h

Public Member Functions

Public Attributes