lsst.pipe.tasks.peekExposure.PeekDonutTask Class Reference

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
PeekDonutTaskConfig	config
PeekTask	peek

Static Protected Attributes
str	_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.

    def __init__(self, config: Any, **kwargs: Any):
        super().__init__(config=config, **kwargs)
        self.makeSubtask("peek")
 

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.

    def getGoodSources(self, binnedSourceCat: afwTable.SourceCatalog) -> np.ndarray:
        """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.
        """
        # Perform any filtering on the source catalog
        goodSourceMask = np.ones(len(binnedSourceCat), dtype=bool)
        return goodSourceMask
 
 

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.

    ) -> pipeBase.Struct:
        """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.
        """
        if binSize is None:
            binSize = int(
                np.floor(
                    np.clip(
                        donutDiameter / self.config.resolution,
                        1,
                        self.config.binSizeMax,
                    )
                )
            )
        binnedDonutDiameter = donutDiameter / binSize
        psf = DonutPsf(
            binnedDonutDiameter * 1.5, binnedDonutDiameter * 0.5, binnedDonutDiameter * 0.5 * 0.3525
        )
 
        # Note that SourceDetectionTask will convolve with a _Gaussian
        # approximation to the PSF_ anyway, so we don't really need to be
        # precise with the PSF unless this changes.  PSFs that approach the
        # size of the image, however, can cause problems with the detection
        # convolution algorithm, so we limit the size.
        sigma = psf.computeShape(psf.getAveragePosition()).getDeterminantRadius()
        factor = 8 * sigma / (min(exposure.getDimensions()) / binSize)
 
        if factor > 1:
            psf = DonutPsf(
                binnedDonutDiameter * 1.5 / factor,
                binnedDonutDiameter * 0.5 / factor,
                binnedDonutDiameter * 0.5 * 0.3525 / factor,
            )
        exposure.setPsf(psf)
 
        peekResult = self.peek.run(exposure, binSize)
 
        return pipeBase.Struct(
            mode="donut",
            binSize=binSize,
            binnedSourceCat=peekResult.sourceCat,
        )
 

Member Data Documentation

_DefaultName

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

staticprotected

Definition at line 428 of file peekExposure.py.

config

PeekDonutTaskConfig lsst.pipe.tasks.peekExposure.PeekDonutTask.config

static

Definition at line 426 of file peekExposure.py.

ConfigClass

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

static

Definition at line 425 of file peekExposure.py.

peek

PeekTask lsst.pipe.tasks.peekExposure.PeekDonutTask.peek

static

Definition at line 427 of file peekExposure.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/pipe_tasks/g5065538af8+ba676e4b71/python/lsst/pipe/tasks/peekExposure.py