|
lsst.ip.isr
19.0.0-24-g923e380+7
|
Public Member Functions | |
| def | __init__ (self, instrument="unknown", calibType="unknown", **kwargs) |
| def | __str__ (self) |
| def | __eq__ (self, other) |
| def | updateMetadata (self, setDate=False, **kwargs) |
| def | fromDataIds (self, dataIdList) |
| def | fromTable (cls, tableList) |
| def | fromDict (cls, dictionary) |
| def | toDict (self) |
| def | toTable (self) |
| def | requiredAttributes (self) |
| def | requiredAttributes (self, value) |
| def | getMetadata (self) |
| def | setMetadata (self, metadata) |
| def | readText (cls, filename) |
| def | writeText (self, filename, format='auto') |
| def | readFits (cls, filename) |
| def | writeFits (self, filename) |
| def | fromDetector (self, detector) |
| def | validate (self, other=None) |
| def | apply (self, target) |
Public Attributes | |
| instrument | |
| calibType | |
| dimensions | |
| dataIdList | |
| requiredAttributes | |
| log | |
Class for the provenance of data used to construct calibration.
Provenance is not really a calibration, but we would like to
record this when constructing the calibration, and it provides an
example of the base calibration class.
Parameters
----------
instrument : `str`, optional
Name of the instrument the data was taken with.
calibType : `str`, optional
Type of calibration this provenance was generated for.
detectorName : `str`, optional
Name of the detector this calibration is for.
detectorSerial : `str`, optional
Identifier for the detector.
Definition at line 430 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.__init__ | ( | self, | |
instrument = "unknown", |
|||
calibType = "unknown", |
|||
| ** | kwargs | ||
| ) |
Definition at line 451 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.__eq__ | ( | self, | |
| other | |||
| ) |
Calibration equivalence. Subclasses will need to check specific sub-properties. The default is only to check common entries.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 465 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.__str__ | ( | self | ) |
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 462 of file calibType.py.
|
inherited |
Method to apply the calibration to the target object.
Parameters
----------
target : `object`
Thing to validate against.
Returns
-------
valid : `bool`
Returns true if the calibration was applied correctly.
Raises
------
NotImplementedError :
Raised if not implemented.
Definition at line 409 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.fromDataIds | ( | self, | |
| dataIdList | |||
| ) |
Update provenance from dataId List.
Parameters
----------
dataIdList : `list` [`lsst.daf.butler.DataId`]
List of dataIds used in generating this calibration.
Definition at line 486 of file calibType.py.
|
inherited |
Modify the calibration parameters to match the supplied detector.
Parameters
----------
detector : `lsst.afw.cameraGeom.Detector`
Detector to use to set parameters from.
Raises
------
NotImplementedError
This needs to be implemented by subclasses for each
calibration type.
Definition at line 296 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.fromDict | ( | cls, | |
| dictionary | |||
| ) |
Construct provenance from a dictionary.
Parameters
----------
dictionary : `dict`
Dictionary of provenance parameters.
Returns
-------
provenance : `lsst.ip.isr.IsrProvenance`
The provenance defined in the tables.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 540 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.fromTable | ( | cls, | |
| tableList | |||
| ) |
Construct provenance from table list.
Parameters
----------
tableList : `list` [`lsst.afw.table.Table`]
List of tables to construct the provenance from.
Returns
-------
provenance : `lsst.ip.isr.IsrProvenance`
The provenance defined in the tables.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 501 of file calibType.py.
|
inherited |
Retrieve metadata associated with this calibration.
Returns
-------
meta : `lsst.daf.base.PropertyList`
Metadata. The returned `~lsst.daf.base.PropertyList` can be
modified by the caller and the changes will be written to
external files.
Definition at line 107 of file calibType.py.
|
inherited |
Read calibration data from a FITS file.
Parameters
----------
filename : `str`
Filename to read data from.
Returns
-------
calib : `lsst.ip.isr.IsrCalib`
Calibration contained within the file.
Definition at line 246 of file calibType.py.
|
inherited |
Read calibration representation from a yaml/ecsv file.
Parameters
----------
filename : `str`
Name of the file containing the calibration definition.
Returns
-------
calib : `~lsst.ip.isr.IsrCalibType`
Calibration class.
Raises
------
RuntimeError :
Raised if the filename does not end in ".ecsv" or ".yaml".
Definition at line 163 of file calibType.py.
|
inherited |
Definition at line 100 of file calibType.py.
|
inherited |
Definition at line 104 of file calibType.py.
|
inherited |
Store a copy of the supplied metadata with this calibration.
Parameters
----------
metadata : `lsst.daf.base.PropertyList`
Metadata to associate with the calibration. Will be copied and
overwrite existing metadata.
Definition at line 120 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.toDict | ( | self | ) |
Return a dictionary containing the provenance information.
Returns
-------
dictionary : `dict`
Dictionary of provenance.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 565 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.toTable | ( | self | ) |
Return a list of tables containing the provenance.
This seems inefficient and slow, so this may not be the best
way to store the data.
Returns
-------
tableList : `list` [`lsst.afw.table.Table`]
List of tables containing the provenance information
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 588 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.updateMetadata | ( | self, | |
setDate = False, |
|||
| ** | kwargs | ||
| ) |
Update calibration metadata.
Parameters
----------
setDate : `bool, optional
Update the CALIBDATE fields in the metadata to the current
time. Defaults to False.
kwargs :
Other keyword parameters to set in the metadata.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 468 of file calibType.py.
|
inherited |
Validate that this calibration is defined and can be used.
Parameters
----------
other : `object`, optional
Thing to validate against.
Returns
-------
valid : `bool`
Returns true if the calibration is valid and appropriate.
Definition at line 394 of file calibType.py.
|
inherited |
Write calibration data to a FITS file.
Parameters
----------
filename : `str`
Filename to write data to.
Returns
-------
used : `str`
The name of the file used to write the data.
Definition at line 272 of file calibType.py.
|
inherited |
Write the calibration data to a text file.
Parameters
----------
filename : `str`
Name of the file to write.
format : `str`
Format to write the file as. Supported values are:
``"auto"`` : Determine filetype from filename.
``"yaml"`` : Write as yaml.
``"ecsv"`` : Write as ecsv.
Returns
-------
used : `str`
The name of the file used to write the data. This may
differ from the input if the format is explicitly chosen.
Raises
------
RuntimeError :
Raised if filename does not end in a known extension, or
if all information cannot be written.
Notes
-----
The file is written to YAML/ECSV format and will include any
associated metadata.
Definition at line 192 of file calibType.py.
| lsst.ip.isr.calibType.IsrProvenance.calibType |
Definition at line 453 of file calibType.py.
| lsst.ip.isr.calibType.IsrProvenance.dataIdList |
Definition at line 455 of file calibType.py.
| lsst.ip.isr.calibType.IsrProvenance.dimensions |
Definition at line 454 of file calibType.py.
| lsst.ip.isr.calibType.IsrProvenance.instrument |
Definition at line 452 of file calibType.py.
|
inherited |
Definition at line 75 of file calibType.py.
|
inherited |
Definition at line 72 of file calibType.py.
1.8.18