lsst.pipe.tasks  21.0.0-141-gec8a224e+c9dc52cf11
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.calexpCutout.CalexpCutoutTask Class Reference
Inheritance diagram for lsst.pipe.tasks.calexpCutout.CalexpCutoutTask:

Public Member Functions

def run (self, in_table, calexp)
 

Static Public Attributes

 ConfigClass = CalexpCutoutTaskConfig
 

Detailed Description

Task for computing cutouts on a specific calexp given
positions, xspans, and yspans of the stamps.

Definition at line 46 of file calexpCutout.py.

Member Function Documentation

◆ run()

def lsst.pipe.tasks.calexpCutout.CalexpCutoutTask.run (   self,
  in_table,
  calexp 
)
Compute and return the cutouts.

Parameters
----------
in_table : `astropy.QTable`
    A table containing at least the following columns: position, xspan
    and yspan.  The position should be an `astropy.SkyCoord`.  The
    xspan and yspan are the extent of the cutout in x and y in pixels.
calexp : `lsst.afw.image.ExposureF`
    The calibrated exposure from which to extract cutouts

Returns
-------
output : `lsst.pipe.base.Struct`
    A struct containing:

    * cutouts: an `lsst.meas.algorithms.Stamps` object
               that wraps a list of masked images of the cutouts and a
               `PropertyList` containing the metadata to be persisted
               with the cutouts.  The exposure metadata is preserved and,
               in addition, arrays holding the RA and Dec of each stamp
               in degrees are added to the metadata.  Note: the origin
               of the output stamps is `lsst.afw.image.PARENT`.
    * skipped_positions: a `list` of `lsst.geom.SpherePoint` objects for
                         stamps that were skiped for being off the image
                         or partially off the image

Raises
------
ValueError
    If the input catalog doesn't have the required columns,
    a ValueError is raised

Definition at line 53 of file calexpCutout.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.calexpCutout.CalexpCutoutTask.ConfigClass = CalexpCutoutTaskConfig
static

Definition at line 50 of file calexpCutout.py.


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