Result object for a single nonlinear fitting stage of the CModel algorithm. More...

#include <CModel.h>

Public Types
enum	FlagBit { FAILED =0 , TR_SMALL , MAX_ITERATIONS , NUMERIC_ERROR , BAD_REFERENCE , NO_FLUX , N_FLAGS }
	Flags for a single CModel stage (note that there are additional flags for the full multi-stage fit) More...

Public Member Functions
	CModelStageResult ()

Public Attributes
std::shared_ptr< Model >	model
	Model object that defines the parametrization (defined fully by Control struct)

std::shared_ptr< Prior >	prior
	Bayesian priors on the parameters (defined fully by Control struct)

std::shared_ptr< OptimizerObjective >	objfunc
	Objective class used by the optimizer.

std::shared_ptr< UnitTransformedLikelihood >	likelihood
	Object used to evaluate models and compare to data.

Scalar	instFlux
	Flux measured from just this stage fit.

Scalar	instFluxErr
	Flux uncertainty from just this stage fit.

Scalar	instFluxInner
	Flux measured strictly within the fit region (no extrapolation).

Scalar	objective
	Value of the objective function at the best fit point: chisq/2 - ln(prior)

Scalar	time
	Time spent in this fit in seconds.

afw::geom::ellipses::Quadrupole	ellipse
	Best fit half-light ellipse in pixel coordinates.

ndarray::Array< Scalar const, 1, 1 >	nonlinear
	Opaque nonlinear parameters in specialized units.

ndarray::Array< Scalar const, 1, 1 >	amplitudes
	Opaque linear parameters in specialized units.

ndarray::Array< Scalar const, 1, 1 >	fixed
	Opaque fixed parameters in specialized units.

afw::table::BaseCatalog	history
	Trace of the optimizer's path, if enabled by diagnostic options.

std::bitset< N_FLAGS >	flags
	Array of flags.

Detailed Description

Result object for a single nonlinear fitting stage of the CModel algorithm.

Definition at line 293 of file CModel.h.

Member Enumeration Documentation

◆ FlagBit

enum lsst::meas::modelfit::CModelStageResult::FlagBit

Flags for a single CModel stage (note that there are additional flags for the full multi-stage fit)

Enumerator
FAILED	General flag, indicating whether the flux for this stage can be trusted.
TR_SMALL	Whether convergence was due to the optimizer trust region getting too small (not a failure!)
MAX_ITERATIONS	Whether the optimizer exceeded the maximum number of iterations. Indicates a suspect fit, but not necessarily a bad one (implies FAILED).
NUMERIC_ERROR	Optimizer encountered a numerical error (something likely went to infinity). Result will be unusable; implies FAILED.
BAD_REFERENCE	Reference fit failed, so forced fit will fail as well.
NO_FLUX	No flux was measured.
N_FLAGS	Non-flag counter to indicate the number of flags.

Definition at line 296 of file CModel.h.

                 {
        FAILED=0,        
        TR_SMALL,        
        MAX_ITERATIONS,  
        NUMERIC_ERROR,   
        BAD_REFERENCE,   
        NO_FLUX,         
        N_FLAGS          
    };

Constructor & Destructor Documentation

◆ CModelStageResult()

lsst::meas::modelfit::CModelStageResult::CModelStageResult ( )

Member Data Documentation

◆ amplitudes

ndarray::Array<Scalar const,1,1> lsst::meas::modelfit::CModelStageResult::amplitudes

Opaque linear parameters in specialized units.

Definition at line 323 of file CModel.h.

◆ ellipse

afw::geom::ellipses::Quadrupole lsst::meas::modelfit::CModelStageResult::ellipse

Best fit half-light ellipse in pixel coordinates.

Definition at line 320 of file CModel.h.

◆ fixed

ndarray::Array<Scalar const,1,1> lsst::meas::modelfit::CModelStageResult::fixed

Opaque fixed parameters in specialized units.

Definition at line 324 of file CModel.h.

◆ flags

std::bitset<N_FLAGS> lsst::meas::modelfit::CModelStageResult::flags

Array of flags.

Definition at line 327 of file CModel.h.

◆ history

afw::table::BaseCatalog lsst::meas::modelfit::CModelStageResult::history

Trace of the optimizer's path, if enabled by diagnostic options.

Definition at line 326 of file CModel.h.

◆ instFlux

Scalar lsst::meas::modelfit::CModelStageResult::instFlux

Flux measured from just this stage fit.

Definition at line 315 of file CModel.h.

◆ instFluxErr

Scalar lsst::meas::modelfit::CModelStageResult::instFluxErr

Flux uncertainty from just this stage fit.

Definition at line 316 of file CModel.h.

◆ instFluxInner

Scalar lsst::meas::modelfit::CModelStageResult::instFluxInner

Flux measured strictly within the fit region (no extrapolation).

Definition at line 317 of file CModel.h.

◆ likelihood

std::shared_ptr<UnitTransformedLikelihood> lsst::meas::modelfit::CModelStageResult::likelihood

Object used to evaluate models and compare to data.

Definition at line 314 of file CModel.h.

◆ model

std::shared_ptr<Model> lsst::meas::modelfit::CModelStageResult::model

Model object that defines the parametrization (defined fully by Control struct)

Definition at line 311 of file CModel.h.

◆ nonlinear

ndarray::Array<Scalar const,1,1> lsst::meas::modelfit::CModelStageResult::nonlinear

Opaque nonlinear parameters in specialized units.

Definition at line 322 of file CModel.h.

◆ objective

Scalar lsst::meas::modelfit::CModelStageResult::objective

Value of the objective function at the best fit point: chisq/2 - ln(prior)

Definition at line 318 of file CModel.h.

◆ objfunc

std::shared_ptr<OptimizerObjective> lsst::meas::modelfit::CModelStageResult::objfunc

Objective class used by the optimizer.

Definition at line 313 of file CModel.h.

◆ prior

std::shared_ptr<Prior> lsst::meas::modelfit::CModelStageResult::prior

Bayesian priors on the parameters (defined fully by Control struct)

Definition at line 312 of file CModel.h.

◆ time

Scalar lsst::meas::modelfit::CModelStageResult::time

Time spent in this fit in seconds.

Definition at line 319 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+ea1711114f/include/lsst/meas/modelfit/CModel.h

Public Types

Public Member Functions

Public Attributes