SpectralNoise
- class hcipy.util.SpectralNoise
Bases:
objectA spectral noise object.
This object should not be used directly, but rather be made by a SpectralNoiseFactory object.
Methods Summary
__call__()Evaluate the noise on the pre-specified grid.
copy()Return a copy.
shift(shift)In-place shift the noise along the grid axes.
shifted(shift)Return a copy, shifted by shift.
Methods Documentation
- __call__()
Evaluate the noise on the pre-specified grid.
This function should be implemented by all child classes.
- Returns:
- Field
The computed spectral noise.
- copy()
Return a copy.
- Returns:
- SpectralNoise
A copy of ourselves.
- shift(shift)
In-place shift the noise along the grid axes.
This function needs to be implemented by the child class.
- Parameters:
- shiftarray_like
The shift in the grid axes.
- shifted(shift)
Return a copy, shifted by shift.
- Parameters:
- shiftarray_like
The shift in the grid axes.
- Returns:
- SpectralNoise
A copy of ourselves, shifted by shift.