lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve Class Reference

Inheritance diagram for lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve:

Public Member Functions
	__init__ (self, filename=None)
	setMetadata (self, metadata)
	fromTable (cls, tableList)
	setTransmissionCurveRepresentation (self)
	getTransmissionCurve (self)
	writeFits (self, outputFilename)

Public Attributes
	data
	transmissionCurve
	isSpatiallyConstant

Static Protected Attributes
str	_OBSTYPE = "transmission_curve"
str	_SCHEMA = ""
float	_VERSION = 1.0

Detailed Description

Definition for the TransmissionCurve format used as inputs.

Parameters
----------
filename : `str`
    Filename of a transmission curve dataset.

Definition at line 37 of file transmissionCurve.py.

Constructor & Destructor Documentation

__init__()

lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve.__init__	(		self,
			filename = None )

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 50 of file transmissionCurve.py.

    def __init__(self, filename=None):
        self.data = None
        self.transmissionCurve = None
        self.isSpatiallyConstant = True
        super().__init__()
 
        # Because we are not persisting this calib as itself, we
        # should skip adding any other attributes.
        self.requiredAttributes.update(['isSpatiallyConstant'])
 

Member Function Documentation

fromTable()

lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve.fromTable	(		cls,
			tableList )

Construct intermediate transmission curve from a list of input
tables.  Only the first table is used.

Parameters
----------
tableList : `list` [`astropy.table.Table`]
    List containing input tables.

Returns
-------
calib : `lsst.ip.isr.IntermediateTransmissionCurve`
    The final calibration.

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 65 of file transmissionCurve.py.

    def fromTable(cls, tableList):
        """Construct intermediate transmission curve from a list of input
        tables.  Only the first table is used.
 
        Parameters
        ----------
        tableList : `list` [`astropy.table.Table`]
            List containing input tables.
 
        Returns
        -------
        calib : `lsst.ip.isr.IntermediateTransmissionCurve`
            The final calibration.
        """
        calib = cls()
 
        metadata = tableList[0].meta
        calib.setMetadata(metadata)
        calib.updateMetadata()
 
        calib.data = tableList[0]
        calib.setTransmissionCurveRepresentation()
        return calib
 

getTransmissionCurve()

lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve.getTransmissionCurve

(

self

)

Definition at line 164 of file transmissionCurve.py.

    def getTransmissionCurve(self):
        if self.transmissionCurve is None and self.data is None:
            raise RuntimeError("No transmission curve data found.")
        if self.transmissionCurve is None:
            self.setTransmissionCurveRepresentation()
        return self.transmissionCurve
 

setMetadata()

lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve.setMetadata	(		self,
			metadata )

Store a copy of the supplied metadata with this calibration.

Parameters
----------
metadata : `lsst.daf.base.PropertyList`
    Metadata to associate with the calibration.  Will be copied and
    overwrite existing metadata.

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 60 of file transmissionCurve.py.

    def setMetadata(self, metadata):
        # Inherits from lsst.ip.isr.IsrCalib.setMetadata.
        super().setMetadata(metadata)
 

setTransmissionCurveRepresentation()

lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve.setTransmissionCurveRepresentation

(

self

)

Construct transmission curve representation from the data that was
read.

Raises
------
RuntimeError
    This is raised if no table data exists in the calibration,
    if there are array length mismatches, or if the wavelength
    sampling for multi-amp tables differ.

Definition at line 89 of file transmissionCurve.py.

    def setTransmissionCurveRepresentation(self):
        """Construct transmission curve representation from the data that was
        read.
 
        Raises
        ------
        RuntimeError
            This is raised if no table data exists in the calibration,
            if there are array length mismatches, or if the wavelength
            sampling for multi-amp tables differ.
        """
        if self.data is None:
            raise RuntimeError("No table data was found to convert to a transmission curve!")
 
        throughputKey = None
        if 'wavelength' not in self.data.columns:
            raise RuntimeError("Expected column [wavelength] not found.")
        if 'efficiency' in self.data.columns:
            throughputKey = 'efficiency'
        elif 'throughput' in self.data.columns:
            throughputKey = 'throughput'
        else:
            raise RuntimeError("Expected columns [throughput|efficiency] not found.")
 
        doAverageCurves = False
        if 'amp_name' in self.data.columns:
            doAverageCurves = True
 
        # These will be used to construct the
        # ``lsst.afw.image.TransmissionCurve`` object.
        wavelengths = None
        throughput = None
 
        if doAverageCurves:
            curveStack = None
            amplifierNames = set(self.data['amp_name'])
            comparisonIndices = np.where(self.data['amp_name'] == next(iter(amplifierNames)))
            wavelengths = self.data[comparisonIndices]['wavelength']
 
            for amplifier in amplifierNames:
                indices = np.where(self.data['amp_name'] == amplifier)
                if len(self.data[indices]) != len(self.data[comparisonIndices]):
                    raise RuntimeError("Incompatible lengths in average.")
                if not np.array_equal(self.data[indices]['wavelength'], wavelengths):
                    raise RuntimeError("Mismatch in wavelength samples.")
 
                if curveStack is not None:
                    curveStack = np.column_stack((curveStack, self.data[indices][throughputKey]))
                else:
                    curveStack = self.data[indices][throughputKey]
            throughput = np.mean(curveStack, 1)
 
            # This averaging operation has stripped units.
            throughput = throughput * self.data[throughputKey].unit
        else:
            wavelengths = self.data['wavelength']
            throughput = self.data[throughputKey]
 
        # Convert units:
        # import pdb; pdb.set_trace()
        with cds.enable():
            # These need to be in Angstroms, for consistency.
            wavelengths = wavelengths.to(u.Angstrom).to_value()
 
            if throughput.unit != u.dimensionless_unscaled and throughput.unit != u.UnrecognizedUnit('-'):
                # These need to be fractions, not percent.
                throughput = throughput.to(u.dimensionless_unscaled).to_value()
 
        self.transmissionCurve = TransmissionCurve.makeSpatiallyConstant(
            throughput.astype(np.float64),
            wavelengths.astype(np.float64),
            throughputAtMin=0.0,
            throughputAtMax=0.0
        )
 

writeFits()

lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve.writeFits	(		self,
			outputFilename )

Write the transmission curve data to a file.

Parameters
----------
outputFilename : `str`
    Destination filename.

Returns
-------
outputFilename : `str`
    The output filename actually used.

Raises
------
RuntimeError
    Raised if no transmission curve can be created.

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 171 of file transmissionCurve.py.

    def writeFits(self, outputFilename):
        """Write the transmission curve data to a file.
 
        Parameters
        ----------
        outputFilename : `str`
            Destination filename.
 
        Returns
        -------
        outputFilename : `str`
            The output filename actually used.
 
        Raises
        ------
        RuntimeError
            Raised if no transmission curve can be created.
        """
        if self.transmissionCurve is None and self.data is None:
            raise RuntimeError("No transmission curve data found.")
        if self.transmissionCurve is None:
            self.setTransmissionCurveRepresentation()
 
        return self.transmissionCurve.writeFits(outputFilename)
 
 

Member Data Documentation

_OBSTYPE

str lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve._OBSTYPE = "transmission_curve"

staticprotected

Definition at line 46 of file transmissionCurve.py.

_SCHEMA

str lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve._SCHEMA = ""

staticprotected

Definition at line 47 of file transmissionCurve.py.

_VERSION

float lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve._VERSION = 1.0

staticprotected

Definition at line 48 of file transmissionCurve.py.

data

lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve.data

Definition at line 51 of file transmissionCurve.py.

isSpatiallyConstant

lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve.isSpatiallyConstant

Definition at line 53 of file transmissionCurve.py.

transmissionCurve

lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve.transmissionCurve

Definition at line 52 of file transmissionCurve.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/ip_isr/g02d81e74bb+fa3a7a026e/python/lsst/ip/isr/transmissionCurve.py