lsst.obs.base  18.1.0-14-g2e73c10+1
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 __init__ (self, args, kwargs)
 
def translatorClass (self)
 
def filterDefinitions (self)
 
def readImage (self)
 
def readMask (self)
 
def readVariance (self)
 
def stripMetadata (self)
 
def makeVisitInfo (self)
 
def getDetector (self, id)
 
def makeWcs (self, visitInfo, detector)
 
def makeFilter (self)
 
def readImageComponent (self, component)
 
def readInfoComponent (self, component)
 
def readFull (self, parameters=None)
 
def write (self, inMemoryDataset)
 
def observationInfo (self)
 

Detailed Description

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

Definition at line 38 of file fitsRawFormatterBase.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.__init__ (   self,
  args,
  kwargs 
)

Definition at line 43 of file fitsRawFormatterBase.py.

Member Function Documentation

◆ filterDefinitions()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.filterDefinitions (   self)
`~lsst.obs.base.FilterDefinitions`, defining the filters for this
instrument.

Definition at line 59 of file fitsRawFormatterBase.py.

◆ getDetector()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.getDetector (   self,
  id 
)
Return the detector that acquired this raw exposure.

Parameters
----------
id : `int`
    The identifying number of the detector to get.

Returns
-------
detector : `~lsst.afw.cameraGeom.Detector`
    The detector associated with that ``id``.

Definition at line 125 of file fitsRawFormatterBase.py.

◆ makeFilter()

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

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

Raises
------
NotFoundError
    Raised if the physical filter was not registered via
    `~lsst.afw.image.utils.defineFilter`.

Definition at line 196 of file fitsRawFormatterBase.py.

◆ makeVisitInfo()

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

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

Definition at line 114 of file fitsRawFormatterBase.py.

◆ makeWcs()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.makeWcs (   self,
  visitInfo,
  detector 
)
Create a SkyWcs from information about the exposure.

If VisitInfo is not None, use it and the detector to create a SkyWcs,
otherwise return the metadata-based SkyWcs (always created, so that
the relevant metadata keywords are stripped).

Parameters
----------
visitInfo : `~lsst.afw.image.VisitInfo`
    The information about the telescope boresight and camera
    orientation angle for this exposure.
detector : `~lsst.afw.cameraGeom.Detector`
    The detector used to acquire this exposure.

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

Raises
------
InitialSkyWcsError
    Raised if there is an error generating the SkyWcs, chained from the
    lower-level exception if available.

Definition at line 140 of file fitsRawFormatterBase.py.

◆ observationInfo()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.observationInfo (   self)
The `~astro_metadata_translator.ObservationInfo` extracted from
this file's metadata (`~astro_metadata_translator.ObservationInfo`,
read-only).

Definition at line 309 of file fitsRawFormatterBase.py.

◆ readFull()

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

Parameters
----------
parameters : `dict`, optional
    If specified, a dictionary of slicing parameters that overrides
    those in the `fileDescriptor` attribute.

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

Definition at line 261 of file fitsRawFormatterBase.py.

◆ readImage()

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

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

Definition at line 65 of file fitsRawFormatterBase.py.

◆ readImageComponent()

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

Parameters
----------
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 212 of file fitsRawFormatterBase.py.

◆ readInfoComponent()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.readInfoComponent (   self,
  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
----------
component : `str`, optional
    Component to read from the file.

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

Definition at line 233 of file fitsRawFormatterBase.py.

◆ readMask()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.readMask (   self)
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.

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

Definition at line 75 of file fitsRawFormatterBase.py.

◆ readVariance()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.readVariance (   self)
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.

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

Definition at line 90 of file fitsRawFormatterBase.py.

◆ stripMetadata()

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

Definition at line 105 of file fitsRawFormatterBase.py.

◆ translatorClass()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.translatorClass (   self)
`~astro_metadata_translator.MetadataTranslator` to translate
metadata header to `~astro_metadata_translator.ObservationInfo`.

Definition at line 49 of file fitsRawFormatterBase.py.

◆ write()

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

Parameters
----------
inMemoryDataset : `object`
    The Python object to store.

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

Definition at line 293 of file fitsRawFormatterBase.py.


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