named_arrays#

A named tensor implementation with astropy.units support.

Functions

asarray(...)

Converts the input to use only instances of numpy.ndarray as the underlying data.

asanyarray(...)

Converts the input to use only instances of numpy.ndarray subclasses as the underlying data.

arange(start, stop, axis[, step])

Redefined version of numpy.arange() with an axis parameter.

step(start, stop, num[, endpoint, centers])

Helper function to compute the step size for linspace().

linspace(start, stop, axis[, num, endpoint, ...])

Create an array of evenly-spaced numbers between start and stop.

logspace(start, stop, axis[, num, endpoint, ...])

Create an array of evenly-spaced numbers on a log scale between start and stop.

geomspace(start, stop, axis[, num, ...])

Create an array of a geometric progression of numbers between start and stop.

ndim(a)

Compute the number of dimensions of the argument.

shape(a)

Compute the shape of the given array.

unit(a[, unit_dimensionless, squeeze])

Isolate the physical units associated with the given object.

unit_normalized(a[, unit_dimensionless, squeeze])

Isolate the physical units associated with a given object, normalizing to the given dimensionless units if the object does not have associated units.

broadcast_to(...)

Broadcast the given array to a given shape.

stack(arrays, axis[, out, dtype, casting])

Stack the given arrays along a new axis.

concatenate(arrays, axis[, out, dtype, casting])

Concatenate the given arrays along an existing axis.

add_axes(array, axes)

Add singleton axes to an existing array.

vmr(a[, axis, dtype, out, keepdims, where])

Compute the variance-to-mean ratio (also known as the Fano factor) of the given array.

mean_trimmed(a[, q, axis, dtype, out, keepdims])

Compute the trimmed mean of the given array along the specified axes.

take_along_axis(a, indices, axis)

Take values from the input array by matching indices along the given axis.

interp(x, xp, fp[, axis, left, right, period])

Thin wrapper around numpy.interp().

histogram(a, bins[, axis, min, max, ...])

A thin wrapper around numpy.histogram() which adds an axis argument.

histogram2d(x, y, bins[, axis, min, max, ...])

A thin wrapper around numpy.histogram2d() which adds an axis argument.

histogramdd(*sample, bins[, axis, min, max, ...])

A thin wrapper around numpy.histogramdd() which adds an axis argument.

convolve(array, kernel[, axis, where, mode])

Convolve an array with a given \(n\)-dimensional kernel.

jacobian(function, x[, dx])

Compute the Jacobian of the given function using the first-order finite difference method.

despike(array, axis[, where, inbkg, invar, ...])

A thin wrapper around astroscrappy.detect_cosmics() [van Dokkum, 2001], which removes cosmic ray spikes from a series of images.

named_array_like(a)

Check if an object is compatible with the named_arrays API.

get_dtype(value)

Get the equivalent numpy.ndarray.dtype of the argument.

value(a)

Remove the units (if they exist) from the input.

type_array(*values)

broadcast_shapes(*shapes)

An analogue of numpy.broadcast_shapes() for named axes.

shape_broadcasted(*arrays)

Find the broadcasted shape of a sequence of arrays.

ndindex(shape[, axis_ignored])

An analogue of numpy.ndindex for named axes.

indices(shape)

An analogue of numpy.indices() for named axes.

flatten_axes(axes)

Given a sequence of axes names, combine them into a single str using * as a delimiter.

axis_normalized(a, axis)

Convert all the possible values of the axis argument to a tuple of str.

explicit(value)

Converts an array to its explicit version if possible.

strata(a)

If a is an instance of AbstractStratifiedRandomSpace, return a.strata, otherwise return a.

as_named_array(value)

Cast the argument to an instance of named_arrays.AbstractArray.

nominal(a)

Isolate the nominal attribute of an uncertain array.

Classes

AbstractArray()

The ultimate parent class for all array types defined in this package.

AbstractExplicitArray()

An interface describing an explicit array or an actual array of numbers.

AbstractImplicitArray()

An interface describing an implicit array or a lazily-evaluated array.

AbstractRandomMixin()

A mixin class used for random implicit arrays.

AbstractRangeMixin()

A mixin class for implicit arrays which describe a range of values.

AbstractSymmetricRangeMixin()

AbstractRandomSample()

AbstractParameterizedArray()

AbstractLinearParameterizedArrayMixin()

AbstractArrayRange(start, stop, axis[, step])

AbstractSpace()

AbstractLinearSpace(start, stop, axis[, ...])

AbstractStratifiedRandomSpace(start, stop, axis)

AbstractLogarithmicSpace(start_exponent, ...)

AbstractGeometricSpace(start, stop, axis[, ...])

AbstractUniformRandomSample(start, stop[, ...])

AbstractNormalRandomSample(center, width[, ...])

AbstractPoissonRandomSample(center[, ...])

AbstractScalar()

An interface representing a physical scalar.

AbstractScalarArray()

An interface representing a physical scalar array.

ScalarArray([ndarray, axes])

An array representing a scalar quantity (like pressure or temperature) with names for each of its N axes.

AbstractImplicitScalarArray()

AbstractScalarRandomSample()

ScalarUniformRandomSample(start, stop[, ...])

ScalarNormalRandomSample(center, width[, ...])

ScalarPoissonRandomSample(center[, ...])

AbstractParameterizedScalarArray()

ScalarArrayRange(start, stop, axis[, step])

An AbstractScalarArray over the range [start, stop) incremented by step.

AbstractScalarSpace()

ScalarLinearSpace(start, stop, axis[, num, ...])

An evenly spaced ScalarArray ranging from start to stop with num elements.

ScalarStratifiedRandomSpace(start, stop, axis)

ScalarLogarithmicSpace(start_exponent, ...)

ScalarGeometricSpace(start, stop, axis[, ...])

AbstractUncertainScalarArray()

UncertainScalarArray([nominal, distribution])

AbstractImplicitUncertainScalarArray()

UniformUncertainScalarArray(nominal, width)

NormalUncertainScalarArray(nominal, width[, ...])

AbstractUncertainScalarRandomSample()

UncertainScalarUniformRandomSample(start, stop)

UncertainScalarNormalRandomSample(center, width)

UncertainScalarPoissionRandomSample(center)

AbstractParameterizedUncertainScalarArray()

AbstractUncertainScalarSpace()

UncertainScalarLinearSpace(start, stop, axis)

UncertainScalarStratifiedRandomSpace(start, ...)

UncertainScalarLogarithmicSpace(...[, num, ...])

UncertainScalarGeometricSpace(start, stop, axis)

AbstractVectorArray()

An interface describing an arbitrary physical vector.

AbstractExplicitVectorArray()

An interface describing an explicit physical vector.

AbstractImplicitVectorArray()

AbstractVectorRandomSample()

AbstractVectorUniformRandomSample(start, stop)

AbstractVectorNormalRandomSample(center, width)

AbstractParameterizedVectorArray()

AbstractVectorArrayRange(start, stop, axis)

AbstractVectorSpace()

AbstractVectorLinearSpace(start, stop, axis)

AbstractVectorStratifiedRandomSpace(start, ...)

AbstractVectorLogarithmicSpace(...[, num, ...])

AbstractVectorGeometricSpace(start, stop, axis)

AbstractWcsVector()

AbstractCartesianVectorArray()

An interface describing a vector whose components are all orthogonal.

AbstractExplicitCartesianVectorArray()

AbstractImplicitCartesianVectorArray()

AbstractCartesianVectorRandomSample()

AbstractCartesianVectorUniformRandomSample(...)

AbstractCartesianVectorNormalRandomSample(...)

AbstractParameterizedCartesianVectorArray()

AbstractCartesianVectorArrayRange(start, ...)

AbstractCartesianVectorSpace()

AbstractCartesianVectorLinearSpace(start, ...)

AbstractCartesianVectorStratifiedRandomSpace(...)

AbstractCartesianVectorLogarithmicSpace(...)

AbstractCartesianVectorGeometricSpace(start, ...)

AbstractCartesian2dVectorArray()

An interface describing an array of 2D Cartesian vectors.

Cartesian2dVectorArray([x, y])

An array of 2D Cartesian vectors.

AbstractImplicitCartesian2dVectorArray()

AbstractCartesian2dVectorRandomSample()

Cartesian2dVectorUniformRandomSample(start, stop)

Cartesian2dVectorNormalRandomSample(center, ...)

AbstractParameterizedCartesian2dVectorArray()

Cartesian2dVectorArrayRange(start, stop, axis)

AbstractCartesian2dVectorSpace()

Cartesian2dVectorLinearSpace(start, stop, axis)

Cartesian2dVectorStratifiedRandomSpace(...)

Cartesian2dVectorLogarithmicSpace(...[, ...])

Cartesian2dVectorGeometricSpace(start, stop, ...)

AbstractCartesian3dVectorArray()

An interface describing an array of 3D Cartesian vectors.

Cartesian3dVectorArray([x, y, z])

An array of 3D Cartesian vectors.

AbstractImplicitCartesian3dVectorArray()

AbstractCartesian3dVectorRandomSample()

Cartesian3dVectorUniformRandomSample(start, stop)

Cartesian3dVectorNormalRandomSample(center, ...)

AbstractParameterizedCartesian3dVectorArray()

Cartesian3dVectorArrayRange(start, stop, axis)

AbstractCartesian3dVectorSpace()

Cartesian3dVectorLinearSpace(start, stop, axis)

Cartesian3dVectorStratifiedRandomSpace(...)

Cartesian3dVectorLogarithmicSpace(...[, ...])

Cartesian3dVectorGeometricSpace(start, stop, ...)

AbstractCartesianNdVectorArray()

An interface describing an \(n\)-dimensional Cartesian vector array.

CartesianNdVectorArray([components])

An \(n\)-dimensional Cartesian vector array.

AbstractTemporalVectorArray()

TemporalVectorArray([time])

AbstractImplicitTemporalVectorArray()

AbstractParameterizedTemporalVectorArray()

AbstractTemporalVectorSpace()

TemporalVectorLinearSpace(start, stop, axis)

AbstractSpectralVectorArray()

SpectralVectorArray([wavelength])

AbstractImplicitSpectralVectorArray()

AbstractParameterizedSpectralVectorArray()

AbstractSpectralVectorSpace()

SpectralVectorLinearSpace(start, stop, axis)

AbstractDopplerVectorArray()

An interface describing a vector with a Doppler-shifted wavelength component.

DopplerVectorArray([wavelength, wavelength_rest])

A vector with a Doppler-shifted wavelength component.

AbstractImplicitDopplerVectorArray()

A vector with an implicit Doppler-shifted wavelength component.

AbstractPositionalVectorArray()

PositionalVectorArray([position])

AbstractImplicitPositionalVectorArray()

AbstractParameterizedPositionalVectorArray()

AbstractPositionalVectorSpace()

PositionalVectorLinearSpace(start, stop, axis)

AbstractDirectionalVectorArray()

DirectionalVectorArray([direction])

AbstractImplicitDirectionalVectorArray()

AbstractParameterizedDirectionalVectorArray()

AbstractDirectionalVectorSpace()

DirectionalVectorLinearSpace(start, stop, axis)

AbstractSpectralPositionalVectorArray()

SpectralPositionalVectorArray([wavelength, ...])

AbstractImplicitSpectralPositionalVectorArray()

AbstractParameterizedSpectralPositionalVectorArray()

AbstractSpectralPositionalVectorSpace()

SpectralPositionalVectorLinearSpace(start, ...)

AbstractSpectralDirectionalVectorArray()

SpectralDirectionalVectorArray([wavelength, ...])

AbstractImplicitSpectralDirectionalVectorArray()

AbstractParameterizedSpectralDirectionalVectorArray()

AbstractSpectralDirectionalVectorSpace()

SpectralDirectionalVectorLinearSpace(start, ...)

WcsSpectralDirectionalVectorArray(crval, ...)

AbstractDopplerPositionalVectorArray()

DopplerPositionalVectorArray([wavelength, ...])

AbstractImplicitDopplerPositionalVectorArray()

AbstractTemporalSpectralVectorArray()

TemporalSpectralVectorArray([time, wavelength])

AbstractImplicitTemporalSpectralVectorArray()

AbstractParameterizedTemporalSpectralVectorArray()

AbstractTemporalSpectralVectorSpace()

TemporalSpectralVectorLinearSpace(start, ...)

ExplicitTemporalWcsSpectralVectorArray(time, ...)

AbstractTemporalPositionalVectorArray()

TemporalPositionalVectorArray([time, position])

AbstractImplicitTemporalPositionalVectorArray()

AbstractParameterizedTemporalPositionalVectorArray()

AbstractTemporalPositionalVectorSpace()

TemporalPositionalVectorLinearSpace(start, ...)

ExplicitTemporalWcsPositionalVectorArray(...)

AbstractTemporalSpectralPositionalVectorArray()

TemporalSpectralPositionalVectorArray([...])

AbstractImplicitTemporalSpectralPositionalVectorArray()

AbstractParameterizedTemporalSpectralPositionalVectorArray()

AbstractTemporalSpectralPositionalVectorSpace()

TemporalSpectralPositionalVectorLinearSpace(...)

ExplicitTemporalSpectralWcsPositionalVectorArray(...)

ExplicitTemporalWcsSpectralPositionalVectorArray(...)

AbstractTemporalSpectralDirectionalVectorArray()

TemporalSpectralDirectionalVectorArray([...])

AbstractImplicitTemporalSpectralDirectionalVectorArray()

AbstractParameterizedTemporalSpectralDirectionalVectorArray()

AbstractTemporalSpectralDirectionalVectorSpace()

TemporalSpectralDirectionalVectorLinearSpace(...)

ExplicitTemporalWcsSpectralDirectionalVectorArray(...)

AbstractTemporalDopplerPositionalVectorArray()

TemporalDopplerPositionalVectorArray([time, ...])

AbstractImplicitTemporalDopplerPositionalVectorArray()

ExplicitTemporalWcsDopplerPositionalVectorArray(...)

AbstractInputOutputVectorArray()

InputOutputVectorArray([input, output])

AbstractImplicitInputOutputVectorArray()

AbstractParameterizedInputOutputVectorArray()

AbstractInputOutputVectorSpace()

InputOutputVectorLinearSpace(start, stop, axis)

AbstractMatrixArray()

AbstractExplicitMatrixArray()

AbstractImplicitMatrixArray()

AbstractMatrixRandomSample()

AbstractMatrixUniformRandomSample(start, stop)

AbstractMatrixNormalRandomSample(start, stop)

AbstractParameterizedMatrixArray()

AbstractCartesianMatrixArray()

AbstractExplicitCartesianMatrixArray()

AbstractImplicitCartesianMatrixArray()

AbstractCartesianMatrixRandomSample()

AbstractCartesianMatrixUniformRandomSample(...)

AbstractCartesianMatrixNormalRandomSample(...)

AbstractParameterizedCartesianMatrixArray()

AbstractCartesian2dMatrixArray()

Cartesian2dMatrixArray([x, y])

AbstractImplicitCartesian2dMatrixArray()

Cartesian2dIdentityMatrixArray()

AbstractCartesian2dRotationMatrixArray()

Cartesian2dRotationMatrixArray(angle)

AbstractCartesian3dMatrixArray()

Cartesian3dMatrixArray([x, y, z])

AbstractImplicitCartesian3dMatrixArray()

Cartesian3dIdentityMatrixArray()

AbstractCartesian3dRotationMatrixArray()

Cartesian3dXRotationMatrixArray(angle)

Cartesian3dYRotationMatrixArray(angle)

Cartesian3dZRotationMatrixArray(angle)

AbstractCartesianNdMatrixArray()

CartesianNdMatrixArray([components])

AbstractTemporalMatrixArray()

TemporalMatrixArray([time])

AbstractSpectralMatrixArray()

SpectralMatrixArray([wavelength])

AbstractDopplerMatrixArray()

DopplerMatrixArray([wavelength, wavelength_rest])

AbstractPositionalMatrixArray()

PositionalMatrixArray([position])

AbstractDirectionalMatrixArray()

DirectionalMatrixArray([direction])

AbstractSpectralPositionalMatrixArray()

SpectralPositionalMatrixArray([wavelength, ...])

AbstractSpectralDirectionalMatrixArray()

SpectralDirectionalMatrixArray([wavelength, ...])

AbstractDopplerPositionalMatrixArray()

DopplerPositionalMatrixArray([wavelength, ...])

AbstractTemporalSpectralMatrixArray()

TemporalSpectralMatrixArray([time, wavelength])

AbstractTemporalPositionalMatrixArray()

TemporalPositionalMatrixArray([time, position])

AbstractTemporalSpectralPositionalMatrixArray()

TemporalSpectralPositionalMatrixArray([...])

AbstractTemporalSpectralDirectionalMatrixArray()

TemporalSpectralDirectionalMatrixArray([...])

AbstractTemporalDopplerPositionalMatrixArray()

TemporalDopplerPositionalMatrixArray([time, ...])

AbstractInputOutputMatrixArray()

InputOutputMatrixArray([input, output])

AbstractFunctionArray()

FunctionArray([inputs, outputs])

A representation of a discrete function.

AbstractPolynomialFunctionArray()

PolynomialFitFunctionArray([inputs, ...])

A named_arrays.PolynomialFitFunctionArray carries the independent variables, inputs, and dependent variables, outputs, of a discrete function, and a linear least squares polynomial fit of specified degree to that function.

Exceptions

ScalarTypeError

UncertainScalarTypeError

VectorTypeError

InputValueError

Exception raised when the inputs of two functions do not match

Modules

random

Create arrays by drawing random samples.

plt

Wrappers around matplotlib.pyplot functions.

stats

Statistical functions.

optimize

Minimization and root finding of arbitrary functions.

regridding

Array resampling and interpolation.

transformations

Vector transformation primitives.

ndfilters

A thin wrapper around the ndfilters package for named arrays.

colorsynth

A thin wrapper around the colorsynth package for named arrays.

numexpr

A wrapper around the numexpr package.

geometry

Computational geometry routines.

pdf

Compute properties of probability density functions.