lsst.pipe.tasks g253578fa50+c1a9b1f270
Loading...
Searching...
No Matches
lsst.pipe.tasks.peekExposure.PeekSpecTask Class Reference
Inheritance diagram for lsst.pipe.tasks.peekExposure.PeekSpecTask:

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 = PeekSpecTaskConfig
 

Static Protected Attributes

PeekTask _DefaultName = "peekSpec"
 

Detailed Description

Peek at a spectroscopic exposure.

For spec mode, we dramatically increase the detection threshold to avoid
creating blends with the long spectra objects that appear in these images.
We also change the default aperture flux slot to a larger aperture, which
helps overcome challenges with lost flux in the interpolated cores of
saturated objects.

Definition at line 638 of file peekExposure.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 653 of file peekExposure.py.

Member Function Documentation

◆ getGoodSources()

np.ndarray lsst.pipe.tasks.peekExposure.PeekSpecTask.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 691 of file peekExposure.py.

◆ run()

pipeBase.Struct lsst.pipe.tasks.peekExposure.PeekSpecTask.run ( self,
afwImage.Exposure exposure,
int | None binSize = None )
Peek at spectroscopic 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 spec 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 657 of file peekExposure.py.

Member Data Documentation

◆ _DefaultName

PeekTask lsst.pipe.tasks.peekExposure.PeekSpecTask._DefaultName = "peekSpec"
staticprotected

Definition at line 651 of file peekExposure.py.

◆ ConfigClass

lsst.pipe.tasks.peekExposure.PeekSpecTask.ConfigClass = PeekSpecTaskConfig
static

Definition at line 648 of file peekExposure.py.


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