lsst.obs.base  20.0.0-20-g8c202bc
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.obs.base.makeRawVisitInfoViaObsInfo.MakeRawVisitInfoViaObsInfo Class Reference
Inheritance diagram for lsst.obs.base.makeRawVisitInfoViaObsInfo.MakeRawVisitInfoViaObsInfo:

Public Member Functions

def __init__ (self, log=None, doStripHeader=False)
 
def __call__ (self, md, exposureId=None)
 

Static Public Member Functions

def observationInfo2visitInfo (obsInfo, log=None)
 

Public Attributes

 log
 
 doStripHeader
 

Static Public Attributes

 metadataTranslator = None
 

Detailed Description

Base class functor to make a VisitInfo from the FITS header of a
raw image using `~astro_metadata_translator.ObservationInfo` translators.

Subclasses can be used if a specific
`~astro_metadata_translator.MetadataTranslator` translator should be used.

The design philosophy is to make a best effort and log warnings of
problems, rather than raising exceptions, in order to extract as much
VisitInfo information as possible from a messy FITS header without the
user needing to add a lot of error handling.

Parameters
----------
log : `lsst.log.Log` or None
    Logger to use for messages.
    (None to use ``Log.getLogger("MakeRawVisitInfoViaObsInfo")``).
doStripHeader : `bool`, optional
    Strip header keywords from the metadata as they are used?

Definition at line 45 of file makeRawVisitInfoViaObsInfo.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.makeRawVisitInfoViaObsInfo.MakeRawVisitInfoViaObsInfo.__init__ (   self,
  log = None,
  doStripHeader = False 
)

Definition at line 70 of file makeRawVisitInfoViaObsInfo.py.

Member Function Documentation

◆ __call__()

def lsst.obs.base.makeRawVisitInfoViaObsInfo.MakeRawVisitInfoViaObsInfo.__call__ (   self,
  md,
  exposureId = None 
)
Construct a VisitInfo and strip associated data from the metadata.

Parameters
----------
md : `lsst.daf.base.PropertyList` or `lsst.daf.base.PropertySet`
    Metadata to pull from.
    May be modified if ``stripHeader`` is ``True``.
exposureId : `int`, optional
    Ignored.  Here for compatibility with `MakeRawVisitInfo`.

Returns
-------
visitInfo : `lsst.afw.image.VisitInfo`
    `~lsst.afw.image.VisitInfo` derived from the header using
    a `~astro_metadata_translator.MetadataTranslator`.

Definition at line 76 of file makeRawVisitInfoViaObsInfo.py.

◆ observationInfo2visitInfo()

def lsst.obs.base.makeRawVisitInfoViaObsInfo.MakeRawVisitInfoViaObsInfo.observationInfo2visitInfo (   obsInfo,
  log = None 
)
static
Construct a `~lsst.afw.image.VisitInfo` from an
`~astro_metadata_translator.ObservationInfo`

Parameters
----------
obsInfo : `astro_metadata_translator.ObservationInfo`
    Information gathered from the observation metadata.
log : `logging.Logger` or `lsst.log.Log`, optional
    Logger to use for logging informational messages.
    If `None` logging will be disabled.

Returns
-------
visitInfo : `lsst.afw.image.VisitInfo`
    `~lsst.afw.image.VisitInfo` derived from the supplied
    `~astro_metadata_translator.ObservationInfo`.

Definition at line 104 of file makeRawVisitInfoViaObsInfo.py.

Member Data Documentation

◆ doStripHeader

lsst.obs.base.makeRawVisitInfoViaObsInfo.MakeRawVisitInfoViaObsInfo.doStripHeader

Definition at line 74 of file makeRawVisitInfoViaObsInfo.py.

◆ log

lsst.obs.base.makeRawVisitInfoViaObsInfo.MakeRawVisitInfoViaObsInfo.log

Definition at line 73 of file makeRawVisitInfoViaObsInfo.py.

◆ metadataTranslator

lsst.obs.base.makeRawVisitInfoViaObsInfo.MakeRawVisitInfoViaObsInfo.metadataTranslator = None
static

Definition at line 66 of file makeRawVisitInfoViaObsInfo.py.


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