lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase Class Reference

Inheritance diagram for lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase:

Public Member Functions
def	__init__ (self, *args, **kwargs)
def	fromMetadata (cls, metadata, obsInfo=None, storageClass=None, location=None)
def	translatorClass (self)
def	filterDefinitions (self)
def	readImage (self)
def	readMask (self)
def	readVariance (self)
def	isOnSky (self)
def	stripMetadata (self)
def	makeVisitInfo (self)
def	getDetector (self, id)
def	makeWcs (self, visitInfo, detector)
def	makeFilter (self)
def	readComponent (self, component, parameters=None)
def	readFull (self, parameters=None)
def	readRawHeaderWcs (self, parameters=None)
def	write (self, inMemoryDataset)
def	observationInfo (self)
def	metadata (self)
def	readMetadata (self)
def	read (self, component=None, parameters=None)

Static Public Attributes
string	extension = ".fits"

Detailed Description

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

Definition at line 39 of file fitsRawFormatterBase.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 44 of file fitsRawFormatterBase.py.

    def __init__(self, *args, **kwargs):
        self.filterDefinitions.reset()
        self.filterDefinitions.defineFilters()
        super().__init__(*args, **kwargs)
 

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

    def filterDefinitions(self):
        """`~lsst.obs.base.FilterDefinitions`, defining the filters for this
        instrument.
        """
        return None
 

fromMetadata()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.fromMetadata	(		cls,
			metadata,
			obsInfo = None,
			storageClass = None,
			location = None
	)

Construct a possibly-limited formatter from known metadata.

Parameters
----------
metadata : `lsst.daf.base.PropertyList`
    Raw header metadata, with any fixes (see
    `astro_metadata_translator.fix_header`) applied but nothing
    stripped.
obsInfo : `astro_metadata_translator.ObservationInfo`, optional
    Structured information already extracted from ``metadata``.
    If not provided, will be read from ``metadata`` on first use.
storageClass : `lsst.daf.butler.StorageClass`, optional
    StorageClass for this file.  If not provided, the formatter will
    only support `makeWcs`, `makeVisitInfo`, `makeFilter`, and other
    operations that operate purely on metadata and not the actual file.
location : `lsst.daf.butler.Location`, optional.
    Location of the file.  If not provided, the formatter will only
    support `makeWcs`, `makeVisitInfo`, `makeFilter`, and other
    operations that operate purely on metadata and not the actual file.

Returns
-------
formatter : `FitsRawFormatterBase`
    An instance of ``cls``.

Definition at line 50 of file fitsRawFormatterBase.py.

    def fromMetadata(cls, metadata, obsInfo=None, storageClass=None, location=None):
        """Construct a possibly-limited formatter from known metadata.
 
        Parameters
        ----------
        metadata : `lsst.daf.base.PropertyList`
            Raw header metadata, with any fixes (see
            `astro_metadata_translator.fix_header`) applied but nothing
            stripped.
        obsInfo : `astro_metadata_translator.ObservationInfo`, optional
            Structured information already extracted from ``metadata``.
            If not provided, will be read from ``metadata`` on first use.
        storageClass : `lsst.daf.butler.StorageClass`, optional
            StorageClass for this file.  If not provided, the formatter will
            only support `makeWcs`, `makeVisitInfo`, `makeFilter`, and other
            operations that operate purely on metadata and not the actual file.
        location : `lsst.daf.butler.Location`, optional.
            Location of the file.  If not provided, the formatter will only
            support `makeWcs`, `makeVisitInfo`, `makeFilter`, and other
            operations that operate purely on metadata and not the actual file.
 
        Returns
        -------
        formatter : `FitsRawFormatterBase`
            An instance of ``cls``.
        """
        self = cls(FileDescriptor(location, storageClass))
        self._metadata = metadata
        self._observationInfo = obsInfo
        return self
 

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``.

Reimplemented in lsst.obs.decam.rawFormatter.DarkEnergyCameraRawFormatter.

Definition at line 179 of file fitsRawFormatterBase.py.

    def 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``.
        """
        raise NotImplementedError("Must be implemented by subclasses.")
 

isOnSky()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.isOnSky

(

self

)

Boolean to determine if the exposure is thought to be on the sky.

Returns
-------
onSky : `bool`
    Returns `True` if the observation looks like it was taken on the
    sky.  Returns `False` if this observation looks like a calibration
    observation.

Notes
-----
If there is tracking RA/Dec information associated with the
observation it is assumed that the observation is on sky.
Currently the observation type is not checked.

Definition at line 139 of file fitsRawFormatterBase.py.

    def isOnSky(self):
        """Boolean to determine if the exposure is thought to be on the sky.
 
        Returns
        -------
        onSky : `bool`
            Returns `True` if the observation looks like it was taken on the
            sky.  Returns `False` if this observation looks like a calibration
            observation.
 
        Notes
        -----
        If there is tracking RA/Dec information associated with the
        observation it is assumed that the observation is on sky.
        Currently the observation type is not checked.
        """
        if self.observationInfo.tracking_radec is None:
            return False
        return True
 

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

    def 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`.
        """
        return lsst.afw.image.Filter(self.observationInfo.physical_filter)
 

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

    def makeVisitInfo(self):
        """Construct a VisitInfo from metadata.
 
        Returns
        -------
        visitInfo : `~lsst.afw.image.VisitInfo`
            Structured metadata about the observation.
        """
        return MakeRawVisitInfoViaObsInfo.observationInfo2visitInfo(self.observationInfo)
 

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

    def 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.
        """
        if not self.isOnSky():
            # This is not an on-sky observation
            return None
 
        skyWcs = self._createSkyWcsFromMetadata()
 
        log = lsst.log.Log.getLogger("fitsRawFormatter")
        if visitInfo is None:
            msg = "No VisitInfo; cannot access boresight information. Defaulting to metadata-based SkyWcs."
            log.warn(msg)
            if skyWcs is None:
                raise InitialSkyWcsError("Failed to create both metadata and boresight-based SkyWcs."
                                         "See warnings in log messages for details.")
            return skyWcs
        skyWcs = createInitialSkyWcs(visitInfo, detector)
 
        return skyWcs
 

metadata()

def lsst.obs.base.fitsExposureFormatter.FitsExposureFormatter.metadata (   self )

inherited

The metadata read from this file. It will be stripped as
components are extracted from it
(`lsst.daf.base.PropertyList`).

Definition at line 36 of file fitsExposureFormatter.py.

    def metadata(self):
        """The metadata read from this file. It will be stripped as
        components are extracted from it
        (`lsst.daf.base.PropertyList`).
        """
        if self._metadata is None:
            self._metadata = self.readMetadata()
        return self._metadata
 

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

    def observationInfo(self):
        """The `~astro_metadata_translator.ObservationInfo` extracted from
        this file's metadata (`~astro_metadata_translator.ObservationInfo`,
        read-only).
        """
        if self._observationInfo is None:
            self._observationInfo = ObservationInfo(self.metadata, translator_class=self.translatorClass)
        return self._observationInfo

read()

def lsst.obs.base.fitsExposureFormatter.FitsExposureFormatter.read (   self,   component = None,   parameters = None  )

inherited

Read data from a file.

Parameters
----------
component : `str`, optional
    Component to read from the file. Only used if the `StorageClass`
    for reading differed from the `StorageClass` used to write the
    file.
parameters : `dict`, optional
    If specified, a dictionary of slicing parameters that
    overrides those in ``fileDescriptor``.

Returns
-------
inMemoryDataset : `object`
    The requested data as a Python object. The type of object
    is controlled by the specific formatter.

Raises
------
ValueError
    Component requested but this file does not seem to be a concrete
    composite.
KeyError
    Raised when parameters passed with fileDescriptor are not
    supported.

Definition at line 166 of file fitsExposureFormatter.py.

    def read(self, component=None, parameters=None):
        """Read data from a file.
 
        Parameters
        ----------
        component : `str`, optional
            Component to read from the file. Only used if the `StorageClass`
            for reading differed from the `StorageClass` used to write the
            file.
        parameters : `dict`, optional
            If specified, a dictionary of slicing parameters that
            overrides those in ``fileDescriptor``.
 
        Returns
        -------
        inMemoryDataset : `object`
            The requested data as a Python object. The type of object
            is controlled by the specific formatter.
 
        Raises
        ------
        ValueError
            Component requested but this file does not seem to be a concrete
            composite.
        KeyError
            Raised when parameters passed with fileDescriptor are not
            supported.
        """
        fileDescriptor = self.fileDescriptor
        if fileDescriptor.readStorageClass != fileDescriptor.storageClass:
            if component == "metadata":
                self.stripMetadata()
                return self.metadata
            elif component is not None:
                return self.readComponent(component, parameters)
            else:
                raise ValueError("Storage class inconsistency ({} vs {}) but no"
                                 " component requested".format(fileDescriptor.readStorageClass.name,
                                                               fileDescriptor.storageClass.name))
        return self.readFull()
 

readComponent()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.readComponent	(		self,
			component,
			parameters = None
	)

Read a component held by the Exposure.

Parameters
----------
component : `str`, optional
    Component to read from the file.
parameters : `dict`, optional
    If specified, a dictionary of slicing parameters that
    overrides those in ``fileDescriptor``.

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

Raises
------
KeyError
    Raised if the requested component cannot be handled.

Reimplemented from lsst.obs.base.fitsExposureFormatter.FitsExposureFormatter.

Definition at line 274 of file fitsRawFormatterBase.py.

    def readComponent(self, component, parameters=None):
        """Read a component held by the Exposure.
 
        Parameters
        ----------
        component : `str`, optional
            Component to read from the file.
        parameters : `dict`, optional
            If specified, a dictionary of slicing parameters that
            overrides those in ``fileDescriptor``.
 
        Returns
        -------
        obj : component-dependent
            In-memory component object.
 
        Raises
        ------
        KeyError
            Raised if the requested component cannot be handled.
        """
        if component == "image":
            return self.readImage()
        elif component == "mask":
            return self.readMask()
        elif component == "variance":
            return self.readVariance()
        elif component == "filter":
            return self.makeFilter()
        elif component == "visitInfo":
            return self.makeVisitInfo()
        elif component == "wcs":
            detector = self.getDetector(self.observationInfo.detector_num)
            visitInfo = self.makeVisitInfo()
            return self.makeWcs(visitInfo, detector)
        return None
 

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.

Reimplemented from lsst.obs.base.fitsExposureFormatter.FitsExposureFormatter.

Definition at line 311 of file fitsRawFormatterBase.py.

    def 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.
        """
        from lsst.afw.image import makeExposure, makeMaskedImage
        full = makeExposure(makeMaskedImage(self.readImage()))
        mask = self.readMask()
        if mask is not None:
            full.setMask(mask)
        variance = self.readVariance()
        if variance is not None:
            full.setVariance(variance)
        full.setDetector(self.getDetector(self.observationInfo.detector_num))
        info = full.getInfo()
        info.setFilter(self.makeFilter())
        info.setVisitInfo(self.makeVisitInfo())
        info.setWcs(self.makeWcs(info.getVisitInfo(), info.getDetector()))
        # We don't need to call stripMetadata() here because it has already
        # been stripped during creation of the ObservationInfo, WCS, etc.
        full.setMetadata(self.metadata)
        return full
 

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.

Reimplemented in lsst.obs.decam.rawFormatter.DarkEnergyCameraCPCalibFormatter, and lsst.obs.decam.rawFormatter.DarkEnergyCameraRawFormatter.

Definition at line 99 of file fitsRawFormatterBase.py.

    def readImage(self):
        """Read just the image component of the Exposure.
 
        Returns
        -------
        image : `~lsst.afw.image.Image`
            In-memory image component.
        """
        return lsst.afw.image.ImageU(self.fileDescriptor.location.path)
 

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

    def 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.
        """
        return None
 

readMetadata()

def lsst.obs.base.fitsExposureFormatter.FitsExposureFormatter.readMetadata (   self )

inherited

Read all header metadata directly into a PropertyList.

Returns
-------
metadata : `~lsst.daf.base.PropertyList`
    Header metadata.

Reimplemented in lsst.obs.decam.rawFormatter.DarkEnergyCameraRawFormatter.

Definition at line 45 of file fitsExposureFormatter.py.

    def readMetadata(self):
        """Read all header metadata directly into a PropertyList.
 
        Returns
        -------
        metadata : `~lsst.daf.base.PropertyList`
            Header metadata.
        """
        from lsst.afw.image import readMetadata
        md = readMetadata(self.fileDescriptor.location.path)
        fix_header(md)
        return md
 

readRawHeaderWcs()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.readRawHeaderWcs	(		self,
			parameters = None
	)

Read the SkyWcs stored in the un-modified raw FITS WCS header keys.

Definition at line 343 of file fitsRawFormatterBase.py.

    def readRawHeaderWcs(self, parameters=None):
        """Read the SkyWcs stored in the un-modified raw FITS WCS header keys.
        """
        return lsst.afw.geom.makeSkyWcs(lsst.afw.fits.readMetadata(self.fileDescriptor))
 

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

    def 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.
        """
        return None
 

stripMetadata()

def lsst.obs.base.fitsRawFormatterBase.FitsRawFormatterBase.stripMetadata

(

self

)

Remove metadata entries that are parsed into components.

Reimplemented from lsst.obs.base.fitsExposureFormatter.FitsExposureFormatter.

Definition at line 159 of file fitsRawFormatterBase.py.

    def stripMetadata(self):
        """Remove metadata entries that are parsed into components.
        """
        # NOTE: makeVisitInfo() may not strip any metadata itself, but calling
        # it ensures that ObservationInfo is created from the metadata, which
        # will strip the VisitInfo keys and more.
        self.makeVisitInfo()
        self._createSkyWcsFromMetadata()
 

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

    def translatorClass(self):
        """`~astro_metadata_translator.MetadataTranslator` to translate
        metadata header to `~astro_metadata_translator.ObservationInfo`.
        """
        return None
 

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.

Reimplemented from lsst.obs.base.fitsExposureFormatter.FitsExposureFormatter.

Definition at line 348 of file fitsRawFormatterBase.py.

    def 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.
        """
        raise NotImplementedError("Raw data cannot be `put`.")
 

Member Data Documentation

extension

string lsst.obs.base.fitsExposureFormatter.FitsExposureFormatter.extension = ".fits"

staticinherited

Definition at line 32 of file fitsExposureFormatter.py.

---

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

• /j/snowflake/release/lsstsw/stack/1a1d771/Linux64/obs_base/20.0.0/python/lsst/obs/base/fitsRawFormatterBase.py