LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
LSSTDataManagementBasePackage
Public Member Functions | Public Attributes | List of all members
lsst::meas::modelfit::CModelStageControl Struct Reference

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
 
boost::shared_ptr< ModelgetModel () const
 
boost::shared_ptr< PriorgetPrior () const
 

Public Attributes

std::string profileName
 "Name of the shapelet.RadialProfile that defines the model to fit" ; More...
 
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" ; More...
 
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." ; More...
 
SoftenedLinearPriorControl linearPriorConfig
 "Configuration for a linear prior, used if priorSource='LINEAR'." ; More...
 
SemiEmpiricalPriorControl empiricalPriorConfig
 "Configuration for an empirical prior, used if priorSource='EMPIRICAL'." ; More...
 
int nComponents
 "Number of Gaussian used to approximate the profile" ; More...
 
int maxRadius
 "Maximum radius used in approximating profile with Gaussians (0=default for this profile)" ; More...
 
bool usePixelWeights
 "Use per-pixel variances as weights in the nonlinear fit (the final linear fit for" " flux never uses per-pixel variances)" ; More...
 
double weightsMultiplier
 "Scale the likelihood by this factor to artificially reweight it w.r.t. the prior." ; More...
 
OptimizerControl optimizer
 "Configuration for how the objective surface is explored. Ignored for forced fitting" ; More...
 
bool doRecordHistory
 "Whether to record the steps the optimizer takes (or just the number, if running as a plugin)" ; More...
 
bool doRecordTime
 "Whether to record the time spent in this stage" ; More...
 

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.

144  :
145  profileName("lux"),
146  priorSource("EMPIRICAL"),
147  priorName(),
148  nComponents(8),
149  maxRadius(0),
150  usePixelWeights(false),
151  weightsMultiplier(1.0),
152  doRecordHistory(true),
153  doRecordTime(true)
154  {}

Member Function Documentation

◆ getModel()

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

◆ getPrior()

boost::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.

156  {
158  }

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:
lsst::meas::modelfit::CModelStageControl::usePixelWeights
bool usePixelWeights
"Use per-pixel variances as weights in the nonlinear fit (the final linear fit for" " flux never uses...
Definition: CModel.h:204
lsst::meas::modelfit::CModelStageControl::priorName
std::string priorName
"Name of the Prior that defines the model to fit (a filename in $MEAS_MODELFIT_DIR/data,...
Definition: CModel.h:179
lsst::meas::modelfit::CModelStageControl::weightsMultiplier
double weightsMultiplier
"Scale the likelihood by this factor to artificially reweight it w.r.t. the prior....
Definition: CModel.h:210
lsst::meas::modelfit::CModelStageControl::priorSource
std::string priorSource
"One of 'FILE', 'LINEAR', 'EMPIRICAL', or 'NONE', indicating whether the prior should be loaded " "fr...
Definition: CModel.h:173
lsst::meas::modelfit::CModelStageControl::profileName
std::string profileName
"Name of the shapelet.RadialProfile that defines the model to fit" ;
Definition: CModel.h:167
lsst::meas::modelfit::CModelStageControl::doRecordHistory
bool doRecordHistory
"Whether to record the steps the optimizer takes (or just the number, if running as a plugin)" ;
Definition: CModel.h:220
lsst::meas::modelfit::CModelStageControl::maxRadius
int maxRadius
"Maximum radius used in approximating profile with Gaussians (0=default for this profile)" ;
Definition: CModel.h:197
lsst::meas::modelfit::CModelStageControl::nComponents
int nComponents
"Number of Gaussian used to approximate the profile" ;
Definition: CModel.h:191
lsst::meas::modelfit::CModelStageControl::doRecordTime
bool doRecordTime
"Whether to record the time spent in this stage" ;
Definition: CModel.h:225
lsst::shapelet::RadialProfile::get
static RadialProfile & get(std::string const &name)
Return a predefined radial profile given its name.