Inheritance diagram for lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask:

Public Member Functions
	__init__ (self, config, display=None, *kwargs)

	run (self, exp, *donutDiameter=None, doDisplay=False)

Static Public Member Functions
	detectObjectsInExp (exp, nSigma, nPixMin, grow=0)

	checkResult (exp, centroid, srcNum, percentile)

Public Attributes
	display

	centroidName

	shapeName

	schema

	control

	centroider

	sdssShape

	shaper

	apFluxControl

	apFluxer

	table

	plateScale

Static Public Attributes
	ConfigClass = QuickFrameMeasurementTaskConfig

Protected Member Functions
	_calcBrightestObjSrcNum (self, objData)

	_measureFp (self, fp, exp)

	_getDataFromSrcRecord (self, src)

	_run (self, exp, *donutDiameter=None, doDisplay=False)

Static Protected Member Functions
	_calcMedianXxYy (objData)

	_getCenterOfMass (exp, nominalCentroid, boxSize)

	_getDataFromFootprintOnly (fp, exp)

	_measurementResultToDict (measurementResult)

	_makeEmptyReturnStruct ()

Static Protected Attributes
str	_DefaultName = 'quickFrameMeasurementTask'

Detailed Description

WARNING: An experimental new task with changable API! Do not rely on yet!

This task finds the centroid of the brightest source in a given CCD-image
and returns its centroid and a rough estimate of the seeing/PSF.

It is designed for speed, such that it can be used in observing scripts
to provide pointing offsets, allowing subsequent pointings to place
a source at an exact pixel position.

The approach taken here is deliberately sub-optimal in the detection and
measurement sense, with all optimisation being done for speed and robustness
of the result.

A small set of unit tests exist for this task, which run automatically
if afwdata is setup. These, however, are stricky unit tests, and will not
catch algorithmic regressions. TODO: DM-29038 exists to merge a regression
real test which runs against 1,000 LATISS images, but is therefore slow
and requires access to the data.

Parameters
----------
config : `lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTaskConfig`
    Configuration class for the QuickFrameMeasurementTask.
display : `lsst.afw.display.Display`, optional
    The display to use for showing the images, detections and centroids.

Returns
-------
result : `lsst.pipe.base.Struct`
    Return strucure containing whether the task was successful, the main
    source's centroid, its the aperture fluxes, the ixx and iyy of the
    source, and the median ixx, iyy of the detections in the exposure.
    See run() method for further details.

Raises
------
This task should *never* raise, as the run() method is enclosed in an
except Exception block, so that it will never fail during observing.
Failure modes should be limited to returning a return Struct() with the same
structure as the success case, with all value set to np.nan but with
result.success=False.

Definition at line 98 of file quickFrameMeasurement.py.

Constructor & Destructor Documentation

◆ init()

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask.__init__	(		self,
			config,
		*	display = None,
		**	kwargs )

Definition at line 144 of file quickFrameMeasurement.py.

    def __init__(self, config, *, display=None, **kwargs):
        super().__init__(config=config, **kwargs)
        self.makeSubtask("installPsf")
 
        self.display = None
        if display:
            self.display = display
 
        self.centroidName = "base_SdssCentroid"
        self.shapeName = "base_SdssShape"
        self.schema = afwTable.SourceTable.makeMinimalSchema()
        self.schema.getAliasMap().set("slot_Centroid", self.centroidName)
        self.schema.getAliasMap().set("slot_Shape", self.shapeName)
        self.control = measBase.SdssCentroidControl()
        self.control.maxDistToPeak = -1
        self.centroider = measBase.SdssCentroidAlgorithm(self.control, self.centroidName, self.schema)
        self.sdssShape = measBase.SdssShapeControl()
        self.shaper = measBase.SdssShapeAlgorithm(self.sdssShape, self.shapeName, self.schema)
        self.apFluxControl = measBase.ApertureFluxControl()
        md = dafBase.PropertySet()
        self.apFluxer = measBase.CircularApertureFluxAlgorithm(self.apFluxControl, "aperFlux",
                                                               self.schema, md)
 
        self.table = afwTable.SourceTable.make(self.schema)  # make sure to call this last!
 

Member Function Documentation

◆ _calcBrightestObjSrcNum()

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask._calcBrightestObjSrcNum	(		self,
			objData )

protected

Find the brightest source which passes the cuts among the sources.

Parameters
----------
objData : `dict` of `dict`
    Dictionary, keyed by source number, containing the measurements.

Returns
-------
srcNum : `int`
    The source number of the brightest source which passes the cuts.

Definition at line 270 of file quickFrameMeasurement.py.

    def _calcBrightestObjSrcNum(self, objData):
        """Find the brightest source which passes the cuts among the sources.
 
        Parameters
        ----------
        objData : `dict` of `dict`
            Dictionary, keyed by source number, containing the measurements.
 
        Returns
        -------
        srcNum : `int`
            The source number of the brightest source which passes the cuts.
        """
        max70, max70srcNum = -1, -1
        max25, max25srcNum = -1, -1
 
        for srcNum in sorted(objData.keys()):  # srcNum not contiguous so don't use a list comp
            # skip flag used rather than continue statements so we have all the
            # metrics computed for debug purposes as this task is whack-a-mole
            skip = False
            xx = objData[srcNum]['xx']
            yy = objData[srcNum]['yy']
 
            xx = max(xx, 1e-9)  # need to protect against division by zero
            yy = max(yy, 1e-9)  # because we don't `continue` on zero moments
 
            if self.config.doExtendednessCut:
                if xx > self.config.maxExtendedness or yy > self.config.maxExtendedness:
                    skip = True
 
            nonRoundness = xx/yy
            nonRoundness = max(nonRoundness, 1/nonRoundness)
            if nonRoundness > self.config.maxNonRoundness:
                skip = True
 
            if self.log.isEnabledFor(self.log.DEBUG):
                text = f"src {srcNum}: {objData[srcNum]['xCentroid']:.0f}, {objData[srcNum]['yCentroid']:.0f}"
                text += f" - xx={xx:.1f}, yy={yy:.1f}, nonRound={nonRoundness:.1f}"
                text += f" - ap70={objData[srcNum]['apFlux70']:,.0f}"
                text += f" - ap25={objData[srcNum]['apFlux25']:,.0f}"
                text += f" - skip={skip}"
                self.log.debug(text)
 
            if skip:
                continue
 
            ap70 = objData[srcNum]['apFlux70']
            ap25 = objData[srcNum]['apFlux25']
            if ap70 > max70:
                max70 = ap70
                max70srcNum = srcNum
            if ap25 > max25:
                max25 = ap25
                max25srcNum = srcNum
        if max70srcNum != max25srcNum:
            self.log.warning("WARNING! Max apFlux70 for different object than with max apFlux25")
 
        if max70srcNum >= 0:  # starts as -1, return None if nothing is acceptable
            return max70srcNum
        return None
 

◆ _calcMedianXxYy()

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask._calcMedianXxYy ( objData )

staticprotected

Return the median ixx and iyy for object in the image.

Definition at line 229 of file quickFrameMeasurement.py.

    def _calcMedianXxYy(objData):
        """Return the median ixx and iyy for object in the image.
        """
        medianXx = np.nanmedian([element['xx'] for element in objData.values()])
        medianYy = np.nanmedian([element['yy'] for element in objData.values()])
        return medianXx, medianYy
 

◆ _getCenterOfMass()

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask._getCenterOfMass	(	exp,
		nominalCentroid,
		boxSize )

staticprotected

Get the centre of mass around a point in the image.

Parameters
----------
exp : `lsst.afw.image.Exposure`
    The exposure in question.
nominalCentroid : `tuple` of `float`
    Nominal location of the centroid in pixel coordinates.
boxSize : `int`
    The size of the box around the nominalCentroid in which to measure
    the centre of mass.

Returns
-------
com : `tuple` of `float`
    The locaiton of the centre of mass of the brightest source in pixel
    coordinates.

Definition at line 237 of file quickFrameMeasurement.py.

    def _getCenterOfMass(exp, nominalCentroid, boxSize):
        """Get the centre of mass around a point in the image.
 
        Parameters
        ----------
        exp : `lsst.afw.image.Exposure`
            The exposure in question.
        nominalCentroid : `tuple` of `float`
            Nominal location of the centroid in pixel coordinates.
        boxSize : `int`
            The size of the box around the nominalCentroid in which to measure
            the centre of mass.
 
        Returns
        -------
        com : `tuple` of `float`
            The locaiton of the centre of mass of the brightest source in pixel
            coordinates.
        """
        centroidPoint = geom.Point2I(nominalCentroid)
        extent = geom.Extent2I(1, 1)
        bbox = geom.Box2I(centroidPoint, extent)
        bbox = bbox.dilatedBy(int(boxSize//2))
        bbox = bbox.clippedTo(exp.getBBox())
        data = exp[bbox].image.array
        xy0 = exp[bbox].getXY0()
 
        peak = ndImage.center_of_mass(data)
        peak = (peak[1], peak[0])  # numpy coords returned
        com = geom.Point2D(xy0)
        com.shift(geom.Extent2D(*peak))
        return (com[0], com[1])
 

◆ _getDataFromFootprintOnly()

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask._getDataFromFootprintOnly	(		fp,
			exp )

staticprotected

Get the shape, centroid and flux from a footprint.

Parameters
----------
fp : `lsst.afw.detection.Footprint`
    The footprint to measure.
exp : `lsst.afw.image.Exposure`
    The footprint's parent exposure.

Returns
-------
srcData : `lsst.pipe.base.Struct`
    The struct containing the extracted measurements.

Definition at line 382 of file quickFrameMeasurement.py.

    def _getDataFromFootprintOnly(fp, exp):
        """Get the shape, centroid and flux from a footprint.
 
        Parameters
        ----------
        fp : `lsst.afw.detection.Footprint`
            The footprint to measure.
        exp : `lsst.afw.image.Exposure`
            The footprint's parent exposure.
 
        Returns
        -------
        srcData : `lsst.pipe.base.Struct`
            The struct containing the extracted measurements.
        """
        xx = fp.getShape().getIxx()
        yy = fp.getShape().getIyy()
        xCentroid, yCentroid = fp.getCentroid()
        apFlux70 = np.sum(exp[fp.getBBox()].image.array)
        apFlux25 = np.sum(exp[fp.getBBox()].image.array)
        return pipeBase.Struct(xx=xx,
                               yy=yy,
                               xCentroid=xCentroid,
                               yCentroid=yCentroid,
                               apFlux70=apFlux70,
                               apFlux25=apFlux25)
 

◆ _getDataFromSrcRecord()

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask._getDataFromSrcRecord	(		self,
			src )

protected

Extract the shapes and centroids from a source record.

Parameters
----------
src : `lsst.afw.table.SourceRecord`
    The source record from which to extract the measurements.

Returns
-------
srcData : `lsst.pipe.base.Struct`
    The struct containing the extracted measurements.

Definition at line 353 of file quickFrameMeasurement.py.

    def _getDataFromSrcRecord(self, src):
        """Extract the shapes and centroids from a source record.
 
        Parameters
        ----------
        src : `lsst.afw.table.SourceRecord`
            The source record from which to extract the measurements.
 
        Returns
        -------
        srcData : `lsst.pipe.base.Struct`
            The struct containing the extracted measurements.
        """
        pScale = self.plateScale
        xx = np.sqrt(src['base_SdssShape_xx'])*2.355*pScale  # 2.355 for FWHM, pScale for platescale from exp
        yy = np.sqrt(src['base_SdssShape_yy'])*2.355*pScale
        xCentroid = src['base_SdssCentroid_x']
        yCentroid = src['base_SdssCentroid_y']
        # apFluxes available: 70, 50, 35, 25, 17, 12 9, 6, 4.5, 3
        apFlux70 = src['aperFlux_70_0_instFlux']
        apFlux25 = src['aperFlux_25_0_instFlux']
        return pipeBase.Struct(xx=xx,
                               yy=yy,
                               xCentroid=xCentroid,
                               yCentroid=yCentroid,
                               apFlux70=apFlux70,
                               apFlux25=apFlux25)
 

◆ _makeEmptyReturnStruct()

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask._makeEmptyReturnStruct ( )

staticprotected

Make the default/template return struct, with defaults to False/nan.

Returns
-------
objData : `lsst.pipe.base.Struct`
    The default template return structure.

Definition at line 433 of file quickFrameMeasurement.py.

    def _makeEmptyReturnStruct():
        """Make the default/template return struct, with defaults to False/nan.
 
        Returns
        -------
        objData : `lsst.pipe.base.Struct`
            The default template return structure.
        """
        result = pipeBase.Struct()
        result.success = False
        result.brightestObjCentroid = (np.nan, np.nan)
        result.brightestObjCentroidCofM = None
        result.brightestObj_xXyY = (np.nan, np.nan)
        result.brightestObjApFlux70 = np.nan
        result.brightestObjApFlux25 = np.nan
        result.medianXxYy = (np.nan, np.nan)
        return result
 

◆ _measureFp()

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask._measureFp	(	self,
		fp,
		exp )

protected

Run the measurements on a footprint.

Parameters
----------
fp : `lsst.afw.detection.Footprint`
    The footprint to measure.
exp : `lsst.afw.image.Exposure`
    The footprint's parent exposure.

Returns
-------
src : `lsst.afw.table.SourceRecord`
    The source record containing the measurements.

Definition at line 331 of file quickFrameMeasurement.py.

    def _measureFp(self, fp, exp):
        """Run the measurements on a footprint.
 
        Parameters
        ----------
        fp : `lsst.afw.detection.Footprint`
            The footprint to measure.
        exp : `lsst.afw.image.Exposure`
            The footprint's parent exposure.
 
        Returns
        -------
        src : `lsst.afw.table.SourceRecord`
            The source record containing the measurements.
        """
        src = self.table.makeRecord()
        src.setFootprint(fp)
        self.centroider.measure(src, exp)
        self.shaper.measure(src, exp)
        self.apFluxer.measure(src, exp)
        return src
 

◆ _measurementResultToDict()

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask._measurementResultToDict ( measurementResult )

staticprotected

Convenience function to repackage measurement results to a dict.

Parameters
----------
measurementResult : `lsst.afw.table.SourceRecord`
    The source record to convert to a dict.

Returns
-------
objData : `dict`
    The dict containing the extracted data.

Definition at line 410 of file quickFrameMeasurement.py.

    def _measurementResultToDict(measurementResult):
        """Convenience function to repackage measurement results to a dict.
 
        Parameters
        ----------
        measurementResult : `lsst.afw.table.SourceRecord`
            The source record to convert to a dict.
 
        Returns
        -------
        objData : `dict`
            The dict containing the extracted data.
        """
        objData = {}
        objData['xx'] = measurementResult.xx
        objData['yy'] = measurementResult.yy
        objData['xCentroid'] = measurementResult.xCentroid
        objData['yCentroid'] = measurementResult.yCentroid
        objData['apFlux70'] = measurementResult.apFlux70
        objData['apFlux25'] = measurementResult.apFlux25
        return objData
 

◆ _run()

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask._run	(		self,
			exp,
		*	donutDiameter = None,
			doDisplay = False )

protected

The actual run method, called by run()

Behaviour is documented in detail in the main run().

Definition at line 498 of file quickFrameMeasurement.py.

    def _run(self, exp, *, donutDiameter=None, doDisplay=False):
        """The actual run method, called by run()
 
        Behaviour is documented in detail in the main run().
        """
        if donutDiameter is None:
            donutDiameter = self.config.donutDiameter
 
        self.plateScale = exp.getWcs().getPixelScale().asArcseconds()
        median = np.nanmedian(exp.image.array)
        exp.image -= median  # is put back later
        self.installPsf.run(exp)
        sources = self.detectObjectsInExp(exp, nSigma=self.config.nSigmaDetection,
                                          nPixMin=self.config.nPixMinDetection)
 
        if doDisplay:
            if self.display is None:
                raise RuntimeError("Display failed as no display provided during init()")
            self.display.mtv(exp)
 
        fpSet = sources.getFootprints()
        self.log.info("Found %d sources in exposure", len(fpSet))
 
        objData = {}
        nMeasured = 0
 
        for srcNum, fp in enumerate(fpSet):
            try:
                src = self._measureFp(fp, exp)
                result = self._getDataFromSrcRecord(src)
            except MeasurementError:
                try:
                    # gets shape and centroid from footprint
                    result = self._getDataFromFootprintOnly(fp, exp)
                except MeasurementError as e:
                    self.log.info("Skipped measuring source %s: %s", srcNum, e)
                    continue
            objData[srcNum] = self._measurementResultToDict(result)
            nMeasured += 1
 
        self.log.info("Measured %d of %d sources in exposure", nMeasured, len(fpSet))
 
        medianXxYy = self._calcMedianXxYy(objData)
 
        brightestObjSrcNum = self._calcBrightestObjSrcNum(objData)
        if brightestObjSrcNum is None:
            raise RuntimeError("No sources in image passed cuts")
 
        x = objData[brightestObjSrcNum]['xCentroid']
        y = objData[brightestObjSrcNum]['yCentroid']
        brightestObjCentroid = (x, y)
        xx = objData[brightestObjSrcNum]['xx']
        yy = objData[brightestObjSrcNum]['yy']
        brightestObjApFlux70 = objData[brightestObjSrcNum]['apFlux70']
        brightestObjApFlux25 = objData[brightestObjSrcNum]['apFlux25']
 
        exp.image += median  # put background back in
        if self.config.doCheckCentroidPixelValue:
            self.checkResult(exp, brightestObjCentroid, brightestObjSrcNum,
                             self.config.centroidPixelPercentile)
 
        boxSize = donutDiameter * 1.3  # allow some slack, as cutting off side of donut is very bad
        centreOfMass = self._getCenterOfMass(exp, brightestObjCentroid, boxSize)
 
        result = self._makeEmptyReturnStruct()
        result.success = True
        result.brightestObjCentroid = brightestObjCentroid
        result.brightestObj_xXyY = (xx, yy)
        result.brightestObjApFlux70 = brightestObjApFlux70
        result.brightestObjApFlux25 = brightestObjApFlux25
        result.medianXxYy = medianXxYy
        result.brightestObjCentroidCofM = centreOfMass
 
        return result

◆ checkResult()

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask.checkResult	(	exp,
		centroid,
		srcNum,
		percentile )

static

Perform a final check that centroid location is actually bright.

Parameters
----------
exp : `lsst.afw.image.Exposure`
    The exposure on which to operate
centroid : `tuple` of `float`
    Location of the centroid in pixel coordinates
scrNum : `int`
    Number of the source in the source catalog. Only used if the check
    is failed, for debug purposes.
percentile : `float`
    Image's percentile above which the pixel containing the centroid
    must be in order to pass the check.

Raises
------
ValueError
    Raised if the centroid's pixel is not above the percentile threshold

Definition at line 198 of file quickFrameMeasurement.py.

    def checkResult(exp, centroid, srcNum, percentile):
        """Perform a final check that centroid location is actually bright.
 
        Parameters
        ----------
        exp : `lsst.afw.image.Exposure`
            The exposure on which to operate
        centroid : `tuple` of `float`
            Location of the centroid in pixel coordinates
        scrNum : `int`
            Number of the source in the source catalog. Only used if the check
            is failed, for debug purposes.
        percentile : `float`
            Image's percentile above which the pixel containing the centroid
            must be in order to pass the check.
 
        Raises
        ------
        ValueError
            Raised if the centroid's pixel is not above the percentile threshold
        """
        threshold = np.percentile(exp.image.array, percentile)
        pixelValue = exp.image[centroid]
        if pixelValue < threshold:
            msg = (f"Final centroid pixel value check failed: srcNum {srcNum} at {centroid}"
                   f" has central pixel = {pixelValue:3f} <"
                   f" {percentile} percentile of image = {threshold:3f}")
            raise ValueError(msg)
        return
 

◆ detectObjectsInExp()

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask.detectObjectsInExp	(	exp,
		nSigma,
		nPixMin,
		grow = 0 )

static

Run a very basic but fast threshold-based object detection on an exposure
Return the footPrintSet for the objects in a postISR exposure.

Parameters
----------
exp : `lsst.afw.image.Exposure`
    Image in which to detect objects.
nSigma : `float`
    nSigma above image's stddev at which to set the detection threshold.
nPixMin : `int`
    Minimum number of pixels for detection.
grow : `int`
    Grow the detected footprint by this many pixels.

Returns
-------
footPrintSet : `lsst.afw.detection.FootprintSet`
    FootprintSet containing the detections.

Definition at line 170 of file quickFrameMeasurement.py.

    def detectObjectsInExp(exp, nSigma, nPixMin, grow=0):
        """Run a very basic but fast threshold-based object detection on an exposure
        Return the footPrintSet for the objects in a postISR exposure.
 
        Parameters
        ----------
        exp : `lsst.afw.image.Exposure`
            Image in which to detect objects.
        nSigma : `float`
            nSigma above image's stddev at which to set the detection threshold.
        nPixMin : `int`
            Minimum number of pixels for detection.
        grow : `int`
            Grow the detected footprint by this many pixels.
 
        Returns
        -------
        footPrintSet : `lsst.afw.detection.FootprintSet`
            FootprintSet containing the detections.
        """
        threshold = afwDetect.Threshold(nSigma, afwDetect.Threshold.STDEV)
        footPrintSet = afwDetect.FootprintSet(exp.getMaskedImage(), threshold, "DETECTED", nPixMin)
        if grow > 0:
            isotropic = True
            footPrintSet = afwDetect.FootprintSet(footPrintSet, grow, isotropic)
        return footPrintSet
 

◆ run()

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask.run	(		self,
			exp,
		*	donutDiameter = None,
			doDisplay = False )

Calculate position, flux and shape of the brightest star in an image.

Given an an assembled (and at least minimally ISRed exposure),
quickly and robustly calculate the centroid of the
brightest star in the image.

Parameters
----------
exp : `lsst.afw.image.Exposure`
    The exposure in which to find and measure the brightest star.
donutDiameter : `int` or `float`, optional
    The expected diameter of donuts in pixels for use in the centre of
    mass centroid measurement. If None is provided, the config option
    is used.
doDisplay : `bool`
    Display the image and found sources. A diplay object must have
    been passed to the task constructor.

Returns
-------
result : `lsst.pipe.base.Struct`
    Struct containing:
        Whether the task ran successfully and found the object (bool)
        The object's centroid (float, float)
        The object's ixx, iyy (float, float)
        The object's 70 pixel aperture flux (float)
        The object's 25 pixel aperture flux (float)
        The images's median ixx, iyy (float, float)
    If unsuccessful, the success field is False and all other results
    are np.nan of the expected shape.

Notes
-----
Because of this task's involvement in observing scripts, the run method
should *never* raise. Failure modes are noted by returning a Struct with
the same structure as the success case, with all value set to np.nan and
result.success=False.

Definition at line 451 of file quickFrameMeasurement.py.

    def run(self, exp, *, donutDiameter=None, doDisplay=False):
        """Calculate position, flux and shape of the brightest star in an image.
 
        Given an an assembled (and at least minimally ISRed exposure),
        quickly and robustly calculate the centroid of the
        brightest star in the image.
 
        Parameters
        ----------
        exp : `lsst.afw.image.Exposure`
            The exposure in which to find and measure the brightest star.
        donutDiameter : `int` or `float`, optional
            The expected diameter of donuts in pixels for use in the centre of
            mass centroid measurement. If None is provided, the config option
            is used.
        doDisplay : `bool`
            Display the image and found sources. A diplay object must have
            been passed to the task constructor.
 
        Returns
        -------
        result : `lsst.pipe.base.Struct`
            Struct containing:
                Whether the task ran successfully and found the object (bool)
                The object's centroid (float, float)
                The object's ixx, iyy (float, float)
                The object's 70 pixel aperture flux (float)
                The object's 25 pixel aperture flux (float)
                The images's median ixx, iyy (float, float)
            If unsuccessful, the success field is False and all other results
            are np.nan of the expected shape.
 
        Notes
        -----
        Because of this task's involvement in observing scripts, the run method
        should *never* raise. Failure modes are noted by returning a Struct with
        the same structure as the success case, with all value set to np.nan and
        result.success=False.
        """
        try:
            result = self._run(exp=exp, donutDiameter=donutDiameter, doDisplay=doDisplay)
            return result
        except Exception as e:
            self.log.warning("Failed to find main source centroid %s", e)
            result = self._makeEmptyReturnStruct()
            return result
 

Member Data Documentation

◆ _DefaultName

str lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask._DefaultName = 'quickFrameMeasurementTask'

staticprotected

Definition at line 142 of file quickFrameMeasurement.py.

◆ apFluxControl

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask.apFluxControl

Definition at line 162 of file quickFrameMeasurement.py.

◆ apFluxer

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask.apFluxer

Definition at line 164 of file quickFrameMeasurement.py.

◆ centroider

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask.centroider

Definition at line 159 of file quickFrameMeasurement.py.

◆ centroidName

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask.centroidName

Definition at line 152 of file quickFrameMeasurement.py.

◆ ConfigClass

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask.ConfigClass = QuickFrameMeasurementTaskConfig

static

Definition at line 141 of file quickFrameMeasurement.py.

◆ control

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask.control

Definition at line 157 of file quickFrameMeasurement.py.

◆ display

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask.display

Definition at line 148 of file quickFrameMeasurement.py.

◆ plateScale

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask.plateScale

Definition at line 506 of file quickFrameMeasurement.py.

◆ schema

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask.schema

Definition at line 154 of file quickFrameMeasurement.py.

◆ sdssShape

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask.sdssShape

Definition at line 160 of file quickFrameMeasurement.py.

◆ shapeName

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask.shapeName

Definition at line 153 of file quickFrameMeasurement.py.

◆ shaper

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask.shaper

Definition at line 161 of file quickFrameMeasurement.py.

◆ table

lsst.pipe.tasks.quickFrameMeasurement.QuickFrameMeasurementTask.table

Definition at line 167 of file quickFrameMeasurement.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/gc07e1c2157+b2dbe6b631/python/lsst/pipe/tasks/quickFrameMeasurement.py

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _calcBrightestObjSrcNum()

◆ _calcMedianXxYy()

◆ _getCenterOfMass()

◆ _getDataFromFootprintOnly()

◆ _getDataFromSrcRecord()

◆ _makeEmptyReturnStruct()

◆ _measureFp()

◆ _measurementResultToDict()

◆ _run()

◆ checkResult()

◆ detectObjectsInExp()

◆ run()

Member Data Documentation

◆ _DefaultName

◆ apFluxControl

◆ apFluxer

◆ centroider

◆ centroidName

◆ ConfigClass

◆ control

◆ display

◆ plateScale

◆ schema

◆ sdssShape

◆ shapeName

◆ shaper

◆ table

◆ init()