|
def | evaluate (self, Angle angle_start, Optional[Angle] angle_end=None) |
|
def | requiredAttributes (self) |
|
def | requiredAttributes (self, value) |
|
def | __str__ (self) |
|
def | __eq__ (self, other) |
|
def | getMetadata (self) |
|
def | setMetadata (self, metadata) |
|
def | updateMetadata (self, camera=None, detector=None, filterName=None, setCalibId=False, setCalibInfo=False, setDate=False, **kwargs) |
|
def | calibInfoFromDict (self, dictionary) |
|
def | readText (cls, filename, **kwargs) |
|
def | writeText (self, filename, format='auto') |
|
def | readFits (cls, filename, **kwargs) |
|
def | writeFits (self, filename) |
|
def | fromDetector (self, detector) |
|
def | fromDict (cls, dictionary, **kwargs) |
|
def | toDict (self) |
|
def | fromTable (cls, tableList, **kwargs) |
|
def | toTable (self) |
|
def | validate (self, other=None) |
|
def | apply (self, target) |
|
An abstract base class for rotator-dependent stray light information.
Definition at line 122 of file straylight.py.
◆ __eq__()
def lsst.ip.isr.calibType.IsrCalib.__eq__ |
( |
|
self, |
|
|
|
other |
|
) |
| |
|
inherited |
◆ __str__()
def lsst.ip.isr.calibType.IsrCalib.__str__ |
( |
|
self | ) |
|
|
inherited |
◆ apply()
def lsst.ip.isr.calibType.IsrCalib.apply |
( |
|
self, |
|
|
|
target |
|
) |
| |
|
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 578 of file calibType.py.
◆ calibInfoFromDict()
def lsst.ip.isr.calibType.IsrCalib.calibInfoFromDict |
( |
|
self, |
|
|
|
dictionary |
|
) |
| |
|
inherited |
Handle common keywords.
This isn't an ideal solution, but until all calibrations
expect to find everything in the metadata, they still need to
search through dictionaries.
Parameters
----------
dictionary : `dict` or `lsst.daf.base.PropertyList`
Source for the common keywords.
Raises
------
RuntimeError :
Raised if the dictionary does not match the expected OBSTYPE.
Definition at line 258 of file calibType.py.
◆ evaluate()
def lsst.ip.isr.straylight.StrayLightData.evaluate |
( |
|
self, |
|
|
Angle |
angle_start, |
|
|
Optional[Angle] |
angle_end = None |
|
) |
| |
Get a stray light array for a range of rotator angles.
Parameters
----------
angle_begin : `float`
Instrument rotation angle at the start of the exposure.
angle_end : `float`, optional
Instrument rotation angle at the end of the exposure.
If not provided, the returned array will reflect a snapshot at
`angle_start`.
Returns
-------
array : `numpy.ndarray`
A stray-light background image for this exposure.
Definition at line 127 of file straylight.py.
◆ fromDetector()
def lsst.ip.isr.calibType.IsrCalib.fromDetector |
( |
|
self, |
|
|
|
detector |
|
) |
| |
|
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.
Reimplemented in lsst.ip.isr.linearize.Linearizer.
Definition at line 461 of file calibType.py.
◆ fromDict()
def lsst.ip.isr.calibType.IsrCalib.fromDict |
( |
|
cls, |
|
|
|
dictionary, |
|
|
** |
kwargs |
|
) |
| |
|
inherited |
Construct a calibration from a dictionary of properties.
Must be implemented by the specific calibration subclasses.
Parameters
----------
dictionary : `dict`
Dictionary of properties.
kwargs : `dict` or collections.abc.Mapping`, optional
Set of key=value options.
Returns
------
calib : `lsst.ip.isr.CalibType`
Constructed calibration.
Raises
------
NotImplementedError :
Raised if not implemented.
Definition at line 478 of file calibType.py.
◆ fromTable()
def lsst.ip.isr.calibType.IsrCalib.fromTable |
( |
|
cls, |
|
|
|
tableList, |
|
|
** |
kwargs |
|
) |
| |
|
inherited |
Construct a calibration from a dictionary of properties.
Must be implemented by the specific calibration subclasses.
Parameters
----------
tableList : `list` [`lsst.afw.table.Table`]
List of tables of properties.
kwargs : `dict` or collections.abc.Mapping`, optional
Set of key=value options.
Returns
------
calib : `lsst.ip.isr.CalibType`
Constructed calibration.
Raises
------
NotImplementedError :
Raised if not implemented.
Definition at line 521 of file calibType.py.
◆ getMetadata()
def lsst.ip.isr.calibType.IsrCalib.getMetadata |
( |
|
self | ) |
|
|
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 143 of file calibType.py.
◆ readFits()
def lsst.ip.isr.calibType.IsrCalib.readFits |
( |
|
cls, |
|
|
|
filename, |
|
|
** |
kwargs |
|
) |
| |
|
inherited |
Read calibration data from a FITS file.
Parameters
----------
filename : `str`
Filename to read data from.
kwargs : `dict` or collections.abc.Mapping`, optional
Set of key=value pairs to pass to the ``fromTable``
method.
Returns
-------
calib : `lsst.ip.isr.IsrCalib`
Calibration contained within the file.
Definition at line 399 of file calibType.py.
◆ readText()
def lsst.ip.isr.calibType.IsrCalib.readText |
( |
|
cls, |
|
|
|
filename, |
|
|
** |
kwargs |
|
) |
| |
|
inherited |
Read calibration representation from a yaml/ecsv file.
Parameters
----------
filename : `str`
Name of the file containing the calibration definition.
kwargs : `dict` or collections.abc.Mapping`, optional
Set of key=value pairs to pass to the ``fromDict`` or
``fromTable`` methods.
Returns
-------
calib : `~lsst.ip.isr.IsrCalibType`
Calibration class.
Raises
------
RuntimeError :
Raised if the filename does not end in ".ecsv" or ".yaml".
Definition at line 313 of file calibType.py.
◆ requiredAttributes() [1/2]
def lsst.ip.isr.calibType.IsrCalib.requiredAttributes |
( |
|
self | ) |
|
|
inherited |
◆ requiredAttributes() [2/2]
def lsst.ip.isr.calibType.IsrCalib.requiredAttributes |
( |
|
self, |
|
|
|
value |
|
) |
| |
|
inherited |
◆ setMetadata()
def lsst.ip.isr.calibType.IsrCalib.setMetadata |
( |
|
self, |
|
|
|
metadata |
|
) |
| |
|
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 155 of file calibType.py.
◆ toDict()
def lsst.ip.isr.calibType.IsrCalib.toDict |
( |
|
self | ) |
|
|
inherited |
◆ toTable()
def lsst.ip.isr.calibType.IsrCalib.toTable |
( |
|
self | ) |
|
|
inherited |
◆ updateMetadata()
def lsst.ip.isr.calibType.IsrCalib.updateMetadata |
( |
|
self, |
|
|
|
camera = None , |
|
|
|
detector = None , |
|
|
|
filterName = None , |
|
|
|
setCalibId = False , |
|
|
|
setCalibInfo = False , |
|
|
|
setDate = False , |
|
|
** |
kwargs |
|
) |
| |
|
inherited |
Update metadata keywords with new values.
Parameters
----------
camera : `lsst.afw.cameraGeom.Camera`, optional
Reference camera to use to set _instrument field.
detector : `lsst.afw.cameraGeom.Detector`, optional
Reference detector to use to set _detector* fields.
filterName : `str`, optional
Filter name to assign to this calibration.
setCalibId : `bool`, optional
Construct the _calibId field from other fields.
setCalibInfo : `bool`, optional
Set calibration parameters from metadata.
setDate : `bool`, optional
Ensure the metadata CALIBDATE fields are set to the current datetime.
kwargs : `dict` or `collections.abc.Mapping`, optional
Set of key=value pairs to assign to the metadata.
Definition at line 177 of file calibType.py.
◆ validate()
def lsst.ip.isr.calibType.IsrCalib.validate |
( |
|
self, |
|
|
|
other = None |
|
) |
| |
|
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 563 of file calibType.py.
◆ writeFits()
def lsst.ip.isr.calibType.IsrCalib.writeFits |
( |
|
self, |
|
|
|
filename |
|
) |
| |
|
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 437 of file calibType.py.
◆ writeText()
def lsst.ip.isr.calibType.IsrCalib.writeText |
( |
|
self, |
|
|
|
filename, |
|
|
|
format = 'auto' |
|
) |
| |
|
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 345 of file calibType.py.
◆ log
lsst.ip.isr.calibType.IsrCalib.log |
|
inherited |
◆ requiredAttributes
lsst.ip.isr.calibType.IsrCalib.requiredAttributes |
|
inherited |
The documentation for this class was generated from the following file: