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

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

#include <PsfFlux.h>

Public Member Functions

 PsfFluxControl ()
 Default constructor. More...
 

Public Attributes

std::vector< std::stringbadMaskPlanes
 "Mask planes that indicate pixels that should be excluded from the fit" ; More...
 

Detailed Description

A C++ control class to handle PsfFluxAlgorithm'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 48 of file PsfFlux.h.

Constructor & Destructor Documentation

◆ PsfFluxControl()

lsst::meas::base::PsfFluxControl::PsfFluxControl ( )
inline

Default constructor.

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

Definition at line 58 of file PsfFlux.h.

58 {}

Member Data Documentation

◆ badMaskPlanes

std::vector<std::string> lsst::meas::base::PsfFluxControl::badMaskPlanes

"Mask planes that indicate pixels that should be excluded from the fit" ;

Definition at line 51 of file PsfFlux.h.


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