API Documentation¶

spectral_cube Package¶

This is an Astropy affiliated package.

Functions¶

test([package, test_path, args, plugins, ...]) Run the tests using py.test.

Classes¶

`BooleanArrayMask`(mask, wcs[, shape, include])	A mask defined as an array on a spectral cube WCS
`CompositeMask`(mask1, mask2[, operation])	A combination of several masks.
`FunctionMask`(function)	A mask defined by a function that is evaluated at run-time using the data passed to the mask.
`InvertedMask`(mask)
`LazyComparisonMask`(function, comparison_value)	A boolean mask defined by the evaluation of a comparison function between a fixed dataset and some other value.
`LazyMask`(function[, cube, data, wcs])	A boolean mask defined by the evaluation of a function on a fixed dataset.
`MaskBase`
`OneDSpectrum`
`Projection`
`Slice`
`SpectralCube`(data, wcs[, mask, meta, ...])
`StokesSpectralCube`(stokes_data[, mask, ...])	A class to store a spectral cube with multiple Stokes parameters.
`VaryingResolutionSpectralCube`(args, *kwargs)	A variant of the SpectralCube class that has PSF (beam) information on a per-channel basis.

spectral_cube.ytcube Module¶

Classes¶

ytCube(cube, dataset[, spectral_factor]) Light wrapper of a yt object with ability to translate yt<->wcs

spectral_cube.io.casa_masks Module¶

Functions¶

make_casa_mask(SpecCube, outname[, ...]) Outputs the mask attached to the SpectralCube object as a CASA image, or optionally appends the mask to a preexisting CASA image.

spectral_cube.lower_dimensional_structures Module¶

Classes¶

`LowerDimensionalObject`	Generic class for 1D and 2D objects.
`Projection`
`Slice`
`OneDSpectrum`