|
def | __init__ (self, wavelength, efficiency, metadata) |
|
def | fromTable (cls, table) |
|
def | toTable (self) |
|
def | evaluate (self, detector, position, wavelength, kind='linear', bounds_error=False, fill_value=0) |
|
def | __init_subclass__ (cls, **kwargs) |
|
def | __eq__ (self, other) |
|
def | compare_metadata (self, other, keys_to_compare=['MODE', 'TYPE', 'CALIBDATE', 'INSTRUME', 'OBSTYPE', 'DETECTOR']) |
|
def | interpolate (self, wavelengths, values, wavelength, kind, bounds_error, fill_value) |
|
def | getMetadata (self) |
|
def | readText (cls, filename) |
|
def | readFits (cls, filename) |
|
def | writeText (self, filename) |
|
def | writeFits (self, filename) |
|
An abstract class to represent an arbitrary curve with
interpolation.
Definition at line 38 of file simple_curve.py.
◆ __init__()
def lsst.meas.algorithms.simple_curve.Curve.__init__ |
( |
|
self, |
|
|
|
wavelength, |
|
|
|
efficiency, |
|
|
|
metadata |
|
) |
| |
◆ __eq__()
def lsst.meas.algorithms.simple_curve.Curve.__eq__ |
( |
|
self, |
|
|
|
other |
|
) |
| |
◆ __init_subclass__()
def lsst.meas.algorithms.simple_curve.Curve.__init_subclass__ |
( |
|
cls, |
|
|
** |
kwargs |
|
) |
| |
Register subclasses with the abstract base class
Definition at line 126 of file simple_curve.py.
◆ _check_cols()
def lsst.meas.algorithms.simple_curve.Curve._check_cols |
( |
|
cols, |
|
|
|
table |
|
) |
| |
|
staticprotected |
◆ _to_table_with_meta()
def lsst.meas.algorithms.simple_curve.Curve._to_table_with_meta |
( |
|
self | ) |
|
|
protected |
Compute standard metadata before writing file out
Definition at line 243 of file simple_curve.py.
◆ compare_metadata()
def lsst.meas.algorithms.simple_curve.Curve.compare_metadata |
( |
|
self, |
|
|
|
other, |
|
|
|
keys_to_compare = ['MODE', 'TYPE', 'CALIBDATE', 'INSTRUME', 'OBSTYPE', 'DETECTOR'] |
|
) |
| |
Compare metadata in this object to another.
Parameters
----------
other : `Curve`
The object with which to compare metadata.
keys_to_compare : `list`
List of metadata keys to compare.
Returns
-------
same : `bool`
Are the metadata the same?
Definition at line 138 of file simple_curve.py.
◆ evaluate()
def lsst.meas.algorithms.simple_curve.Curve.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 in lsst.meas.algorithms.simple_curve.DetectorCurve, lsst.meas.algorithms.simple_curve.AmpCurve, and lsst.meas.algorithms.simple_curve.ImageCurve.
Definition at line 87 of file simple_curve.py.
◆ fromTable()
def lsst.meas.algorithms.simple_curve.Curve.fromTable |
( |
|
cls, |
|
|
|
table |
|
) |
| |
◆ getMetadata()
def lsst.meas.algorithms.simple_curve.Curve.getMetadata |
( |
|
self | ) |
|
Return metadata
Returns
-------
metadata : `dict`
Dictionary of metadata for this curve.
Definition at line 187 of file simple_curve.py.
◆ interpolate()
def lsst.meas.algorithms.simple_curve.Curve.interpolate |
( |
|
self, |
|
|
|
wavelengths, |
|
|
|
values, |
|
|
|
wavelength, |
|
|
|
kind, |
|
|
|
bounds_error, |
|
|
|
fill_value |
|
) |
| |
Interplate the curve at the specified wavelength(s).
Parameters
----------
wavelengths : `astropy.units.Quantity`
The wavelength values for the curve.
values : `astropy.units.Quantity`
The y-values for the curve.
wavelength : `astropy.units.Quantity`
The wavelength(s) at which to make the interpolation.
kind : `str`
The type of interpolation to do. See documentation for
`scipy.interpolate.interp1d` for accepted values.
Returns
-------
value : `astropy.units.Quantity`
Interpolated value(s)
Definition at line 159 of file simple_curve.py.
◆ readFits()
def lsst.meas.algorithms.simple_curve.Curve.readFits |
( |
|
cls, |
|
|
|
filename |
|
) |
| |
Class method for constructing a `Curve` object from
the standardized FITS format.
Parameters
----------
filename : `str`
Path to the FITS file to read.
Returns
-------
curve : `Curve`
A `Curve` subclass of the appropriate type according
to the table metadata
Definition at line 218 of file simple_curve.py.
◆ readText()
def lsst.meas.algorithms.simple_curve.Curve.readText |
( |
|
cls, |
|
|
|
filename |
|
) |
| |
Class method for constructing a `Curve` object from
the standardized text format.
Parameters
----------
filename : `str`
Path to the text file to read.
Returns
-------
curve : `Curve`
A `Curve` subclass of the appropriate type according
to the table metadata
Definition at line 199 of file simple_curve.py.
◆ toTable()
def lsst.meas.algorithms.simple_curve.Curve.toTable |
( |
|
self | ) |
|
◆ writeFits()
def lsst.meas.algorithms.simple_curve.Curve.writeFits |
( |
|
self, |
|
|
|
filename |
|
) |
| |
Write the `Curve` out to a FITS file.
Parameters
----------
filename : `str`
Path to the FITS file to write.
Returns
-------
filename : `str`
Because this method forces a particular extension return
the name of the file actually written.
Definition at line 274 of file simple_curve.py.
◆ writeText()
def lsst.meas.algorithms.simple_curve.Curve.writeText |
( |
|
self, |
|
|
|
filename |
|
) |
| |
Write the `Curve` out to a text file.
Parameters
----------
filename : `str`
Path to the text file to write.
Returns
-------
filename : `str`
Because this method forces a particular extension return
the name of the file actually written.
Definition at line 253 of file simple_curve.py.
◆ efficiency
lsst.meas.algorithms.simple_curve.Curve.efficiency |
◆ metadata
lsst.meas.algorithms.simple_curve.Curve.metadata |
◆ mode
str lsst.meas.algorithms.simple_curve.Curve.mode = '' |
|
static |
◆ subclasses
dict lsst.meas.algorithms.simple_curve.Curve.subclasses = dict() |
|
static |
◆ wavelength
lsst.meas.algorithms.simple_curve.Curve.wavelength |
The documentation for this class was generated from the following file: