lsst.afw.cameraGeom.fitsUtils.DetectorBuilder Class Reference

Public Member Functions
def	__init__ (self, detectorFileName, ampFileNameList, inAmpCoords=True, plateScale=1., radialCoeffs=(0., 1.), clobberMetadata=False, doRaise=True)
def	buildDetector (self)
def	makeExposure (self, im, mask=None, variance=None)

Public Attributes
	inAmpCoords
	defaultAmpMap
	defaultDetectorMap
	detectorMetadata
	ampMetadataList
	detector
	doRaise
	plateScale
	focalPlaneToField

Detailed Description

Parameters
----------
detectorFileName : `str`
    FITS file containing the detector description.
    May use [] notation to specify an extension in an MEF.
ampFileNameList : `list` of `str`
    List of FITS file names to use in building the amps.
    May contain duplicate entries if the raw data are assembled.
inAmpCoords : `bool`
    True if raw data are in amp coordinates, False if raw data
    are assembled into pseudo detector pixel arrays.
plateScale : `float`
    Nominal platescale (arcsec/mm).
radialCoeffs : `iterable` of `float`
    Radial distortion coefficients for a radial polynomial in
    normalized units.
clobberMetadata : `bool`
    Clobber metadata from input files if overridden in
    _sanitizeMetadata().
doRaise : `bool`
    Raise exception if not all non-defaulted keywords are defined?

Definition at line 155 of file fitsUtils.py.

Constructor & Destructor Documentation

__init__()

def lsst.afw.cameraGeom.fitsUtils.DetectorBuilder.__init__	(		self,
			detectorFileName,
			ampFileNameList,
			inAmpCoords = True,
			plateScale = 1.,
			radialCoeffs = (0., 1.),
			clobberMetadata = False,
			doRaise = True
	)

Definition at line 180 of file fitsUtils.py.

                 radialCoeffs=(0., 1.), clobberMetadata=False, doRaise=True):
        self.inAmpCoords = inAmpCoords
        self.defaultAmpMap = self._makeDefaultAmpMap()
        self.defaultDetectorMap = self._makeDefaultDetectorMap()
        self.detectorMetadata = readMetadata(detectorFileName)
        self._sanitizeHeaderMetadata(
            self.detectorMetadata, clobber=clobberMetadata)
        self.ampMetadataList = []
        self.detector = None
        self.doRaise = doRaise
        for fileName in ampFileNameList:
            self.ampMetadataList.append(readMetadata(fileName))
            self._sanitizeHeaderMetadata(
                self.ampMetadataList[-1], clobber=clobberMetadata)
        self.plateScale = plateScale
        self.focalPlaneToField = self._makeRadialTransform(radialCoeffs)

Member Function Documentation

buildDetector()

def lsst.afw.cameraGeom.fitsUtils.DetectorBuilder.buildDetector

(

self

)

Take all the information and build a Detector object.
The Detector object is necessary for doing things like assembly.

Returns
-------
detector : `lsst.afw.cameraGeom.Detector`
     The detector.

Definition at line 405 of file fitsUtils.py.

    def buildDetector(self):
        """Take all the information and build a Detector object.
        The Detector object is necessary for doing things like assembly.

        Returns
        -------
        detector : `lsst.afw.cameraGeom.Detector`
             The detector.
        """
        if self.detector is not None:
            return self.detector

        schema = afwTable.AmpInfoTable.makeMinimalSchema()
        ampInfo = afwTable.AmpInfoCatalog(schema)
        for ampMetadata in self.ampMetadataList:
            record = ampInfo.addNew()
            self.defaultAmpMap.setAttributes(record, ampMetadata, self.doRaise)
            record.setHasRawInfo(True)

        detConfig = afwCameraGeom.DetectorConfig()
        self.defaultDetectorMap.setAttributes(
            detConfig, self.detectorMetadata, self.doRaise)
        self.detector = afwCameraGeom.makeDetector(
            detConfig, ampInfo, self.focalPlaneToField)
        return self.detector

makeExposure()

def lsst.afw.cameraGeom.fitsUtils.DetectorBuilder.makeExposure	(		self,
			im,
			mask = None,
			variance = None
	)

Method for constructing an exposure object from an image and the
information contained in this class to construct the Detector.

Parameters
----------
im : `lsst.afw.image.Image`
    Image used to construct the exposure.
mask : `lsst.afw.image.MaskU`
    Optional mask plane.
variance : `lsst.afw.image.Image`
    Optional variance plance as an image of the same type as im.

Returns
-------
exposure : `lsst.afw.image.Exposure`
    Constructed exposure (specific type will match that of ``im``).

Definition at line 431 of file fitsUtils.py.

    def makeExposure(self, im, mask=None, variance=None):
        """Method for constructing an exposure object from an image and the
        information contained in this class to construct the Detector.

        Parameters
        ----------
        im : `lsst.afw.image.Image`
            Image used to construct the exposure.
        mask : `lsst.afw.image.MaskU`
            Optional mask plane.
        variance : `lsst.afw.image.Image`
            Optional variance plance as an image of the same type as im.

        Returns
        -------
        exposure : `lsst.afw.image.Exposure`
            Constructed exposure (specific type will match that of ``im``).
        """
        if mask is None:
            mask = afwImage.Mask(im.getDimensions())
        if variance is None:
            variance = im
        mi = afwImage.makeMaskedImage(im, mask, variance)
        detector = self.buildDetector()

        exp = afwImage.makeExposure(mi)
        exp.setDetector(detector)
        return exp

Member Data Documentation

ampMetadataList

lsst.afw.cameraGeom.fitsUtils.DetectorBuilder.ampMetadataList

Definition at line 187 of file fitsUtils.py.

defaultAmpMap

lsst.afw.cameraGeom.fitsUtils.DetectorBuilder.defaultAmpMap

Definition at line 182 of file fitsUtils.py.

defaultDetectorMap

lsst.afw.cameraGeom.fitsUtils.DetectorBuilder.defaultDetectorMap

Definition at line 183 of file fitsUtils.py.

detector

lsst.afw.cameraGeom.fitsUtils.DetectorBuilder.detector

Definition at line 188 of file fitsUtils.py.

detectorMetadata

lsst.afw.cameraGeom.fitsUtils.DetectorBuilder.detectorMetadata

Definition at line 184 of file fitsUtils.py.

doRaise

lsst.afw.cameraGeom.fitsUtils.DetectorBuilder.doRaise

Definition at line 189 of file fitsUtils.py.

focalPlaneToField

lsst.afw.cameraGeom.fitsUtils.DetectorBuilder.focalPlaneToField

Definition at line 195 of file fitsUtils.py.

inAmpCoords

lsst.afw.cameraGeom.fitsUtils.DetectorBuilder.inAmpCoords

Definition at line 181 of file fitsUtils.py.

plateScale

lsst.afw.cameraGeom.fitsUtils.DetectorBuilder.plateScale

Definition at line 194 of file fitsUtils.py.

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/afw/18.1.0-22-g936f6a9b4/python/lsst/afw/cameraGeom/fitsUtils.py

---

Generated on Mon Nov 4 2019 08:02:31 for LSSTApplications by   1.8.13