lsst.meas.algorithms.simple_curve.ImageCurve Class Reference

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

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

Static Public Attributes
str	mode = 'IMAGE'

Detailed Description

Definition at line 409 of file simple_curve.py.

Member Function Documentation

evaluate()

lsst.meas.algorithms.simple_curve.ImageCurve.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 420 of file simple_curve.py.

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

fromTable()

lsst.meas.algorithms.simple_curve.ImageCurve.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 412 of file simple_curve.py.

    def fromTable(self, table):
        # Docstring inherited from base classs
        raise NotImplementedError()
 

toTable()

lsst.meas.algorithms.simple_curve.ImageCurve.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 416 of file simple_curve.py.

    def toTable(self):
        # Docstring inherited from base classs
        raise NotImplementedError()
 

Member Data Documentation

mode

str lsst.meas.algorithms.simple_curve.ImageCurve.mode = 'IMAGE'

static

Definition at line 410 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