lsst.obs.base  17.0.1-21-ga02730c+2
Public Member Functions | List of all members
lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase Class Reference
Inheritance diagram for lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase:

Public Member Functions

def readImage (self, fileDescriptor)
 
def readMask (self, fileDescriptor)
 
def readVariance (self, fileDescriptor)
 
def stripMetadata (self, metadata)
 
def makeVisitInfo (self, metadata)
 
def makeWcs (self, metadata)
 
def makeFilter (self, metadata)
 
def readImageComponent (self, fileDescriptor, component)
 
def readInfoComponent (self, fileDescriptor, component)
 
def readFull (self, fileDescriptor, parameters=None)
 
def write (self, inMemoryDataset, fileDescriptor)
 

Detailed Description

Abstract base class for reading and writing raw data to and from
FITS files.

Subclasses must provide implementations of `readImage` and
`makeRawVisitInfo`.  Other methods may also be overridden to provide
additional components (most default to `None`).

Definition at line 29 of file fitsRawFormatterBase.py.

Member Function Documentation

◆ makeFilter()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.makeFilter (   self,
  metadata 
)
Construct a Filter from metadata.

Parameters
----------
metadata : `~lsst.daf.base.PropertyList`
    Header metadata.  May be modified in-place.

Returns
-------
filter : `~lsst.afw.image.Filter`
    Object that identifies the filter for this image.

Definition at line 137 of file fitsRawFormatterBase.py.

◆ makeVisitInfo()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.makeVisitInfo (   self,
  metadata 
)
Construct a VisitInfo from metadata.

Parameters
----------
metadata : `~lsst.daf.base.PropertyList`
    Header metadata.  May be modified in-place.

Returns
-------
visitInfo : `~lsst.afw.image.VisitInfo`
    Structured metadata about the observation.

Definition at line 106 of file fitsRawFormatterBase.py.

◆ makeWcs()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.makeWcs (   self,
  metadata 
)
Construct a SkyWcs from metadata.

Parameters
----------
metadata : `~lsst.daf.base.PropertyList`
    Header metadata.  May be modified in-place.

Returns
-------
wcs : `~lsst.afw.geom.SkyWcs`
    Reversible mapping from pixel coordinates to sky coordinates.

Definition at line 121 of file fitsRawFormatterBase.py.

◆ readFull()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.readFull (   self,
  fileDescriptor,
  parameters = None 
)
Read the full Exposure object.

Parameters
----------
fileDescriptor : `FileDescriptor`
    Identifies the file to read and parameters to be used for reading.
parameters : `dict`, optional
    If specified a dictionary of slicing parameters that overrides
    those in ``fileDescriptor`.

Returns
-------
exposure : `~lsst.afw.image.Exposure`
    Complete in-memory exposure.

Definition at line 203 of file fitsRawFormatterBase.py.

◆ readImage()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.readImage (   self,
  fileDescriptor 
)
Read just the image component of the Exposure.

Parameters
----------
fileDescriptor : `FileDescriptor`
    Identifies the file to read and parameters to be used for reading.

Returns
-------
image : `~lsst.afw.image.Image`
    In-memory image component.

Definition at line 39 of file fitsRawFormatterBase.py.

◆ readImageComponent()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.readImageComponent (   self,
  fileDescriptor,
  component 
)
Read the image, mask, or variance component of an Exposure.

Parameters
----------
fileDescriptor : `FileDescriptor`
    Identifies the file to read and parameters to be used for reading.
component : `str`, optional
    Component to read from the file.  Always one of "image",
    "variance", or "mask".

Returns
-------
image : `~lsst.afw.image.Image` or `~lsst.afw.image.Mask`
    In-memory image, variance, or mask component.

Definition at line 152 of file fitsRawFormatterBase.py.

◆ readInfoComponent()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.readInfoComponent (   self,
  fileDescriptor,
  component 
)
Read a component held by ExposureInfo.

The implementation provided by FitsRawFormatter provides only "wcs"
and "visitInfo".  When adding support for other components, subclasses
should delegate to `super()` for those and update `readFull` with
similar logic.

Parameters
----------
fileDescriptor : `FileDescriptor`
    Identifies the file to read and parameters to be used for reading.
component : `str`, optional
    Component to read from the file.

Returns
-------
obj : component-dependent
    In-memory component object.

Definition at line 175 of file fitsRawFormatterBase.py.

◆ readMask()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.readMask (   self,
  fileDescriptor 
)
Read just the mask component of the Exposure.

May return None (as the default implementation does) to indicate that
there is no mask information to be extracted (at least not trivially)
from the raw data.  This will prohibit direct reading of just the mask,
and set the mask of the full Exposure to zeros.

Parameters
----------
fileDescriptor : `FileDescriptor`
    Identifies the file to read and parameters to be used for reading.

Returns
-------
mask : `~lsst.afw.image.Mask`
    In-memory mask component.

Definition at line 54 of file fitsRawFormatterBase.py.

◆ readVariance()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.readVariance (   self,
  fileDescriptor 
)
Read just the variance component of the Exposure.

May return None (as the default implementation does) to indicate that
there is no variance information to be extracted (at least not
trivially) from the raw data.  This will prohibit direct reading of
just the variance, and set the variance of the full Exposure to zeros.

Parameters
----------
fileDescriptor : `FileDescriptor`
    Identifies the file to read and parameters to be used for reading.

Returns
-------
image : `~lsst.afw.image.Image`
    In-memory variance component.

Definition at line 74 of file fitsRawFormatterBase.py.

◆ stripMetadata()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.stripMetadata (   self,
  metadata 
)
Remove metadata entries that are parsed into components.

Parameters
----------
metadata : `~lsst.daf.base.PropertyList`
    Header metadata, to be modified in-place.

Definition at line 94 of file fitsRawFormatterBase.py.

◆ write()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.write (   self,
  inMemoryDataset,
  fileDescriptor 
)
Write a Python object to a file.

Parameters
----------
inMemoryDataset : `object`
    The Python object to store.
fileDescriptor : `FileDescriptor`
    Identifies the file to read, type to read it into and parameters
    to be used for reading.

Returns
-------
path : `str`
    The `URI` where the primary file is stored.

Definition at line 238 of file fitsRawFormatterBase.py.


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