lsst::meas::base::SdssShapeControl Class Reference

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

#include <SdssShape.h>

Public Member Functions
	SdssShapeControl ()
	Default constructor. More...

Public Attributes
double	background
	"Additional value to add to background" ; More...
int	maxIter
	"Maximum number of iterations" ; More...
double	maxShift
	"Maximum centroid shift, limited to 2-10" ; More...
float	tol1
	"Convergence tolerance for e1,e2" ; More...
float	tol2
	"Convergence tolerance for FWHM" ; More...

Detailed Description

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

In C++, we define Control objects to handle configuration information. Using the LSST_CONTROL_FIELD macro and lsst.pex.config.wrap.makeConfigClass, we can turn these into more full-featured Config classes in Python. While the user will usually interact with the Config class, the plugin wrapper system will turn Config instances into Control instances when passing them to C++.

This should logically be an inner class, but Swig doesn't know how to parse those.

Definition at line 46 of file SdssShape.h.

Constructor & Destructor Documentation

lsst::meas::base::SdssShapeControl::SdssShapeControl ( )

inline

Default constructor.

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

Definition at line 55 of file SdssShape.h.

: background(0.0), maxIter(100), maxShift(), tol1(1E-5), tol2(1E-4) {}

Member Data Documentation

double lsst::meas::base::SdssShapeControl::background

"Additional value to add to background" ;

Definition at line 48 of file SdssShape.h.

int lsst::meas::base::SdssShapeControl::maxIter

"Maximum number of iterations" ;

Definition at line 49 of file SdssShape.h.

double lsst::meas::base::SdssShapeControl::maxShift

"Maximum centroid shift, limited to 2-10" ;

Definition at line 50 of file SdssShape.h.

float lsst::meas::base::SdssShapeControl::tol1

"Convergence tolerance for e1,e2" ;

Definition at line 51 of file SdssShape.h.

float lsst::meas::base::SdssShapeControl::tol2

"Convergence tolerance for FWHM" ;

Definition at line 52 of file SdssShape.h.

---

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

• /home/lsstsw/stack/Linux64/meas_base/11.0.rc2+12/include/lsst/meas/base/SdssShape.h