Curve

class lsst.meas.algorithms.Curve(wavelength, efficiency, metadata)

Bases: ABC

An abstract class to represent an arbitrary curve with interpolation.

Attributes Summary

mode
subclasses

Methods Summary

compare_metadata(other[, keys_to_compare])	Compare metadata in this object to another.
evaluate(detector, position, wavelength[, ...])	Interpolate the curve at the specified position and wavelength.
fromTable(table)	Class method for constructing a Curve object.
getMetadata()	Return metadata
interpolate(wavelengths, values, wavelength, ...)	Interplate the curve at the specified wavelength(s).
readFits(filename)	Class method for constructing a Curve object from the standardized FITS format.
readText(filename)	Class method for constructing a Curve object from the standardized text format.
toTable()	Convert this Curve object to an astropy.table.QTable.
writeFits(filename)	Write the Curve out to a FITS file.
writeText(filename)	Write the Curve out to a text file.

Attributes Documentation

mode = ''

subclasses = {'AMP': <class 'lsst.meas.algorithms.simple_curve.AmpCurve'>, 'DETECTOR': <class 'lsst.meas.algorithms.simple_curve.DetectorCurve'>, 'IMAGE': <class 'lsst.meas.algorithms.simple_curve.ImageCurve'>}

Methods Documentation

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

Compare metadata in this object to another.

Parameters:

otherCurve

The object with which to compare metadata.

keys_to_comparelist

List of metadata keys to compare.

Returns:

samebool

Are the metadata the same?

abstract evaluate(detector, position, wavelength, kind='linear', bounds_error=False, fill_value=0)

Interpolate the curve at the specified position and wavelength.

Parameters:

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

positionlsst.geom.Point2D

The position on the detector at which to evaluate the curve.

wavelengthastropy.units.Quantity

The wavelength(s) at which to make the interpolation.

kindstr, optional

The type of interpolation to do (default is ‘linear’). See documentation for scipy.interpolate.interp1d for accepted values.

bounds_errorbool, optional

Raise error if interpolating outside the range of x? (default is False)

fill_valuefloat, optional

Fill values outside the range of x with this value (default is 0).

Returns:

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

abstract classmethod fromTable(table)

Class method for constructing a Curve object.

Parameters:

tableastropy.table.QTable

Table containing metadata and columns necessary for constructing a Curve object.

Returns:

curveCurve

A Curve subclass of the appropriate type according to the table metadata

getMetadata()

Return metadata

Returns:

metadatadict

Dictionary of metadata for this curve.

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

Interplate the curve at the specified wavelength(s).

Parameters:

wavelengthsastropy.units.Quantity

The wavelength values for the curve.

valuesastropy.units.Quantity

The y-values for the curve.

wavelengthastropy.units.Quantity

The wavelength(s) at which to make the interpolation.

kindstr

The type of interpolation to do. See documentation for scipy.interpolate.interp1d for accepted values.

Returns:

valueastropy.units.Quantity

Interpolated value(s)

classmethod readFits(filename)

Class method for constructing a Curve object from the standardized FITS format.

Parameters:

filenamestr

Path to the FITS file to read.

Returns:

curveCurve

A Curve subclass of the appropriate type according to the table metadata

classmethod readText(filename)

Class method for constructing a Curve object from the standardized text format.

Parameters:

filenamestr

Path to the text file to read.

Returns:

curveCurve

A Curve subclass of the appropriate type according to the table metadata

abstract toTable()

Convert this Curve object to an astropy.table.QTable.

Returns:

tableastropy.table.QTable

A table object containing the data from this Curve.

writeFits(filename)

Write the Curve out to a FITS file.

Parameters:

filenamestr

Path to the FITS file to write.

Returns:

filenamestr

Because this method forces a particular extension return the name of the file actually written.

writeText(filename)

Write the Curve out to a text file.

Parameters:

filenamestr

Path to the text file to write.

Returns:

filenamestr

Because this method forces a particular extension return the name of the file actually written.