Inheritance diagram for lsst.meas.algorithms.measureApCorr.MeasureApCorrError:

Public Member Functions
	__init__ (self, *name, nSources, ndof, iteration=None)

	metadata (self)

Public Attributes
	name

	nSources

	ndof

	iteration

Detailed Description

Raised if Aperture Correction fails in a non-recoverable way.

Parameters
----------
name : `str`
    Name of the kind of aperture correction that failed; typically an
    instFlux catalog field.
nSources : `int`
    Number of sources available to the fitter at the point of failure.
ndof : `int`
    Number of degrees of freedom required at the point of failure.
iteration : `int`, optional
    Which fit iteration the failure occurred in.

Definition at line 38 of file measureApCorr.py.

Constructor & Destructor Documentation

◆ init()

lsst.meas.algorithms.measureApCorr.MeasureApCorrError.__init__	(		self,
		*	name,
			nSources,
			ndof,
			iteration = None )

Definition at line 53 of file measureApCorr.py.

    def __init__(self, *, name, nSources, ndof, iteration=None):
        msg = f"Unable to measure aperture correction for '{name}'"
        if iteration is not None:
            msg += f" after {iteration} steps:"
        else:
            msg += ":"
        msg += f" only {nSources} sources, but require at least {ndof}."
        super().__init__(msg)
        self.name = name
        self.nSources = nSources
        self.ndof = ndof
        self.iteration = iteration
 

Member Function Documentation

◆ metadata()

lsst.meas.algorithms.measureApCorr.MeasureApCorrError.metadata ( self )

Definition at line 67 of file measureApCorr.py.

    def metadata(self):
        metadata = {"name": self.name,
                    "nSources": self.nSources,
                    "ndof": self.ndof,
                    }
        # NOTE: have to do this because task metadata doesn't allow None.
        if self.iteration is not None:
            metadata["iteration"] = self.iteration
        return metadata
 
 

Member Data Documentation

◆ iteration

lsst.meas.algorithms.measureApCorr.MeasureApCorrError.iteration

Definition at line 64 of file measureApCorr.py.

◆ name

lsst.meas.algorithms.measureApCorr.MeasureApCorrError.name

Definition at line 61 of file measureApCorr.py.

◆ ndof

lsst.meas.algorithms.measureApCorr.MeasureApCorrError.ndof

Definition at line 63 of file measureApCorr.py.

◆ nSources

lsst.meas.algorithms.measureApCorr.MeasureApCorrError.nSources

Definition at line 62 of file measureApCorr.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_algorithms/ge6526c86ff+39927bb362/python/lsst/meas/algorithms/measureApCorr.py

Public Member Functions

Public Attributes