Struct CModelResult

Struct Documentation

struct CModelResult

Master result object for CModel, containing results for the final linear fit and three nested CModelStageResult objects for the results of the previous stages.

Public Types

enum FlagBit

Flags that apply to all four CModel fits or just the last one.

Values:

FAILED = 0

General failure flag for the linear fit flux; set if any other CModel flag is set, or if any of the three previous stages failed.

REGION_MAX_AREA

Set if we aborted early because the fit region was too large.

REGION_MAX_BAD_PIXEL_FRACTION

Set if we aborted early because the fit region had too many bad pixels.

REGION_USED_FOOTPRINT_AREA

Kron radius was unavailable or outside bounds, so the second-moment ellipse scaled to the footprint area was used instead.

REGION_USED_PSF_AREA

Kron radius was unavailable or outside bounds, so the second-moment ellipse scaled to the PSF area was used instead.

REGION_USED_INITIAL_ELLIPSE_MIN

Fit region implied by the best-fit ellipse of the initial was too small, so we used the configuration minimum instead.

REGION_USED_INITIAL_ELLIPSE_MAX

Fit region implied by the best-fit ellipse of the initial was too large, so we used the configuration maximum instead.

NO_SHAPE

Set if the input SourceRecord had no valid shape slot with which to start the fit.

SMALL_SHAPE

Initial moments were sufficiently small that we used minInitialRadius to set the initial parameters.

NO_SHAPELET_PSF

Set if the Psf shapelet approximation failed.

BAD_CENTROID

Input centroid did not land within the fit region.

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

CModelResult()

Public Members

Scalar instFlux

Flux from the final linear fit.

Scalar instFluxErr

Flux uncertainty from the final linear fit.

Scalar instFluxInner

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

Scalar fracDev

Fraction of flux from the final linear fit in the de Vaucouleur component (always between 0 and 1).

Scalar objective

Objective value at the best-fit point (chisq/2)

CModelStageResult initial

Results from the initial approximate nonlinear fit that feeds the others.

CModelStageResult exp

Results from the exponential (Sersic n=1) fit.

CModelStageResult dev

Results from the de Vaucouleur (Sersic n=4) fit.

afw::geom::ellipses::Quadrupole initialFitRegion

Pixels used in the initial fit.

afw::geom::ellipses::Quadrupole finalFitRegion

Pixels used in the exp, dev, and linear fits.

LocalUnitTransform fitSysToMeasSys

Transforms to the coordinate system where parameters are defined.

std::bitset<N_FLAGS> flags

Array of flags.