lsst.afw g47ad8d2bab+3cc41d2aa1
Public Member Functions | Static Public Attributes | Properties | List of all members
lsst.afw.image.exposure._exposureContinued.Exposure Class Reference
Inheritance diagram for lsst.afw.image.exposure._exposureContinued.Exposure:

Public Member Functions

def __reduce__ (self)
 
def convertF (self)
 
def convertD (self)
 
def getImage (self)
 
def setImage (self, image)
 
def getMask (self)
 
def setMask (self, mask)
 
def getVariance (self)
 
def setVariance (self, variance)
 
def getConvexPolygon (self, padding=10)
 
def containsSkyCoords (self, ra, dec, padding=10)
 

Static Public Attributes

 readFitsWithOptions = classmethod(imageReadFitsWithOptions)
 
 writeFitsWithOptions = exposureWriteFitsWithOptions
 

Properties

 image = property(getImage, setImage)
 
 mask = property(getMask, setMask)
 
 variance = property(getVariance, setVariance)
 
 convex_polygon = property(getConvexPolygon)
 

Detailed Description

Definition at line 36 of file _exposureContinued.py.

Member Function Documentation

◆ __reduce__()

def lsst.afw.image.exposure._exposureContinued.Exposure.__reduce__ (   self)

Definition at line 64 of file _exposureContinued.py.

◆ containsSkyCoords()

def lsst.afw.image.exposure._exposureContinued.Exposure.containsSkyCoords (   self,
  ra,
  dec,
  padding = 10 
)
Check if a set of sky positions is in the pixel bounding box.

The default padding size was chosen to be sufficient for the
most warped detectors at the edges of the HyperSuprimeCam focal plane.

Parameters
----------
ra : `astropy.Quantity`, (N,)
    Array of Right Ascension, angular units.
dec : `astropy.Quantity`, (N,)
    Array of Declination, angular units.
padding : `int`, optional
    Pixel padding to ensure that bounding box is entirely contained
    within the sky polygon (see ``getConvexPolygon()``).

Returns
-------
contained : `np.ndarray`, (N,)
    Boolean array indicating which points are contained in the
    bounding box.

Raises
------
ValueError if exposure does not have a valid wcs.

Definition at line 126 of file _exposureContinued.py.

◆ convertD()

def lsst.afw.image.exposure._exposureContinued.Exposure.convertD (   self)

Definition at line 71 of file _exposureContinued.py.

◆ convertF()

def lsst.afw.image.exposure._exposureContinued.Exposure.convertF (   self)

Definition at line 68 of file _exposureContinued.py.

◆ getConvexPolygon()

def lsst.afw.image.exposure._exposureContinued.Exposure.getConvexPolygon (   self,
  padding = 10 
)
Get the convex polygon associated with the bounding box corners.

The returned polygon has additional padding to ensure that the
bounding box is entirely contained within it.  To ensure a set
of coordinates are entirely contained within an exposure, run
``exposure.containsSkyCoords()``.  The default padding
size was chosen to be sufficient for the most warped detectors at
the edges of the HyperSuprimeCam focal plane.

Parameters
----------
padding : `int`
    Pixel padding to ensure that bounding box is entirely contained
    within the resulting polygon.

Returns
-------
convexPolygon : `lsst.sphgeom.ConvexPolygon`
    Returns `None` if exposure does not have a valid WCS.

Definition at line 98 of file _exposureContinued.py.

◆ getImage()

def lsst.afw.image.exposure._exposureContinued.Exposure.getImage (   self)

Definition at line 74 of file _exposureContinued.py.

◆ getMask()

def lsst.afw.image.exposure._exposureContinued.Exposure.getMask (   self)

Definition at line 82 of file _exposureContinued.py.

◆ getVariance()

def lsst.afw.image.exposure._exposureContinued.Exposure.getVariance (   self)

Definition at line 90 of file _exposureContinued.py.

◆ setImage()

def lsst.afw.image.exposure._exposureContinued.Exposure.setImage (   self,
  image 
)

Definition at line 77 of file _exposureContinued.py.

◆ setMask()

def lsst.afw.image.exposure._exposureContinued.Exposure.setMask (   self,
  mask 
)

Definition at line 85 of file _exposureContinued.py.

◆ setVariance()

def lsst.afw.image.exposure._exposureContinued.Exposure.setVariance (   self,
  variance 
)

Definition at line 93 of file _exposureContinued.py.

Member Data Documentation

◆ readFitsWithOptions

lsst.afw.image.exposure._exposureContinued.Exposure.readFitsWithOptions = classmethod(imageReadFitsWithOptions)
static

Definition at line 162 of file _exposureContinued.py.

◆ writeFitsWithOptions

lsst.afw.image.exposure._exposureContinued.Exposure.writeFitsWithOptions = exposureWriteFitsWithOptions
static

Definition at line 164 of file _exposureContinued.py.

Property Documentation

◆ convex_polygon

lsst.afw.image.exposure._exposureContinued.Exposure.convex_polygon = property(getConvexPolygon)
static

Definition at line 124 of file _exposureContinued.py.

◆ image

lsst.afw.image.exposure._exposureContinued.Exposure.image = property(getImage, setImage)
static

Definition at line 80 of file _exposureContinued.py.

◆ mask

lsst.afw.image.exposure._exposureContinued.Exposure.mask = property(getMask, setMask)
static

Definition at line 88 of file _exposureContinued.py.

◆ variance

lsst.afw.image.exposure._exposureContinued.Exposure.variance = property(getVariance, setVariance)
static

Definition at line 96 of file _exposureContinued.py.


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