lsst.meas.algorithms.simple_curve.DetectorCurve Class Reference

Inheritance diagram for lsst.meas.algorithms.simple_curve.DetectorCurve:

Public Member Functions
	__eq__ (self, other)
	fromTable (cls, table)
	toTable (self)
	evaluate (self, detector, position, wavelength, kind='linear', bounds_error=False, fill_value=0)

Public Attributes
	wavelength
	efficiency

Static Public Attributes
str	mode = 'DETECTOR'

Detailed Description

Subclass of `Curve` that represents a single curve per detector.

Parameters
----------
wavelength : `astropy.units.Quantity`
    Wavelength values for this curve
efficiency : `astropy.units.Quantity`
    Quantum efficiency values for this curve
metadata : `dict`
    Dictionary of metadata for this curve

Definition at line 296 of file simple_curve.py.

Member Function Documentation

__eq__()

lsst.meas.algorithms.simple_curve.DetectorCurve.__eq__	(		self,
			other )

Define equality for this class

Reimplemented from lsst.meas.algorithms.simple_curve.Curve.

Definition at line 310 of file simple_curve.py.

    def __eq__(self, other):
        return (self.compare_metadata(other)
                and numpy.array_equal(self.wavelength, other.wavelength)
                and numpy.array_equal(self.wavelength, other.wavelength))
 

evaluate()

lsst.meas.algorithms.simple_curve.DetectorCurve.evaluate	(		self,
			detector,
			position,
			wavelength,
			kind = 'linear',
			bounds_error = False,
			fill_value = 0 )

Interpolate the curve at the specified position and wavelength.

Parameters
----------
detector : `lsst.afw.cameraGeom.Detector`
    Is used to find the appropriate curve given the position for
    curves that vary over the detector.  Ignored in the case where
    there is only a single curve per detector.
position : `lsst.geom.Point2D`
    The position on the detector at which to evaluate the curve.
wavelength : `astropy.units.Quantity`
    The wavelength(s) at which to make the interpolation.
kind : `str`, optional
    The type of interpolation to do (default is 'linear').
    See documentation for `scipy.interpolate.interp1d` for
    accepted values.
bounds_error : `bool`, optional
    Raise error if interpolating outside the range of x?
    (default is False)
fill_value : `float`, optional
    Fill values outside the range of x with this value
    (default is 0).

Returns
-------
value : `astropy.units.Quantity`
    Interpolated value(s).  Number of values returned will match the
    length of `wavelength`.

Raises
------
ValueError
    If the ``bounds_error`` is changed from the default, it will raise
    a `ValueError` if evaluating outside the bounds of the curve.

Reimplemented from lsst.meas.algorithms.simple_curve.Curve.

Definition at line 325 of file simple_curve.py.

    def evaluate(self, detector, position, wavelength, kind='linear', bounds_error=False, fill_value=0):
        # Docstring inherited from base classs
        return self.interpolate(self.wavelength, self.efficiency, wavelength,
                                kind=kind, bounds_error=bounds_error, fill_value=fill_value)
 
 

fromTable()

lsst.meas.algorithms.simple_curve.DetectorCurve.fromTable	(		cls,
			table )

Class method for constructing a `Curve` object.

Parameters
----------
table : `astropy.table.QTable`
    Table containing metadata and columns necessary
    for constructing a `Curve` object.

Returns
-------
curve : `Curve`
    A `Curve` subclass of the appropriate type according
    to the table metadata

Reimplemented from lsst.meas.algorithms.simple_curve.Curve.

Definition at line 316 of file simple_curve.py.

    def fromTable(cls, table):
        # Docstring inherited from base classs
        cls._check_cols(['wavelength', 'efficiency'], table)
        return cls(table['wavelength'], table['efficiency'], table.meta)
 

toTable()

lsst.meas.algorithms.simple_curve.DetectorCurve.toTable

(

self

)

Convert this `Curve` object to an `astropy.table.QTable`.

Returns
-------
table : `astropy.table.QTable`
    A table object containing the data from this `Curve`.

Reimplemented from lsst.meas.algorithms.simple_curve.Curve.

Definition at line 321 of file simple_curve.py.

    def toTable(self):
        # Docstring inherited from base classs
        return QTable({'wavelength': self.wavelength, 'efficiency': self.efficiency}, meta=self.metadata)
 

Member Data Documentation

efficiency

lsst.meas.algorithms.simple_curve.DetectorCurve.efficiency

Definition at line 327 of file simple_curve.py.

mode

str lsst.meas.algorithms.simple_curve.DetectorCurve.mode = 'DETECTOR'

static

Definition at line 308 of file simple_curve.py.

wavelength

lsst.meas.algorithms.simple_curve.DetectorCurve.wavelength

Definition at line 312 of file simple_curve.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_algorithms/ge6526c86ff+3a7c1ac5f1/python/lsst/meas/algorithms/simple_curve.py