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)

	__init_subclass__ (cls, **kwargs)

	__eq__ (self, other)

	compare_metadata (self, other, keys_to_compare=['MODE', 'TYPE', 'CALIBDATE', 'INSTRUME', 'OBSTYPE', 'DETECTOR'])

	interpolate (self, wavelengths, values, wavelength, kind, bounds_error, fill_value)

	getMetadata (self)

	readText (cls, filename)

	readFits (cls, filename)

	writeText (self, filename)

	writeFits (self, filename)

Public Attributes
	wavelength = wavelength

	efficiency = efficiency

	metadata = metadata

Static Public Attributes
str	mode = ''

	subclasses = dict()

Protected Member Functions
	_to_table_with_meta (self)

Static Protected Member Functions
	_check_cols (cols, table)

Detailed Description

Definition at line 409 of file simple_curve.py.

Member Function Documentation

◆ eq()

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

inherited

Define equality for this class

Definition at line 134 of file simple_curve.py.

◆ __init_subclass__()

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.

◆ _check_cols()

lsst.meas.algorithms.simple_curve.Curve._check_cols	(		cols,
			table )

staticprotectedinherited

Check that the columns are in the table

Definition at line 237 of file simple_curve.py.

◆ _to_table_with_meta()

lsst.meas.algorithms.simple_curve.Curve._to_table_with_meta ( self )

protectedinherited

Compute standard metadata before writing file out

Definition at line 243 of file simple_curve.py.

◆ compare_metadata()

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

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.

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

◆ getMetadata()

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

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

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

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

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.

◆ writeFits()

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

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 = efficiency

inherited

Definition at line 51 of file simple_curve.py.

◆ metadata

lsst.meas.algorithms.simple_curve.Curve.metadata = metadata

inherited

Definition at line 54 of file simple_curve.py.

◆ mode

lsst.meas.algorithms.simple_curve.Curve.mode = ''

staticinherited

Definition at line 42 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 = 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

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ __eq__()

◆ __init_subclass__()

◆ _check_cols()

◆ _to_table_with_meta()

◆ compare_metadata()

◆ evaluate()

◆ fromTable()

◆ getMetadata()

◆ interpolate()

◆ readFits()

◆ readText()

◆ toTable()

◆ writeFits()

◆ writeText()

Member Data Documentation

◆ efficiency

◆ metadata

◆ mode

◆ subclasses

◆ wavelength

◆ eq()