LSST Applications g2079a07aa2+86d27d4dc4,g2305ad1205+a659bff248,g2bbee38e9b+3c60f8fe34,g337abbeb29+3c60f8fe34,g33d1c0ed96+3c60f8fe34,g3502564af9+d77d6d1350,g3a166c0a6a+3c60f8fe34,g487adcacf7+25d9892218,g4be5004598+d77d6d1350,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+4d81263f9a,g5cd07815a0+980d2b1c3b,g607f77f49a+d77d6d1350,g858d7b2824+d77d6d1350,g88963caddf+83e433e629,g99cad8db69+a4d3c48eeb,g9ddcbc5298+9a081db1e4,ga1e77700b3+bcf1af89ad,ga57fefb910+9a39d7b2d7,gae0086650b+585e252eca,gb065fddaf9+4f9fd82a2c,gb0e22166c9+60f28cb32d,gb363559e06+d84b1d3d07,gb3b7280ab2+4563d032e1,gb4b16eec92+babe958938,gba4ed39666+c2a2e4ac27,gbb8dafda3b+ed6854b564,gc120e1dc64+b72d212f87,gc28159a63d+3c60f8fe34,gc3e9b769f7+921dbcd359,gcf0d15dbbd+9a39d7b2d7,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+3c60f8fe34,w.2024.21
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
 
std::shared_ptr< ModelgetModel () const
 
std::shared_ptr< PriorgetPrior () 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.

144 :
145 profileName("lux"),
146 priorSource("EMPIRICAL"),
147 priorName(),
148 nComponents(8),
149 maxRadius(0),
150 usePixelWeights(false),
152 doRecordHistory(true),
153 doRecordTime(true)
154 {}
std::string profileName
"Name of the shapelet.RadialProfile that defines the model to fit" ;
Definition CModel.h:167
int nComponents
"Number of Gaussian used to approximate the profile" ;
Definition CModel.h:191
std::string priorName
"Name of the Prior that defines the model to fit (a filename in $MEAS_MODELFIT_DIR/data,...
Definition CModel.h:179
bool doRecordTime
"Whether to record the time spent in this stage" ;
Definition CModel.h:225
bool usePixelWeights
"Use per-pixel variances as weights in the nonlinear fit (the final linear fit for" " flux never uses...
Definition CModel.h:204
bool doRecordHistory
"Whether to record the steps the optimizer takes (or just the number, if running as a plugin)" ;
Definition CModel.h:220
int maxRadius
"Maximum radius used in approximating profile with Gaussians (0=default for this profile)" ;
Definition CModel.h:197
double weightsMultiplier
"Scale the likelihood by this factor to artificially reweight it w.r.t. the prior....
Definition CModel.h:210
std::string priorSource
"One of 'FILE', 'LINEAR', 'EMPIRICAL', or 'NONE', indicating whether the prior should be loaded " "fr...
Definition CModel.h:173

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.

156 {
158 }
static RadialProfile & get(std::string const &name)
Return a predefined radial profile given its name.

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: