LSSTApplications  20.0.0
LSSTDataManagementBasePackage
Public Member Functions | Public Attributes | List of all members
lsst::meas::extensions::photometryKron::KronFluxControl Class Reference

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" ; More...
 
double nSigmaForRadius
 "Multiplier of rms size for aperture used to initially estimate the Kron radius" ; More...
 
int nIterForRadius
 "Number of times to iterate when setting the Kron radius" ; More...
 
double nRadiusForFlux
 "Number of Kron radii for Kron flux" ; More...
 
double maxSincRadius
 "Largest aperture for which to use the slow, accurate, sinc aperture code" ; More...
 
double minimumRadius
 "Minimum Kron radius (if == 0.0 use PSF's Kron radius) if enforceMinimumRadius. " "Also functions as fallback aperture radius if set." ; More...
 
bool enforceMinimumRadius
 "If true check that the Kron radius exceeds some minimum" ; More...
 
bool useFootprintRadius
 "Use the Footprint size as part of initial estimate of Kron radius" ; More...
 
double smoothingSigma
 "Smooth image with N(0, smoothingSigma^2) Gaussian while estimating R_K" ; More...
 
std::string refRadiusName
 "Name of field specifying reference Kron radius for forced measurement" ; More...
 

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 70 of file photometryKron.h.

70  :
71  fixed(false),
72  nSigmaForRadius(6.0),
73  nIterForRadius(1),
74  nRadiusForFlux(2.5),
75  maxSincRadius(10.0),
76  minimumRadius(0.0),
78  useFootprintRadius(false),
79  smoothingSigma(-1.0),
80  refRadiusName("ext_photometryKron_KronFlux_radius")
81  {}

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.

◆ 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:
lsst::meas::extensions::photometryKron::KronFluxControl::minimumRadius
double minimumRadius
"Minimum Kron radius (if == 0.0 use PSF's Kron radius) if enforceMinimumRadius. " "Also functions as ...
Definition: photometryKron.h:61
lsst::meas::extensions::photometryKron::KronFluxControl::fixed
bool fixed
"if true, use existing shape and centroid measurements instead of fitting" ;
Definition: photometryKron.h:52
lsst::meas::extensions::photometryKron::KronFluxControl::nSigmaForRadius
double nSigmaForRadius
"Multiplier of rms size for aperture used to initially estimate the Kron radius" ;
Definition: photometryKron.h:54
lsst::meas::extensions::photometryKron::KronFluxControl::nRadiusForFlux
double nRadiusForFlux
"Number of Kron radii for Kron flux" ;
Definition: photometryKron.h:56
lsst::meas::extensions::photometryKron::KronFluxControl::useFootprintRadius
bool useFootprintRadius
"Use the Footprint size as part of initial estimate of Kron radius" ;
Definition: photometryKron.h:64
lsst::meas::extensions::photometryKron::KronFluxControl::enforceMinimumRadius
bool enforceMinimumRadius
"If true check that the Kron radius exceeds some minimum" ;
Definition: photometryKron.h:62
lsst::meas::extensions::photometryKron::KronFluxControl::refRadiusName
std::string refRadiusName
"Name of field specifying reference Kron radius for forced measurement" ;
Definition: photometryKron.h:68
lsst::meas::extensions::photometryKron::KronFluxControl::maxSincRadius
double maxSincRadius
"Largest aperture for which to use the slow, accurate, sinc aperture code" ;
Definition: photometryKron.h:58
lsst::meas::extensions::photometryKron::KronFluxControl::nIterForRadius
int nIterForRadius
"Number of times to iterate when setting the Kron radius" ;
Definition: photometryKron.h:55
lsst::meas::extensions::photometryKron::KronFluxControl::smoothingSigma
double smoothingSigma
"Smooth image with N(0, smoothingSigma^2) Gaussian while estimating R_K" ;
Definition: photometryKron.h:66