lsst.obs.base  21.0.0-9-g0393deb+2a5fe077cf
Classes | Functions
lsst.obs.base.utils Namespace Reference

Classes

class  InitialSkyWcsError
 

Functions

def createInitialSkyWcs (visitInfo, detector, flipX=False)
 
def createInitialSkyWcsFromBoresight (boresight, orientation, detector, flipX=False)
 
def bboxFromIraf (irafBBoxStr)
 
def getInstrument (instrumentName, registry=None)
 
def setDottedAttr (item, name, value)
 
def setDottedAttrs (item, attrs)
 

Function Documentation

◆ bboxFromIraf()

def lsst.obs.base.utils.bboxFromIraf (   irafBBoxStr)
Return a Box2I corresponding to an IRAF-style BBOX

[x0:x1,y0:y1] where x0 and x1 are the one-indexed start and end columns,
and correspondingly y0 and y1 are the start and end rows.

Definition at line 116 of file utils.py.

◆ createInitialSkyWcs()

def lsst.obs.base.utils.createInitialSkyWcs (   visitInfo,
  detector,
  flipX = False 
)
Create a SkyWcs from the visit information and detector geometry.

A typical usecase for this is to create the initial WCS for a newly-read
raw exposure.


Parameters
----------
visitInfo : `lsst.afw.image.VisitInfo`
    Where to get the telescope boresight and rotator angle from.
detector : `lsst.afw.cameraGeom.Detector`
    Where to get the camera geomtry from.
flipX : `bool`, optional
    If False, +X is along W, if True +X is along E.

Returns
-------
skyWcs : `lsst.afw.geom.SkyWcs`
    The new composed WCS.

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

Definition at line 44 of file utils.py.

◆ createInitialSkyWcsFromBoresight()

def lsst.obs.base.utils.createInitialSkyWcsFromBoresight (   boresight,
  orientation,
  detector,
  flipX = False 
)
Create a SkyWcs from the telescope boresight and detector geometry.

A typical usecase for this is to create the initial WCS for a newly-read
raw exposure.

Parameters
----------
boresight : `lsst.geom.SpherePoint`
    The ICRS boresight RA/Dec
orientation : `lsst.geom.Angle`
    The rotation angle of the focal plane on the sky.
detector : `lsst.afw.cameraGeom.Detector`
    Where to get the camera geomtry from.
flipX : `bool`, optional
    If False, +X is along W, if True +X is along E.

Returns
-------
skyWcs : `lsst.afw.geom.SkyWcs`
    The new composed WCS.

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

Definition at line 80 of file utils.py.

◆ getInstrument()

def lsst.obs.base.utils.getInstrument (   instrumentName,
  registry = None 
)
Return an instance of a named instrument.

If the instrument name not is qualified (does not contain a '.') and a
butler registry is provided, this will attempt to load the instrument using
Instrument.fromName. Otherwise the instrument will be imported and
instantiated.

Parameters
----------
instrumentName : string
    The name or fully-qualified class name of an instrument.
registry : `lsst.daf.butler.Registry`, optional
    Butler registry to query to find information about the instrument, by
    default None

Returns
-------
Instrument subclass instance
    The instantiated instrument.

Raises
------
RuntimeError
    If the instrument can not be imported, instantiated, or obtained from
    the registry.
TypeError
    If the instrument is not a subclass of lsst.obs.base.Instrument.

Definition at line 131 of file utils.py.

◆ setDottedAttr()

def lsst.obs.base.utils.setDottedAttr (   item,
  name,
  value 
)
Set an instance attribute (like `setattr` but accepting hierarchical
names such as ``foo.bar.baz``) If the attribute can not be set as a string,
will attempt to set the attribute with the result of eval'ing the value.

Parameters
----------
item : obj
    Object whose attribute is to be set.
name : `str`
    Name of attribute to set.
value : obj
    New value for the attribute.

Notes
-----
For example if name is ``foo.bar.baz`` then ``item.foo.bar.baz``
is set to the specified value.

Raises
------
AttributeError
    If the item does not have a field specified by name that can be set.
RuntimeError
    If the value can not be set as a string or rendered by eval, or if
    there is an error setting the attribute with the rendered value.

Definition at line 179 of file utils.py.

◆ setDottedAttrs()

def lsst.obs.base.utils.setDottedAttrs (   item,
  attrs 
)

Definition at line 225 of file utils.py.