Inheritance diagram for lsst.meas.algorithms.simple_curve.AmpCurve:
Public Member Functions | |
| def | __init__ (self, amp_name_list, wavelength, efficiency, metadata) |
| def | __eq__ (self, other) |
| 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 | 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) |
Public Attributes | |
| data | |
| wavelength | |
| efficiency | |
| metadata | |
Static Public Attributes | |
| string | mode = 'AMP' |
| subclasses = dict() | |
Detailed Description
Subclass of `Curve` that represents a curve per amp.
Parameters
----------
amp_name_list : iterable of `str`
The name of the amp for each entry
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 331 of file simple_curve.py.
Constructor & Destructor Documentation
◆ __init__()
| def lsst.meas.algorithms.simple_curve.AmpCurve.__init__ | ( | self, | |
| amp_name_list, | |||
| wavelength, | |||
| efficiency, | |||
| metadata | |||
| ) |
Definition at line 347 of file simple_curve.py.
Member Function Documentation
◆ __eq__()
| def lsst.meas.algorithms.simple_curve.AmpCurve.__eq__ | ( | self, | |
| other | |||
| ) |
Definition at line 359 of file simple_curve.py.
◆ __init_subclass__()
|
inherited |
Register subclasses with the abstract base class
Definition at line 126 of file simple_curve.py.
◆ compare_metadata()
|
inherited |
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 139 of file simple_curve.py.
◆ evaluate()
| def lsst.meas.algorithms.simple_curve.AmpCurve.evaluate | ( | self, | |
| detector, | |||
| position, | |||
| wavelength, | |||
kind = 'linear', |
|||
bounds_error = False, |
|||
fill_value = 0 |
|||
| ) |
Definition at line 401 of file simple_curve.py.
◆ fromTable()
| def lsst.meas.algorithms.simple_curve.AmpCurve.fromTable | ( | cls, | |
| table | |||
| ) |
Definition at line 370 of file simple_curve.py.
◆ getMetadata()
|
inherited |
Return metadata
Returns
-------
metadata : `dict`
Dictionary of metadata for this curve.
Definition at line 187 of file simple_curve.py.
◆ interpolate()
|
inherited |
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()
|
inherited |
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()
|
inherited |
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.AmpCurve.toTable | ( | self | ) |
Definition at line 376 of file simple_curve.py.
◆ writeFits()
|
inherited |
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()
|
inherited |
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.
Member Data Documentation
◆ data
| lsst.meas.algorithms.simple_curve.AmpCurve.data |
Definition at line 350 of file simple_curve.py.
◆ efficiency
|
inherited |
Definition at line 51 of file simple_curve.py.
◆ metadata
|
inherited |
Definition at line 54 of file simple_curve.py.
◆ mode
|
static |
Definition at line 345 of file simple_curve.py.
◆ subclasses
|
staticinherited |
Definition at line 43 of file simple_curve.py.
◆ wavelength
|
inherited |
Definition at line 50 of file simple_curve.py.
The documentation for this class was generated from the following file:
- python/lsst/meas/algorithms/simple_curve.py
