Inheritance diagram for lsst.pipe.tasks.peekExposure.PeekDonutTask:

Public Member Functions
	__init__ (self, Any config, **Any kwargs)

pipeBase.Struct	run (self, afwImage.Exposure exposure, float donutDiameter, int\|None binSize=None)

np.ndarray	getGoodSources (self, afwTable.SourceCatalog binnedSourceCat)

Static Public Attributes
	ConfigClass = PeekDonutTaskConfig

Static Protected Attributes
PeekTask	_DefaultName = "peekDonut"

Detailed Description

Peek at a donut exposure.

The main modification for donuts is to aggressively bin the image to reduce
the size of sources (donuts) from ~100 pixels or more to ~10 pixels.  This
greatly increases the speed and detection capabilities of PeekTask with
little loss of accuracy for centroids.

Definition at line 416 of file peekExposure.py.

Constructor & Destructor Documentation

◆ init()

lsst.pipe.tasks.peekExposure.PeekDonutTask.__init__	(		self,
		Any	config,
		**Any	kwargs )

Definition at line 430 of file peekExposure.py.

Member Function Documentation

◆ getGoodSources()

np.ndarray lsst.pipe.tasks.peekExposure.PeekDonutTask.getGoodSources	(		self,
		afwTable.SourceCatalog	binnedSourceCat )

Perform any filtering on the source catalog.

Parameters
----------
binnedSourceCat : `lsst.afw.table.SourceCatalog`
    Source catalog from the binned exposure.

Returns
-------
goodSourceMask : `numpy.ndarray`
    Boolean array indicating which sources are good.

Definition at line 500 of file peekExposure.py.

◆ run()

pipeBase.Struct lsst.pipe.tasks.peekExposure.PeekDonutTask.run	(		self,
		afwImage.Exposure	exposure,
		float	donutDiameter,
		int \| None	binSize = None )

Peek at donut exposure.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure at which to peek.
donutDiameter : `float`
    Donut diameter in pixels.
binSize : `int`, optional
    Binning factor for exposure.  Default is None, which will use the
    resolution config value to determine the binSize.

Returns
-------
result : `pipeBase.Struct`
    Result of donut peeking.
    Struct containing:
        - mode : `str`
            Peek mode that was run.
        - binSize : `int`
            Binning factor used.
        - binnedSourceCat : `lsst.afw.table.SourceCatalog`
            Source catalog from the binned exposure.

Definition at line 434 of file peekExposure.py.

Member Data Documentation

◆ _DefaultName

PeekTask lsst.pipe.tasks.peekExposure.PeekDonutTask._DefaultName = "peekDonut"

staticprotected

Definition at line 428 of file peekExposure.py.

◆ ConfigClass

lsst.pipe.tasks.peekExposure.PeekDonutTask.ConfigClass = PeekDonutTaskConfig

static

Definition at line 425 of file peekExposure.py.

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

python/lsst/pipe/tasks/peekExposure.py

Public Member Functions

Static Public Attributes

Static Protected Attributes