lsst.pipe.tasks.peekExposure.PeekPhotoTask Class Reference

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

Public Member Functions
	__init__ (self, Any config, **Any kwargs)
pipeBase.Struct	run (self, afwImage.Exposure exposure, int|None binSize=None)
np.ndarray	getGoodSources (self, afwTable.SourceCatalog binnedSourceCat)

Static Public Attributes
	ConfigClass = PeekPhotoTaskConfig
PeekPhotoTaskConfig	config
PeekTask	peek

Static Protected Attributes
str	_DefaultName = "peekPhoto"

Detailed Description

Peek at a photo (imaging) exposure.

For photo mode, we keep a relatively small detection threshold value, so we
can detect faint sources to use for image quality assessment.

Definition at line 539 of file peekExposure.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 551 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.PeekPhotoTask.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 589 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.PeekPhotoTask.run	(		self,
		afwImage.Exposure	exposure,
		int | None	binSize = None )

Peek at donut exposure.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure at which to peek.
binSize : `int`, optional
    Binning factor for exposure.  Default is None, which will use the
    binning factor from the config.

Returns
-------
result : `pipeBase.Struct`
    Result of photo 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 555 of file peekExposure.py.

    def run(self, exposure: afwImage.Exposure, binSize: int | None = None) -> pipeBase.Struct:
        """Peek at donut exposure.
 
        Parameters
        ----------
        exposure : `lsst.afw.image.Exposure`
            Exposure at which to peek.
        binSize : `int`, optional
            Binning factor for exposure.  Default is None, which will use the
            binning factor from the config.
 
        Returns
        -------
        result : `pipeBase.Struct`
            Result of photo 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 = self.config.binSize
 
        peekResult = self.peek.run(exposure, binSize)
 
        return pipeBase.Struct(
            mode="photo",
            binSize=binSize,
            binnedSourceCat=peekResult.sourceCat,
        )
 

Member Data Documentation

_DefaultName

str lsst.pipe.tasks.peekExposure.PeekPhotoTask._DefaultName = "peekPhoto"

staticprotected

Definition at line 549 of file peekExposure.py.

config

PeekPhotoTaskConfig lsst.pipe.tasks.peekExposure.PeekPhotoTask.config

static

Definition at line 547 of file peekExposure.py.

ConfigClass

lsst.pipe.tasks.peekExposure.PeekPhotoTask.ConfigClass = PeekPhotoTaskConfig

static

Definition at line 546 of file peekExposure.py.

peek

PeekTask lsst.pipe.tasks.peekExposure.PeekPhotoTask.peek

static

Definition at line 548 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