LSSTApplications  20.0.0
LSSTDataManagementBasePackage
Public Member Functions | Public Attributes | List of all members
lsst::meas::base::SdssCentroidControl Class Reference

A C++ control class to handle SdssCentroidAlgorithm's configuration. More...

#include <SdssCentroid.h>

Public Member Functions

 SdssCentroidControl ()
 Default constructor. More...
 

Public Attributes

int binmax
 "maximum allowed binning" ; More...
 
double peakMin
 "if the peak's less than this insist on binning at least once" ; More...
 
double wfac
 "fiddle factor for adjusting the binning" ; More...
 
bool doFootprintCheck
 "Do check that the centroid is contained in footprint." ; More...
 
double maxDistToPeak
 "If set > 0, Centroid Check also checks distance from footprint peak." ; More...
 

Detailed Description

A C++ control class to handle SdssCentroidAlgorithm's configuration.

Definition at line 48 of file SdssCentroid.h.

Constructor & Destructor Documentation

◆ SdssCentroidControl()

lsst::meas::base::SdssCentroidControl::SdssCentroidControl ( )
inline

Default constructor.

All control classes should define a default constructor that sets all fields to their default values.

Definition at line 62 of file SdssCentroid.h.

63  : binmax(16), peakMin(-1.0), wfac(1.5), doFootprintCheck(true), maxDistToPeak(-1.0) {}

Member Data Documentation

◆ binmax

int lsst::meas::base::SdssCentroidControl::binmax

"maximum allowed binning" ;

Definition at line 50 of file SdssCentroid.h.

◆ doFootprintCheck

bool lsst::meas::base::SdssCentroidControl::doFootprintCheck

"Do check that the centroid is contained in footprint." ;

Definition at line 53 of file SdssCentroid.h.

◆ maxDistToPeak

double lsst::meas::base::SdssCentroidControl::maxDistToPeak

"If set > 0, Centroid Check also checks distance from footprint peak." ;

Definition at line 55 of file SdssCentroid.h.

◆ peakMin

double lsst::meas::base::SdssCentroidControl::peakMin

"if the peak's less than this insist on binning at least once" ;

Definition at line 51 of file SdssCentroid.h.

◆ wfac

double lsst::meas::base::SdssCentroidControl::wfac

"fiddle factor for adjusting the binning" ;

Definition at line 52 of file SdssCentroid.h.


The documentation for this class was generated from the following file:
lsst::meas::base::SdssCentroidControl::maxDistToPeak
double maxDistToPeak
"If set > 0, Centroid Check also checks distance from footprint peak." ;
Definition: SdssCentroid.h:55
lsst::meas::base::SdssCentroidControl::wfac
double wfac
"fiddle factor for adjusting the binning" ;
Definition: SdssCentroid.h:52
lsst::meas::base::SdssCentroidControl::doFootprintCheck
bool doFootprintCheck
"Do check that the centroid is contained in footprint." ;
Definition: SdssCentroid.h:53
lsst::meas::base::SdssCentroidControl::binmax
int binmax
"maximum allowed binning" ;
Definition: SdssCentroid.h:50
lsst::meas::base::SdssCentroidControl::peakMin
double peakMin
"if the peak's less than this insist on binning at least once" ;
Definition: SdssCentroid.h:51