lsst.meas.algorithms  20.0.0-9-g70cec07d+482e8042f7
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.algorithms.simple_curve.DetectorCurve Class Reference
Inheritance diagram for lsst.meas.algorithms.simple_curve.DetectorCurve:
lsst.meas.algorithms.simple_curve.Curve

Public Member Functions

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

 wavelength
 
 efficiency
 
 metadata
 

Static Public Attributes

string mode = 'DETECTOR'
 
 subclasses = dict()
 

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__()

def 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.

◆ __init_subclass__()

def lsst.meas.algorithms.simple_curve.Curve.__init_subclass__ (   cls,
**  kwargs 
)
inherited
Register subclasses with the abstract base class

Definition at line 126 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'] 
)
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 138 of file simple_curve.py.

◆ evaluate()

def 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.

◆ fromTable()

def 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.

◆ getMetadata()

def lsst.meas.algorithms.simple_curve.Curve.getMetadata (   self)
inherited
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 
)
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()

def lsst.meas.algorithms.simple_curve.Curve.readFits (   cls,
  filename 
)
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()

def lsst.meas.algorithms.simple_curve.Curve.readText (   cls,
  filename 
)
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.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.

◆ writeFits()

def lsst.meas.algorithms.simple_curve.Curve.writeFits (   self,
  filename 
)
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()

def lsst.meas.algorithms.simple_curve.Curve.writeText (   self,
  filename 
)
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

◆ efficiency

lsst.meas.algorithms.simple_curve.Curve.efficiency
inherited

Definition at line 51 of file simple_curve.py.

◆ metadata

lsst.meas.algorithms.simple_curve.Curve.metadata
inherited

Definition at line 54 of file simple_curve.py.

◆ mode

string lsst.meas.algorithms.simple_curve.DetectorCurve.mode = 'DETECTOR'
static

Definition at line 308 of file simple_curve.py.

◆ subclasses

lsst.meas.algorithms.simple_curve.Curve.subclasses = dict()
staticinherited

Definition at line 43 of file simple_curve.py.

◆ wavelength

lsst.meas.algorithms.simple_curve.Curve.wavelength
inherited

Definition at line 50 of file simple_curve.py.


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