Struct CModelStageResult¶

Defined in File CModel.h

Struct Documentation¶

struct CModelStageResult

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

Public Types

enum FlagBit¶

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

Values:

FAILED = 0¶: 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.

N_FLAGS¶: Non-flag counter to indicate the number of flags.

Public Functions

CModelStageResult()¶

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

PTR(Prior)¶: Bayesian priors on the parameters (defined fully by Control struct)

PTR(OptimizerObjective)¶: Objective class used by the optimizer.

PTR(UnitTransformedLikelihood)¶: Object used to evaluate models and compare to data.

Public Members

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.