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

#include <CModel.h>

Public Types
enum	FlagBit { FAILED =0 , REGION_MAX_AREA , REGION_MAX_BAD_PIXEL_FRACTION , REGION_USED_FOOTPRINT_AREA , REGION_USED_PSF_AREA , REGION_USED_INITIAL_ELLIPSE_MIN , REGION_USED_INITIAL_ELLIPSE_MAX , NO_SHAPE , SMALL_SHAPE , NO_SHAPELET_PSF , BAD_CENTROID , BAD_REFERENCE , NO_FLUX , N_FLAGS }
	Flags that apply to all four CModel fits or just the last one. More...

Public Member Functions
	CModelResult ()

Public Attributes
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.

Detailed Description

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

Definition at line 334 of file CModel.h.

Member Enumeration Documentation

◆ FlagBit

enum lsst::meas::modelfit::CModelResult::FlagBit

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

Enumerator
FAILED	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.
NO_FLUX	No flux was measured.
N_FLAGS	Non-flag counter to indicate the number of flags.

Definition at line 337 of file CModel.h.

                 {
        FAILED=0,                
        REGION_MAX_AREA,                  
        REGION_MAX_BAD_PIXEL_FRACTION,    
        REGION_USED_FOOTPRINT_AREA,       
        REGION_USED_PSF_AREA,             
        REGION_USED_INITIAL_ELLIPSE_MIN,  
        REGION_USED_INITIAL_ELLIPSE_MAX,  
        NO_SHAPE,                
        SMALL_SHAPE,             
        NO_SHAPELET_PSF,         
        BAD_CENTROID,            
        BAD_REFERENCE,           
        NO_FLUX,                 
        N_FLAGS                  
    };

Constructor & Destructor Documentation

◆ CModelResult()

lsst::meas::modelfit::CModelResult::CModelResult ( )

Member Data Documentation

◆ dev

CModelStageResult lsst::meas::modelfit::CModelResult::dev

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

Definition at line 374 of file CModel.h.

◆ exp

CModelStageResult lsst::meas::modelfit::CModelResult::exp

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

Definition at line 373 of file CModel.h.

◆ finalFitRegion

afw::geom::ellipses::Quadrupole lsst::meas::modelfit::CModelResult::finalFitRegion

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

Definition at line 377 of file CModel.h.

◆ fitSysToMeasSys

LocalUnitTransform lsst::meas::modelfit::CModelResult::fitSysToMeasSys

Transforms to the coordinate system where parameters are defined.

Definition at line 379 of file CModel.h.

◆ flags

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

Array of flags.

Definition at line 380 of file CModel.h.

◆ fracDev

Scalar lsst::meas::modelfit::CModelResult::fracDev

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

Definition at line 368 of file CModel.h.

◆ initial

CModelStageResult lsst::meas::modelfit::CModelResult::initial

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

Definition at line 372 of file CModel.h.

◆ initialFitRegion

afw::geom::ellipses::Quadrupole lsst::meas::modelfit::CModelResult::initialFitRegion

Pixels used in the initial fit.

Definition at line 376 of file CModel.h.

◆ instFlux

Scalar lsst::meas::modelfit::CModelResult::instFlux

Flux from the final linear fit.

Definition at line 365 of file CModel.h.

◆ instFluxErr

Scalar lsst::meas::modelfit::CModelResult::instFluxErr

Flux uncertainty from the final linear fit.

Definition at line 366 of file CModel.h.

◆ instFluxInner

Scalar lsst::meas::modelfit::CModelResult::instFluxInner

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

Definition at line 367 of file CModel.h.

◆ objective

Scalar lsst::meas::modelfit::CModelResult::objective

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

Definition at line 370 of file CModel.h.

The documentation for this struct was generated from the following file:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/meas_modelfit/ga5288a1d22+2903d499ea/include/lsst/meas/modelfit/CModel.h

Public Types

Public Member Functions

Public Attributes