lsst.pipe.tasks gcb98b56dc4+dcc6c48f57
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask Class Reference
Inheritance diagram for lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask:

Public Member Functions

def __init__ (self, butler=None, initInputs=None, *args, **kwargs)
 
def applySkyCorr (self, calexp, skyCorr)
 
def extractStamps (self, inputExposure, refObjLoader=None)
 
def warpStamps (self, stamps, pixCenters)
 
def run (self, inputExposure, refObjLoader=None, dataId=None, skyCorr=None)
 
def runQuantum (self, butlerQC, inputRefs, outputRefs)
 

Public Attributes

 modelStampSize
 
 modelCenter
 

Static Public Attributes

 ConfigClass = ProcessBrightStarsConfig
 

Detailed Description

The description of the parameters for this Task are detailed in
:lsst-task:`~lsst.pipe.base.PipelineTask`.

Parameters
----------
initInputs : `Unknown`
*args
    Additional positional arguments.
**kwargs
    Additional keyword arguments.

Notes
-----
`ProcessBrightStarsTask` is used to extract, process, and store small
image cut-outs (or "postage stamps") around bright stars. It relies on
three methods, called in succession:

`extractStamps`
    Find bright stars within the exposure using a reference catalog and
    extract a stamp centered on each.
`warpStamps`
    Shift and warp each stamp to remove optical distortions and sample all
    stars on the same pixel grid.
`measureAndNormalize`
    Compute the flux of an object in an annulus and normalize it. This is
    required to normalize each bright star stamp as their central pixels
    are likely saturated and/or contain ghosts, and cannot be used.

Definition at line 181 of file processBrightStars.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.__init__ (   self,
  butler = None,
  initInputs = None,
args,
**  kwargs 
)

Definition at line 214 of file processBrightStars.py.

Member Function Documentation

◆ applySkyCorr()

def lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.applySkyCorr (   self,
  calexp,
  skyCorr 
)
Apply correction to the sky background level.

Sky corrections can be generated using the ``SkyCorrectionTask``.
As the sky model generated there extends over the full focal plane,
this should produce a more optimal sky subtraction solution.

Parameters
----------
calexp : `~lsst.afw.image.Exposure` or `~lsst.afw.image.MaskedImage`
    Calibrated exposure.
skyCorr : `~lsst.afw.math.backgroundList.BackgroundList`, optional
    Full focal plane sky correction from ``SkyCorrectionTask``.

Notes
-----
This method modifies the input ``calexp`` in-place.

Definition at line 232 of file processBrightStars.py.

◆ extractStamps()

def lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.extractStamps (   self,
  inputExposure,
  refObjLoader = None 
)
Read the position of bright stars within an input exposure using a
refCat and extract them.

Parameters
----------
inputExposure : `~lsst.afw.image.ExposureF`
    The image from which bright star stamps should be extracted.
refObjLoader : `~lsst.meas.algorithms.ReferenceObjectLoader`, optional
    Loader to find objects within a reference catalog.

Returns
-------
result : `~lsst.pipe.base.Struct`
    Results as a struct with attributes:

    ``starIms``
        Postage stamps (`list`).
    ``pixCenters``
        Corresponding coords to each star's center, in pixels (`list`).
    ``GMags``
        Corresponding (Gaia) G magnitudes (`list`).
    ``gaiaIds``
        Corresponding unique Gaia identifiers (`np.ndarray`).

Definition at line 254 of file processBrightStars.py.

◆ run()

def lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.run (   self,
  inputExposure,
  refObjLoader = None,
  dataId = None,
  skyCorr = None 
)
Identify bright stars within an exposure using a reference catalog,
extract stamps around each, then preprocess them. The preprocessing
steps are: shifting, warping and potentially rotating them to the same
pixel grid; computing their annular flux and normalizing them.

Parameters
----------
inputExposure : `~lsst.afw.image.ExposureF`
    The image from which bright star stamps should be extracted.
refObjLoader : `~lsst.meas.algorithms.ReferenceObjectLoader`, optional
    Loader to find objects within a reference catalog.
dataId : `dict` or `~lsst.daf.butler.DataCoordinate`
    The dataId of the exposure (and detector) bright stars should be
    extracted from.
skyCorr : `~lsst.afw.math.backgroundList.BackgroundList`, optional
    Full focal plane sky correction obtained by `SkyCorrectionTask`.

Returns
-------
result :  `~lsst.pipe.base.Struct`
    Results as a struct with attributes:

    ``brightStarStamps``
        (`~lsst.meas.algorithms.brightStarStamps.BrightStarStamps`)

Definition at line 451 of file processBrightStars.py.

◆ runQuantum()

def lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.runQuantum (   self,
  butlerQC,
  inputRefs,
  outputRefs 
)

Definition at line 533 of file processBrightStars.py.

◆ warpStamps()

def lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.warpStamps (   self,
  stamps,
  pixCenters 
)
Warps and shifts all given stamps so they are sampled on the same
pixel grid and centered on the central pixel. This includes rotating
the stamp depending on detector orientation.

Parameters
----------
stamps : `Sequence` [`~lsst.afw.image.ExposureF`]
    Image cutouts centered on a single object.
pixCenters : `Sequence` [`~lsst.geom.Point2D`]
    Positions of each object's center (from the refCat) in pixels.

Returns
-------
result : `~lsst.pipe.base.Struct`
    Results as a struct with attributes:

    ``warpedStars``
        Stamps of warped stars.
            (`list` [`~lsst.afw.image.MaskedImage`])
    ``warpTransforms``
        The corresponding Transform from the initial star stamp
        to the common model grid.
            (`list` [`~lsst.afw.geom.TransformPoint2ToPoint2`])
    ``xy0s``
        Coordinates of the bottom-left pixels of each stamp,
        before rotation.
            (`list` [`~lsst.geom.Point2I`])
    ``nb90Rots``
        The number of 90 degrees rotations required to compensate for
        detector orientation.
            (`int`)

Definition at line 354 of file processBrightStars.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.ConfigClass = ProcessBrightStarsConfig
static

Definition at line 211 of file processBrightStars.py.

◆ modelCenter

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.modelCenter

Definition at line 227 of file processBrightStars.py.

◆ modelStampSize

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask.modelStampSize

Definition at line 217 of file processBrightStars.py.


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