LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Types | Public Member Functions | Public Attributes | List of all members
lsst::meas::modelfit::CModelResult Struct Reference

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. More...
 
Scalar instFluxErr
 Flux uncertainty from the final linear fit. More...
 
Scalar instFluxInner
 Flux measured strictly within the fit region (no extrapolation). More...
 
Scalar fracDev
 Fraction of flux from the final linear fit in the de Vaucouleur component (always between 0 and 1). More...
 
Scalar objective
 Objective value at the best-fit point (chisq/2) More...
 
CModelStageResult initial
 Results from the initial approximate nonlinear fit that feeds the others. More...
 
CModelStageResult exp
 Results from the exponential (Sersic n=1) fit. More...
 
CModelStageResult dev
 Results from the de Vaucouleur (Sersic n=4) fit. More...
 
afw::geom::ellipses::Quadrupole initialFitRegion
 Pixels used in the initial fit. More...
 
afw::geom::ellipses::Quadrupole finalFitRegion
 Pixels used in the exp, dev, and linear fits. More...
 
LocalUnitTransform fitSysToMeasSys
 Transforms to the coordinate system where parameters are defined. More...
 
std::bitset< N_FLAGSflags
 Array of flags. More...
 

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

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.

337  {
338  FAILED=0,
352  NO_SHAPE,
354  SMALL_SHAPE,
357  BAD_CENTROID,
358  BAD_REFERENCE,
359  NO_FLUX,
360  N_FLAGS
361  };
@ REGION_USED_INITIAL_ELLIPSE_MAX
Fit region implied by the best-fit ellipse of the initial was too large, so we used the configuration...
Definition: CModel.h:350
@ BAD_REFERENCE
Reference fit failed, so forced fit will fail as well.
Definition: CModel.h:358
@ REGION_USED_PSF_AREA
Kron radius was unavailable or outside bounds, so the second-moment ellipse scaled to the PSF area wa...
Definition: CModel.h:346
@ NO_SHAPELET_PSF
Set if the Psf shapelet approximation failed.
Definition: CModel.h:356
@ FAILED
General failure flag for the linear fit flux; set if any other CModel flag is set,...
Definition: CModel.h:338
@ SMALL_SHAPE
Initial moments were sufficiently small that we used minInitialRadius to set the initial parameters.
Definition: CModel.h:354
@ REGION_USED_INITIAL_ELLIPSE_MIN
Fit region implied by the best-fit ellipse of the initial was too small, so we used the configuration...
Definition: CModel.h:348
@ N_FLAGS
Non-flag counter to indicate the number of flags.
Definition: CModel.h:360
@ REGION_USED_FOOTPRINT_AREA
Kron radius was unavailable or outside bounds, so the second-moment ellipse scaled to the footprint a...
Definition: CModel.h:343
@ NO_SHAPE
Set if the input SourceRecord had no valid shape slot with which to start the fit.
Definition: CModel.h:352
@ REGION_MAX_BAD_PIXEL_FRACTION
Set if we aborted early because the fit region had too many bad pixels.
Definition: CModel.h:341
@ BAD_CENTROID
Input centroid did not land within the fit region.
Definition: CModel.h:357
@ NO_FLUX
No flux was measured.
Definition: CModel.h:359
@ REGION_MAX_AREA
Set if we aborted early because the fit region was too large.
Definition: CModel.h:340

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: