ftsdata.SpecData

class ftsdata.SpecData(*args, hits=<object object>, **kwargs)

Class to handle spectral cube from FTS data.

Parameters:

datandarray or FTSData

The actual data contained in this FTSData object. Not that this will always be copies by reference , so you should make copy the data before passing it in if that’s the desired behavior.

uncertaintyNDUncertainty, optional

Uncertainties on the data.data.wcs.world_axis_physical_types

maskndarray-like, optional

Mask for the data, given as a boolean Numpy array or any object that can be converted to a boolean Numpy array with a shape matching that of the data. The values must be False where the data is valid and True when it is not (like Numpy masked arrays). If data is a numpy masked array, providing mask here will causes the mask from the masked array to be ignored.

hitsndarray-like, optional

Hit map for the data, given as a int Numpy array or any object that can be converted to a int Numpy array with a shape matching that of the data.

flagsndarray-like or FlagCollection, optional

Flags giving information about each pixel. These can be specified either as a Numpy array of any type (or an object which can be converted to a Numpy array) with a shape matching that of the data, or as a FlagCollection instance which has a shape matching that of the data.

wcsWCS, optional

WCS-object containing the world coordinate system for the data.

metadict-like object, optional

Metadata for this object. “Metadata” here means all information that is included with this object but not part of any other attribute of this particular object. e.g., creation date, unique identifier, simulation parameters, exposure time, telescope name, etc.

unitUnitBase instance or str, optional

The units of the data.

__init__(*args, hits=<object object>, **kwargs)

Methods

__init__(*args[, hits])
add(operand[, operand2])	Performs addition by evaluating self + operand.
convert_unit_to(unit[, equivalencies])	Returns a new NDData object whose values have been converted to a new unit.
correct_itg_binning([delta_opd])	Correct for the spectral distortion induced by averaging interferogram bins.
correct_opacity([elevation, pwv, atm])	Apply correction of opacity based on ATM model for elevation and PWV
divide(operand[, operand2])	Performs division by evaluating self / operand.
get_axis_from_repr(plane)	Retrieve data axis from representation
get_ils_kernel([dfreq_GHz])	Retrive the ILS from the meta data.
max(**kwargs)
mean(**kwargs)
min(**kwargs)
mip([axes, level, attr])	Return a 'Multum In Parvo' of a given level on the data along given axes.
multiply(operand[, operand2])	Performs multiplication by evaluating self * operand.
subtract(operand[, operand2])	Performs subtraction by evaluating self - operand.
sum(**kwargs)
to_dset([dset_mask, dset_uncertainty, ...])	Create the IDIA HDF5 datasets and attributes from a FTSData object.
to_hdu([hdu_data, hdu_mask, ...])	Creates an HDUList object from a FTSData object.
to_itg(bandpass[, center, dopd_mm, binning, ...])	Convert the spectral cube into a cube of one-sided interferograms.

Attributes

data	ndarray-like : The stored dataset.
dtype	numpy.dtype of this object's data.
flags
hits	ndarra : Hits in the dataset, if any.
mask	any type : Mask for the dataset, if any.
meta
ndim	integer dimensions of this object's data.
psf	Image representation of the PSF for the dataset.
read
shape	shape tuple of this object's data.
size	integer size of this object's data.
spectral_axis
spectral_bins
spectral_wcs
uncertainty	any type : Uncertainty in the dataset, if any.
unit	Unit : Unit for the dataset, if any.
wcs	any type : A world coordinate system (WCS) for the dataset, if any.
weights	Return the weights as inverse variance regardless of the uncertainty type
write