lsst.pipe.tasks.peekExposure.PeekTask Class Reference

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

Public Member Functions
	__init__ (self, Any|None schema=None, **Any kwargs)
pipeBase.Struct	run (self, afwImage.Exposure exposure, int|None binSize=None)

Public Attributes
	schema
	algMetadata

Static Public Attributes
	ConfigClass = PeekTaskConfig
PeekTaskConfig	config
InstallGaussianPsfTask	installPsf
SubtractBackgroundTask	background
SourceDetectionTask	detection
SingleFrameMeasurementTask	measurement

Static Protected Attributes
str	_DefaultName = "peek"

Detailed Description

Peek at exposure to quickly detect and measure both the brightest source
in the image, and a set of sources representative of the exposure's overall
image quality.

Optionally bins image and then:
    - installs a simple PSF model
    - measures and subtracts the background
    - detects sources
    - measures sources

Designed to be quick at the expense of primarily completeness, but also to
a lesser extent accuracy.

Definition at line 308 of file peekExposure.py.

Constructor & Destructor Documentation

__init__()

lsst.pipe.tasks.peekExposure.PeekTask.__init__	(		self,
		Any | None	schema = None,
		**Any	kwargs )

Definition at line 331 of file peekExposure.py.

    def __init__(self, schema: Any | None = None, **kwargs: Any):
        super().__init__(**kwargs)
 
        if schema is None:
            schema = SourceTable.makeMinimalSchema()
        self.schema = schema
 
        self.makeSubtask("installPsf")
        self.makeSubtask("background")
        self.makeSubtask("detection", schema=self.schema)
        self.algMetadata = dafBase.PropertyList()
        self.makeSubtask("measurement", schema=self.schema, algMetadata=self.algMetadata)
 

Member Function Documentation

run()

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

Peek at 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
    default binning factor from the config.

Returns
-------
result : `pipeBase.Struct`
    Result of peeking.
    Struct containing:
        - sourceCat : `lsst.afw.table.SourceCatalog`
            Source catalog from the binned exposure.

Definition at line 344 of file peekExposure.py.

    def run(self, exposure: afwImage.Exposure, binSize: int | None = None) -> pipeBase.Struct:
        """Peek at 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
            default binning factor from the config.
 
        Returns
        -------
        result : `pipeBase.Struct`
            Result of peeking.
            Struct containing:
                - sourceCat : `lsst.afw.table.SourceCatalog`
                    Source catalog from the binned exposure.
        """
        if binSize is None:
            binSize = self.config.defaultBinSize
 
        if binSize != 1:
            mi = exposure.getMaskedImage()
            binned = afwMath.binImage(mi, binSize)
            exposure.setMaskedImage(binned)
 
        if self.config.doInstallPsf:
            self.installPsf.run(exposure=exposure)
 
        self.background.run(exposure)
 
        idGenerator = IdGenerator()
        sourceIdFactory = idGenerator.make_table_id_factory()
        table = SourceTable.make(self.schema, sourceIdFactory)
        table.setMetadata(self.algMetadata)
        sourceCat = self.detection.run(table=table, exposure=exposure, doSmooth=True).sources
 
        self.measurement.run(measCat=sourceCat, exposure=exposure, exposureId=idGenerator.catalog_id)
 
        return pipeBase.Struct(
            sourceCat=sourceCat,
        )
 
 

Member Data Documentation

_DefaultName

str lsst.pipe.tasks.peekExposure.PeekTask._DefaultName = "peek"

staticprotected

Definition at line 329 of file peekExposure.py.

algMetadata

lsst.pipe.tasks.peekExposure.PeekTask.algMetadata

Definition at line 341 of file peekExposure.py.

background

SubtractBackgroundTask lsst.pipe.tasks.peekExposure.PeekTask.background

static

Definition at line 326 of file peekExposure.py.

config

PeekTaskConfig lsst.pipe.tasks.peekExposure.PeekTask.config

static

Definition at line 324 of file peekExposure.py.

ConfigClass

lsst.pipe.tasks.peekExposure.PeekTask.ConfigClass = PeekTaskConfig

static

Definition at line 323 of file peekExposure.py.

detection

SourceDetectionTask lsst.pipe.tasks.peekExposure.PeekTask.detection

static

Definition at line 327 of file peekExposure.py.

installPsf

InstallGaussianPsfTask lsst.pipe.tasks.peekExposure.PeekTask.installPsf

static

Definition at line 325 of file peekExposure.py.

measurement

SingleFrameMeasurementTask lsst.pipe.tasks.peekExposure.PeekTask.measurement

static

Definition at line 328 of file peekExposure.py.

schema

lsst.pipe.tasks.peekExposure.PeekTask.schema

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