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 = schema
	algMetadata = dafBase.PropertyList()

Static Public Attributes
	ConfigClass = PeekTaskConfig

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

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.

Member Data Documentation

_DefaultName

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

staticprotected

Definition at line 329 of file peekExposure.py.

algMetadata

lsst.pipe.tasks.peekExposure.PeekTask.algMetadata = dafBase.PropertyList()

Definition at line 341 of file peekExposure.py.

ConfigClass

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

static

Definition at line 323 of file peekExposure.py.

schema

lsst.pipe.tasks.peekExposure.PeekTask.schema = schema

Definition at line 336 of file peekExposure.py.

---

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

• python/lsst/pipe/tasks/peekExposure.py