lsst.afw g8cdfe0ae6a+4fd9e222a8
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | 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

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

Public Attributes

 wcs
 

Static Public Attributes

 readFitsWithOptions = classmethod(imageReadFitsWithOptions)
 
 writeFitsWithOptions = exposureWriteFitsWithOptions
 

Protected Member Functions

 _set (self, index, value, origin)
 
 _get (self, index, origin)
 

Properties

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

Detailed Description

Definition at line 35 of file _exposureContinued.py.

Member Function Documentation

◆ __deepcopy__()

lsst.afw.image._exposure._exposureContinued.Exposure.__deepcopy__ ( self,
memo = None )

Definition at line 67 of file _exposureContinued.py.

◆ __reduce__()

lsst.afw.image._exposure._exposureContinued.Exposure.__reduce__ ( self)

Definition at line 63 of file _exposureContinued.py.

◆ _get()

lsst.afw.image._exposure._exposureContinued.Exposure._get ( self,
index,
origin )
protected
Return a triple (value, mask, variance) at the given index.

Parameters
----------
index : `geom.Point2I`
    Position of the pixel to assign to.
origin : `ImageOrigin`
    Coordinate system of ``index`` (`PARENT` or `LOCAL`).

Definition at line 51 of file _exposureContinued.py.

◆ _set()

lsst.afw.image._exposure._exposureContinued.Exposure._set ( self,
index,
value,
origin )
protected
Set the pixel at the given index to a triple (value, mask, variance).

Parameters
----------
index : `geom.Point2I`
    Position of the pixel to assign to.
value : `tuple`
    A tuple of (value, mask, variance) scalars.
origin : `ImageOrigin`
    Coordinate system of ``index`` (`PARENT` or `LOCAL`).

Definition at line 37 of file _exposureContinued.py.

◆ containsSkyCoords()

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 128 of file _exposureContinued.py.

◆ convertD()

lsst.afw.image._exposure._exposureContinued.Exposure.convertD ( self)

Definition at line 73 of file _exposureContinued.py.

◆ convertF()

lsst.afw.image._exposure._exposureContinued.Exposure.convertF ( self)

Definition at line 70 of file _exposureContinued.py.

◆ getConvexPolygon()

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 100 of file _exposureContinued.py.

◆ getImage()

lsst.afw.image._exposure._exposureContinued.Exposure.getImage ( self)

Definition at line 76 of file _exposureContinued.py.

◆ getMask()

lsst.afw.image._exposure._exposureContinued.Exposure.getMask ( self)

Definition at line 84 of file _exposureContinued.py.

◆ getVariance()

lsst.afw.image._exposure._exposureContinued.Exposure.getVariance ( self)

Definition at line 92 of file _exposureContinued.py.

◆ setImage()

lsst.afw.image._exposure._exposureContinued.Exposure.setImage ( self,
image )

Definition at line 79 of file _exposureContinued.py.

◆ setMask()

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

Definition at line 87 of file _exposureContinued.py.

◆ setVariance()

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

Definition at line 95 of file _exposureContinued.py.

Member Data Documentation

◆ readFitsWithOptions

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

Definition at line 164 of file _exposureContinued.py.

◆ wcs

lsst.afw.image._exposure._exposureContinued.Exposure.wcs

Definition at line 124 of file _exposureContinued.py.

◆ writeFitsWithOptions

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

Definition at line 166 of file _exposureContinued.py.

Property Documentation

◆ convex_polygon

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

Definition at line 126 of file _exposureContinued.py.

◆ image

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

Definition at line 82 of file _exposureContinued.py.

◆ mask

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

Definition at line 90 of file _exposureContinued.py.

◆ variance

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

Definition at line 98 of file _exposureContinued.py.


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