API Documentation

spectral_cube Package

Classes

SpectralCube(*args, **kwargs)

VaryingResolutionSpectralCube(*args, **kwargs)

A variant of the SpectralCube class that has PSF (beam) information on a per-channel basis.

DaskSpectralCube(*args, **kwargs)

DaskVaryingResolutionSpectralCube(*args, …)

StokesSpectralCube(stokes_data[, mask, …])

A class to store a spectral cube with multiple Stokes parameters.

CompositeMask(mask1, mask2[, operation])

A combination of several masks.

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.

BooleanArrayMask(mask, wcs[, shape, include])

A mask defined as an array on a spectral cube WCS

FunctionMask(function)

A mask defined by a function that is evaluated at run-time using the data passed to the mask.

OneDSpectrum(value[, beam, read_beam])

Projection(value[, unit, dtype, copy, wcs, …])

Slice(value[, unit, dtype, copy, wcs, meta, …])

spectral_cube.ytcube Module

Classes

ytCube(cube, dataset[, spectral_factor])

Light wrapper of a yt object with ability to translate yt<->wcs coordinates

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(value[, unit, dtype, …])

Generic class for 1D and 2D objects.

Projection(value[, unit, dtype, copy, wcs, …])

Slice(value[, unit, dtype, copy, wcs, meta, …])

OneDSpectrum(value[, beam, read_beam])

spectral_cube.base_class Module

Classes

BaseNDClass()

BeamMixinClass()

Functionality for objects with a single beam.

HeaderMixinClass()

A mixin class to provide header updating from WCS objects.

MaskableArrayMixinClass()

Mixin class for maskable arrays

MultiBeamMixinClass()

A mixin class to handle multibeam objects.

SpatialCoordMixinClass()

SpectralAxisMixinClass()

spectral_cube.spectral_cube Module

A class to represent a 3-d position-position-velocity spectral cube.

Classes

BaseSpectralCube(data, wcs[, mask, meta, …])

SpectralCube(*args, **kwargs)

VaryingResolutionSpectralCube(*args, **kwargs)

A variant of the SpectralCube class that has PSF (beam) information on a per-channel basis.

spectral_cube.masks Module

Classes

MaskBase()

InvertedMask(mask)

CompositeMask(mask1, mask2[, operation])

A combination of several masks.

BooleanArrayMask(mask, wcs[, shape, include])

A mask defined as an array on a spectral cube WCS

LazyMask(function[, cube, data, wcs])

A boolean mask defined by the evaluation of a function on a fixed dataset.

LazyComparisonMask(function, comparison_value)

A boolean mask defined by the evaluation of a comparison function between a fixed dataset and some other value.

FunctionMask(function)

A mask defined by a function that is evaluated at run-time using the data passed to the mask.