Nested control object for CModel that configures one of the three ("initial", "exp", "dev") nonlinear fitting stages. More...

#include <CModel.h>

Public Member Functions
	CModelStageControl ()

shapelet::RadialProfile const &	getProfile () const

std::shared_ptr< Model >	getModel () const

std::shared_ptr< Prior >	getPrior () const

Public Attributes
std::string	profileName
	"Name of the shapelet.RadialProfile that defines the model to fit" ;

std::string	priorSource
	"One of 'FILE', 'LINEAR', 'EMPIRICAL', or 'NONE', indicating whether the prior should be loaded " "from disk, created from one of the nested prior config/control objects, or None" ;

std::string	priorName
	"Name of the Prior that defines the model to fit (a filename in $MEAS_MODELFIT_DIR/data, " "with no extension), if priorSource='FILE'. Ignored for forced fitting." ;

SoftenedLinearPriorControl	linearPriorConfig
	"Configuration for a linear prior, used if priorSource='LINEAR'." ;

SemiEmpiricalPriorControl	empiricalPriorConfig
	"Configuration for an empirical prior, used if priorSource='EMPIRICAL'." ;

int	nComponents
	"Number of Gaussian used to approximate the profile" ;

int	maxRadius
	"Maximum radius used in approximating profile with Gaussians (0=default for this profile)" ;

bool	usePixelWeights
	"Use per-pixel variances as weights in the nonlinear fit (the final linear fit for" " flux never uses per-pixel variances)" ;

double	weightsMultiplier
	"Scale the likelihood by this factor to artificially reweight it w.r.t. the prior." ;

OptimizerControl	optimizer
	"Configuration for how the objective surface is explored. Ignored for forced fitting" ;

bool	doRecordHistory
	"Whether to record the steps the optimizer takes (or just the number, if running as a plugin)" ;

bool	doRecordTime
	"Whether to record the time spent in this stage" ;

Detailed Description

Nested control object for CModel that configures one of the three ("initial", "exp", "dev") nonlinear fitting stages.

Definition at line 142 of file CModel.h.

Constructor & Destructor Documentation

◆ CModelStageControl()

lsst::meas::modelfit::CModelStageControl::CModelStageControl ( )

inline

Definition at line 144 of file CModel.h.

                         :
        profileName("lux"),
        priorSource("EMPIRICAL"),
        priorName(),
        nComponents(8),
        maxRadius(0),
        usePixelWeights(false),
        weightsMultiplier(1.0),
        doRecordHistory(true),
        doRecordTime(true)
    {}

Member Function Documentation

◆ getModel()

std::shared_ptr< Model > lsst::meas::modelfit::CModelStageControl::getModel ( ) const

◆ getPrior()

std::shared_ptr< Prior > lsst::meas::modelfit::CModelStageControl::getPrior ( ) const

◆ getProfile()

shapelet::RadialProfile const & lsst::meas::modelfit::CModelStageControl::getProfile ( ) const

inline

Definition at line 156 of file CModel.h.

                                                     {
        return shapelet::RadialProfile::get(profileName);
    }

Member Data Documentation

◆ doRecordHistory

bool lsst::meas::modelfit::CModelStageControl::doRecordHistory

"Whether to record the steps the optimizer takes (or just the number, if running as a plugin)" ;

Definition at line 220 of file CModel.h.

◆ doRecordTime

bool lsst::meas::modelfit::CModelStageControl::doRecordTime

"Whether to record the time spent in this stage" ;

Definition at line 225 of file CModel.h.

◆ empiricalPriorConfig

SemiEmpiricalPriorControl lsst::meas::modelfit::CModelStageControl::empiricalPriorConfig

"Configuration for an empirical prior, used if priorSource='EMPIRICAL'." ;

Definition at line 189 of file CModel.h.

◆ linearPriorConfig

SoftenedLinearPriorControl lsst::meas::modelfit::CModelStageControl::linearPriorConfig

"Configuration for a linear prior, used if priorSource='LINEAR'." ;

Definition at line 184 of file CModel.h.

◆ maxRadius

int lsst::meas::modelfit::CModelStageControl::maxRadius

"Maximum radius used in approximating profile with Gaussians (0=default for this profile)" ;

Definition at line 197 of file CModel.h.

◆ nComponents

int lsst::meas::modelfit::CModelStageControl::nComponents

"Number of Gaussian used to approximate the profile" ;

Definition at line 191 of file CModel.h.

◆ optimizer

OptimizerControl lsst::meas::modelfit::CModelStageControl::optimizer

"Configuration for how the objective surface is explored. Ignored for forced fitting" ;

Definition at line 215 of file CModel.h.

◆ priorName

std::string lsst::meas::modelfit::CModelStageControl::priorName

"Name of the Prior that defines the model to fit (a filename in $MEAS_MODELFIT_DIR/data, " "with no extension), if priorSource='FILE'. Ignored for forced fitting." ;

Definition at line 179 of file CModel.h.

◆ priorSource

std::string lsst::meas::modelfit::CModelStageControl::priorSource

"One of 'FILE', 'LINEAR', 'EMPIRICAL', or 'NONE', indicating whether the prior should be loaded " "from disk, created from one of the nested prior config/control objects, or None" ;

Definition at line 173 of file CModel.h.

◆ profileName

std::string lsst::meas::modelfit::CModelStageControl::profileName

"Name of the shapelet.RadialProfile that defines the model to fit" ;

Definition at line 167 of file CModel.h.

◆ usePixelWeights

bool lsst::meas::modelfit::CModelStageControl::usePixelWeights

"Use per-pixel variances as weights in the nonlinear fit (the final linear fit for" " flux never uses per-pixel variances)" ;

Definition at line 204 of file CModel.h.

◆ weightsMultiplier

double lsst::meas::modelfit::CModelStageControl::weightsMultiplier

"Scale the likelihood by this factor to artificially reweight it w.r.t. the prior." ;

Definition at line 210 of file CModel.h.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_modelfit/g591dd9f2cf+df404f777f/include/lsst/meas/modelfit/CModel.h

Public Member Functions

Public Attributes