Inheritance diagram for lsst.ip.isr.straylight.StrayLightData:
Public Member Functions | |
| evaluate (self, Angle angle_start, Optional[Angle] angle_end=None) | |
Detailed Description
An abstract base class for rotator-dependent stray light information.
Definition at line 96 of file straylight.py.
Member Function Documentation
◆ evaluate()
| 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 101 of file straylight.py.
101 def evaluate(self, angle_start: Angle, angle_end: Optional[Angle] = None):
102 """Get a stray light array for a range of rotator angles.
103
104 Parameters
105 ----------
106 angle_begin : `float`
107 Instrument rotation angle at the start of the exposure.
108 angle_end : `float`, optional
109 Instrument rotation angle at the end of the exposure.
110 If not provided, the returned array will reflect a snapshot at
111 `angle_start`.
112
113 Returns
114 -------
115 array : `numpy.ndarray`
116 A stray-light background image for this exposure.
117 """
118 raise NotImplementedError("Must be implemented by subclasses.")
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/ip_isr/g02d81e74bb+21ad69e7e1/python/lsst/ip/isr/straylight.py
