lezargus.library.container.image module#
Image data container.
This module and class primarily deals with images containing spatial information.
- class lezargus.library.container.image.LezargusImage(data: hint.NDArray, uncertainty: hint.NDArray | None = None, wavelength: float | None = None, wavelength_unit: str | hint.Unit | None = None, data_unit: str | hint.Unit | None = None, spectral_scale: float | None = None, pixel_scale: float | None = None, slice_scale: float | None = None, mask: hint.NDArray | None = None, flags: hint.NDArray | None = None, header: hint.Header | None = None)[source]#
Bases:
LezargusContainerArithmetic
Container to hold image and perform operations on it.
- For all available attributes, see :py:class:`LezargusContainerArithmetic`.
- __init__(data: hint.NDArray, uncertainty: hint.NDArray | None = None, wavelength: float | None = None, wavelength_unit: str | hint.Unit | None = None, data_unit: str | hint.Unit | None = None, spectral_scale: float | None = None, pixel_scale: float | None = None, slice_scale: float | None = None, mask: hint.NDArray | None = None, flags: hint.NDArray | None = None, header: hint.Header | None = None) None [source]#
Instantiate the spectra class.
- Parameters:
wavelength (ndarray) – The wavelength axis of the spectral component of the data, if any. The unit of wavelength is typically in meters; but, check the
wavelength_unit
value.data (ndarray) – The data stored in this container. The unit of the flux is typically in W m^-2 m^-1; but, check the
data_unit
value.uncertainty (ndarray) – The uncertainty in the data of the spectra. The unit of the uncertainty is the same as the data value; per
uncertainty_unit
.wavelength_unit (Astropy Unit) – The unit of the wavelength array. If None, we assume unit-less.
data_unit (Astropy Unit) – The unit of the data array. If None, we assume unit-less.
spectral_scale (float, default = None) – The spectral scale, or spectral resolution, of the spectral component, if any. Must be in meters per pixel. Scale is None if none is provided.
pixel_scale (float, default = None) – The E-W, “x” dimension, pixel plate scale of the spatial component, if any. Must be in radians per pixel. Scale is None if none is provided.
slice_scale (float, default = None) – The N-S, “y” dimension, pixel slice scale of the spatial component, if any. Must be in radians per slice-pixel. Scale is None if none is provided.
mask (ndarray, default = None) – A mask of the data, used to remove problematic areas. Where True, the values of the data is considered masked. If None, we assume the mask is all clear.
flags (ndarray, default = None) – Flags of the data. These flags store metadata about the data. If None, we assume that there are no harmful flags.
header (Header, default = None) – A set of header data describing the data. Note that when saving, this header is written to disk with minimal processing. We highly suggest writing of the metadata to conform to the FITS Header specification as much as possible. If None, we just use an empty header.
- classmethod read_fits_file(filename: str) hint.Self [source]#
Read a Lezargus image FITS file.
We load a Lezargus FITS file from disk. Note that this should only be used for 2-D image files.
- Parameters:
filename (str) – The filename to load.
- Returns:
cube – The LezargusImage class instance.
- Return type:
Self-like