API
Contents
API¶
Top level functions¶
|
This docstring was copied from numpy.absolute. |
|
This docstring was copied from numpy.absolute. |
|
This docstring was copied from numpy.add. |
|
Test whether all array elements along a given axis evaluate to True. |
|
Returns True if two arrays are element-wise equal within a tolerance. |
|
Return the angle of the complex argument. |
|
Test whether any array element along a given axis evaluates to True. |
|
Append values to the end of an array. |
|
Apply a function to 1-D slices along the given axis. |
|
Apply a function repeatedly over multiple axes. |
|
Return evenly spaced values from start to stop with step size step. |
|
This docstring was copied from numpy.arccos. |
|
This docstring was copied from numpy.arccosh. |
|
This docstring was copied from numpy.arcsin. |
|
This docstring was copied from numpy.arcsinh. |
|
This docstring was copied from numpy.arctan. |
|
This docstring was copied from numpy.arctan2. |
|
This docstring was copied from numpy.arctanh. |
|
Returns the indices of the maximum values along an axis. |
|
Returns the indices of the minimum values along an axis. |
|
Extract the indices of the k largest elements from a on the given axis, and return them sorted from largest to smallest. |
|
Find the indices of array elements that are non-zero, grouped by element. |
|
Round an array to the given number of decimals. |
|
This docstring was copied from numpy.array. |
|
Convert the input to a dask array. |
|
Convert the input to a dask array. |
|
Convert inputs to arrays with at least one dimension. |
|
View inputs as arrays with at least two dimensions. |
|
View inputs as arrays with at least three dimensions. |
|
Compute the weighted average along the specified axis. |
|
This docstring was copied from numpy.bincount. |
|
This docstring was copied from numpy.bitwise_and. |
|
This docstring was copied from numpy.invert. |
|
This docstring was copied from numpy.bitwise_or. |
|
This docstring was copied from numpy.bitwise_xor. |
|
Assemble an nd-array from nested lists of blocks. |
|
Tensor operation: Generalized inner and outer products |
|
Broadcast any number of arrays against each other. |
|
Broadcast an array to a new shape. |
|
This docstring was copied from numpy.cbrt. |
|
Coarsen array by applying reduction to fixed size neighborhoods |
|
This docstring was copied from numpy.ceil. |
|
Construct an array from an index array and a list of arrays to choose from. |
|
Clip (limit) the values in an array. |
|
Return selected slices of an array along given axis. |
|
Concatenate arrays along an existing axis |
|
This docstring was copied from numpy.conjugate. |
|
This docstring was copied from numpy.copysign. |
|
Return Pearson product-moment correlation coefficients. |
|
This docstring was copied from numpy.cos. |
|
This docstring was copied from numpy.cosh. |
|
Counts the number of non-zero values in the array |
|
Estimate a covariance matrix, given data and weights. |
|
Return the cumulative product of elements along a given axis. |
|
Return the cumulative sum of the elements along a given axis. |
|
This docstring was copied from numpy.deg2rad. |
|
This docstring was copied from numpy.degrees. |
|
Return a new array with sub-arrays along an axis deleted. |
|
Extract a diagonal or construct a diagonal array. |
|
Return specified diagonals. |
|
Calculate the n-th discrete difference along the given axis. |
|
This docstring was copied from numpy.divide. |
|
This docstring was copied from numpy.divmod. |
|
Return the indices of the bins to which each value in input array belongs. |
|
This docstring was copied from numpy.dot. |
|
Stack arrays in sequence depth wise (along third axis). |
|
The differences between consecutive elements of an array. |
|
This docstring was copied from numpy.einsum. |
|
Blocked variant of empty_like |
|
Return a new array with the same shape and type as a given array. |
|
This docstring was copied from numpy.equal. |
|
This docstring was copied from numpy.exp. |
|
This docstring was copied from numpy.exp2. |
|
Expand the shape of an array. |
|
This docstring was copied from numpy.expm1. |
|
Return the elements of an array that satisfy some condition. |
|
Return a 2-D Array with ones on the diagonal and zeros elsewhere. |
|
This docstring was copied from numpy.fabs. |
|
Round to nearest integer towards zero. |
|
Return indices that are non-zero in the flattened version of a. |
|
Reverse element order along axis. |
|
Reverse the order of elements along axis 0 (up/down). |
|
Reverse the order of elements along axis 1 (left/right). |
|
This docstring was copied from numpy.float_power. |
|
This docstring was copied from numpy.floor. |
|
This docstring was copied from numpy.floor_divide. |
|
This docstring was copied from numpy.fmax. |
|
This docstring was copied from numpy.fmin. |
|
This docstring was copied from numpy.fmod. |
|
This docstring was copied from numpy.frexp. |
|
Construct an array by executing a function over each coordinate. |
|
This docstring was copied from numpy.frompyfunc. |
|
Blocked variant of full_like |
|
Return a full array with the same shape and type as a given array. |
|
Return the gradient of an N-dimensional array. |
|
This docstring was copied from numpy.greater. |
|
This docstring was copied from numpy.greater_equal. |
|
Blocked variant of |
|
Blocked variant of |
|
Blocked variant of |
|
Stack arrays in sequence horizontally (column wise). |
|
This docstring was copied from numpy.hypot. |
|
Modified Bessel function of the first kind, order 0. |
|
Return the imaginary part of the complex argument. |
|
Implements NumPy's |
|
Insert values along the given axis before the given indices. |
|
This docstring was copied from numpy.invert. |
|
Returns a boolean array where two arrays are element-wise equal within a tolerance. |
|
Returns a bool array, where True if input element is complex. |
|
This docstring was copied from numpy.isfinite. |
|
Calculates |
|
This docstring was copied from numpy.isinf. |
This docstring was copied from numpy.equal. |
|
|
This docstring was copied from numpy.isnan. |
|
pandas.isnull for dask arrays |
This docstring was copied from numpy.equal. |
|
|
Returns a bool array, where True if input element is real. |
|
This docstring was copied from numpy.ldexp. |
|
This docstring was copied from numpy.left_shift. |
|
This docstring was copied from numpy.less. |
|
This docstring was copied from numpy.less_equal. |
|
Return num evenly spaced values over the closed interval [start, stop]. |
|
This docstring was copied from numpy.log. |
|
This docstring was copied from numpy.log10. |
|
This docstring was copied from numpy.log1p. |
|
This docstring was copied from numpy.log2. |
|
This docstring was copied from numpy.logaddexp. |
|
This docstring was copied from numpy.logaddexp2. |
|
This docstring was copied from numpy.logical_and. |
|
This docstring was copied from numpy.logical_not. |
|
This docstring was copied from numpy.logical_or. |
|
This docstring was copied from numpy.logical_xor. |
|
Map a function over blocks of arrays with some overlap |
|
Map a function across all blocks of a dask array. |
|
This docstring was copied from numpy.matmul. |
|
Return the maximum of an array or maximum along an axis. |
|
This docstring was copied from numpy.maximum. |
|
Compute the arithmetic mean along the specified axis. |
|
Compute the median along the specified axis. |
|
Return a tuple of coordinate matrices from coordinate vectors. |
|
Return the minimum of an array or minimum along an axis. |
|
This docstring was copied from numpy.minimum. |
|
This docstring was copied from numpy.remainder. |
|
This docstring was copied from numpy.modf. |
|
Calculate the nth centralized moment. |
|
Move axes of an array to new positions. |
|
This docstring was copied from numpy.multiply. |
|
Return the indices of the maximum values in the specified axis ignoring NaNs. |
|
Return the indices of the minimum values in the specified axis ignoring NaNs. |
|
Return the cumulative product of array elements over a given axis treating Not a Numbers (NaNs) as one. |
|
Return the cumulative sum of array elements over a given axis treating Not a Numbers (NaNs) as zero. |
|
Return the maximum of an array or maximum along an axis, ignoring any NaNs. |
|
Compute the arithmetic mean along the specified axis, ignoring NaNs. |
|
Compute the median along the specified axis, while ignoring NaNs. |
|
Return minimum of an array or minimum along an axis, ignoring any NaNs. |
|
Return the product of array elements over a given axis treating Not a Numbers (NaNs) as ones. |
|
Compute the qth quantile of the data along the specified axis, while ignoring nan values. |
|
Compute the qth percentile of the data along the specified axis, while ignoring nan values. |
|
Compute the standard deviation along the specified axis, while ignoring NaNs. |
|
Return the sum of array elements over a given axis treating Not a Numbers (NaNs) as zero. |
|
Compute the variance along the specified axis, while ignoring NaNs. |
|
Replace NaN with zero and infinity with large finite numbers (default behaviour) or with the numbers defined by the user using the nan, posinf and/or neginf keywords. |
|
This docstring was copied from numpy.negative. |
|
This docstring was copied from numpy.nextafter. |
|
Return the indices of the elements that are non-zero. |
|
This docstring was copied from numpy.not_equal. |
|
pandas.notnull for dask arrays |
|
Blocked variant of ones_like |
|
Return an array of ones with the same shape and type as a given array. |
|
Compute the outer product of two vectors. |
|
Pad an array. |
|
Approximate percentile of 1-D array |
|
Dask-version of bottleneck.push |
A warning given when bad chunking may cause poor performance |
|
|
Evaluate a piecewise-defined function. |
|
This docstring was copied from numpy.positive. |
|
This docstring was copied from numpy.power. |
|
Return the product of array elements over a given axis. |
|
Range of values (maximum - minimum) along an axis. |
|
Compute the q-th quantile of the data along the specified axis. |
|
This docstring was copied from numpy.rad2deg. |
|
This docstring was copied from numpy.radians. |
|
Return a contiguous flattened array. |
|
Converts a tuple of index arrays into an array of flat indices, applying boundary modes to the multi-index. |
|
Return the real part of the complex argument. |
|
This docstring was copied from numpy.reciprocal. |
|
Convert blocks in dask array x for new chunks. |
|
General version of reductions |
|
Register the given type as a valid chunk and downcast array type |
|
This docstring was copied from numpy.remainder. |
|
Repeat each element of an array after themselves |
|
Reshape array to new shape |
|
Blockwise-reshape into a new shape. |
|
This docstring was copied from numpy.result_type. |
|
This docstring was copied from numpy.right_shift. |
|
This docstring was copied from numpy.rint. |
|
Roll array elements along a given axis. |
|
|
|
Rotate an array by 90 degrees in the plane specified by axes. |
|
Evenly round to the given number of decimals. |
|
Find indices where elements should be inserted to maintain order. |
|
Return an array drawn from elements in choicelist, depending on conditions. |
|
Return the shape of an array. |
|
Reorders one dimensions of a Dask Array based on an indexer. |
|
This docstring was copied from numpy.sign. |
|
This docstring was copied from numpy.signbit. |
|
This docstring was copied from numpy.sin. |
|
Return the normalized sinc function. |
|
This docstring was copied from numpy.sinh. |
|
This docstring was copied from numpy.spacing. |
|
This docstring was copied from numpy.sqrt. |
|
This docstring was copied from numpy.square. |
|
Remove axes of length one from a. |
|
Stack arrays along a new axis |
|
Compute the standard deviation along the specified axis. |
|
This docstring was copied from numpy.subtract. |
|
Sum of array elements over a given axis. |
|
Interchange two axes of an array. |
|
Take elements from an array along an axis. |
|
This docstring was copied from numpy.tan. |
|
This docstring was copied from numpy.tanh. |
|
Compute tensor dot product along specified axes. |
|
Construct an array by repeating A the number of times given by reps. |
|
Extract the k largest elements from a on the given axis, and return them sorted from largest to smallest. |
|
Return the sum along diagonals of the array. |
|
Returns an array with axes transposed. |
|
An array with ones at and below the given diagonal and zeros elsewhere. |
|
Lower triangle of an array. |
|
Return the indices for the lower-triangle of an (n, m) array. |
|
Return the indices for the lower-triangle of arr. |
|
Upper triangle of an array. |
|
Return the indices for the upper-triangle of an (n, m) array. |
|
Return the indices for the upper-triangle of arr. |
|
This docstring was copied from numpy.divide. |
|
This docstring was copied from numpy.trunc. |
|
Find the union of two arrays. |
|
Find the unique elements of an array. |
|
This docstring was copied from numpy.unravel_index. |
|
Compute the variance along the specified axis. |
|
This docstring was copied from numpy.vdot. |
|
Stack arrays in sequence vertically (row wise). |
|
This docstring was copied from numpy.where. |
|
Blocked variant of zeros_like |
|
Return an array of zeros with the same shape and type as a given array. |
Array¶
|
Parallel Dask Array |
|
Returns True if all elements evaluate to True. |
|
Returns True if any of the elements evaluate to True. |
|
Return indices of the maximum values along the given axis. |
|
Return indices of the minimum values along the given axis. |
|
The indices of the top k elements of an array. |
|
Copy of the array, cast to a specified type. |
An array-like interface to the blocks of an array. |
|
|
Use an index array to construct a new array from a set of choices. |
Chunks property. |
|
|
Return an array whose values are limited to |
|
Compute this dask collection |
Compute the chunk sizes for a Dask array. |
|
Complex-conjugate all elements. |
|
Copy array. |
|
|
Return the cumulative product of the elements along the given axis. |
|
Return the cumulative sum of the elements along the given axis. |
|
Dot product of self and other. |
Return a flattened array. |
|
Length of one array element in bytes |
|
|
Map a function across all blocks of a dask array. |
|
Map a function over blocks of the array with some overlap |
|
Return the maximum along a given axis. |
|
Returns the average of the array elements along given axis. |
|
Return the minimum along a given axis. |
|
Calculate the nth centralized moment. |
Number of bytes in array |
|
Return the indices of the elements that are non-zero. |
|
Slice an array by partitions. |
|
|
Persist this dask collection into memory |
|
Return the product of the array elements over the given axis |
Return a flattened array. |
|
|
Convert blocks in dask array x for new chunks. |
|
Repeat elements of an array. |
|
Reshape array to new shape |
|
Return array with each element rounded to the given number of decimals. |
|
Reorders one dimensions of a Dask Array based on an indexer. |
Number of elements in array |
|
|
Remove axes of length one from array. |
|
Returns the standard deviation of the array elements along given axis. |
|
Store dask arrays in array-like objects, overwrite data in target |
|
Return the sum of the array elements over the given axis. |
|
Return a view of the array with |
|
Move to a new Array backend |
|
Convert dask Array to dask Dataframe |
|
Convert into an array of |
|
Store array in HDF5 file |
|
Convert chunks from Dask Array into an SVG Image |
|
Save array to the TileDB storage manager |
|
Save array to the zarr storage format |
|
The top k elements of an array. |
|
Return the sum along diagonals of the array. |
|
Reverse or permute the axes of an array. |
|
Returns the variance of the array elements, along given axis. |
|
Get a view of the array as a new data type |
Vectorized indexing with broadcasting. |
|
|
Render the computation of this object's task graph using graphviz. |
Fast Fourier Transforms¶
|
Wrap 1D, 2D, and ND real and complex FFT functions |
|
Wrapping of numpy.fft.fft |
|
Wrapping of numpy.fft.fft2 |
|
Wrapping of numpy.fft.fftn |
|
Wrapping of numpy.fft.ifft |
|
Wrapping of numpy.fft.ifft2 |
|
Wrapping of numpy.fft.ifftn |
|
Wrapping of numpy.fft.rfft |
|
Wrapping of numpy.fft.rfft2 |
|
Wrapping of numpy.fft.rfftn |
|
Wrapping of numpy.fft.irfft |
|
Wrapping of numpy.fft.irfft2 |
|
Wrapping of numpy.fft.irfftn |
|
Wrapping of numpy.fft.hfft |
|
Wrapping of numpy.fft.ihfft |
|
Return the Discrete Fourier Transform sample frequencies. |
|
Return the Discrete Fourier Transform sample frequencies (for usage with rfft, irfft). |
|
Shift the zero-frequency component to the center of the spectrum. |
|
The inverse of fftshift. |
Linear Algebra¶
|
Returns the Cholesky decomposition, \(A = L L^*\) or \(A = U^* U\) of a Hermitian positive-definite matrix A. |
|
Compute the inverse of a matrix with LU decomposition and forward / backward substitutions. |
|
Return the least-squares solution to a linear matrix equation using QR decomposition. |
|
Compute the lu decomposition of a matrix. |
|
Matrix or vector norm. |
|
Compute the qr factorization of a matrix. |
|
Solve the equation |
|
Solve the equation a x = b for x, assuming a is a triangular matrix. |
|
Compute the singular value decomposition of a matrix. |
|
Randomly compressed rank-k thin Singular Value Decomposition. |
|
Direct Short-and-Fat QR |
|
Direct Tall-and-Skinny QR algorithm |
Masked Arrays¶
|
Return the weighted average of array over the given axis. |
|
This docstring was copied from numpy.ma.core.empty_like. |
|
Return input as an ~numpy.ndarray, with masked values replaced by fill_value. |
|
Return input with invalid data masked and replaced by a fill value. |
|
Return the data of a masked array as an ndarray. |
Return the mask of a masked array, or full boolean array of False. |
|
|
An array class with possibly masked values. |
|
Mask an array where equal to a given value. |
|
Mask an array where greater than a given value. |
|
Mask an array where greater than or equal to a given value. |
|
Mask an array inside a given interval. |
Mask an array where invalid values occur (NaNs or infs). |
|
|
Mask an array where less than a given value. |
|
Mask an array where less than or equal to a given value. |
|
Mask an array where not equal to a given value. |
|
Mask an array outside a given interval. |
|
Mask using floating point equality. |
|
Mask an array where a condition is met. |
|
This docstring was copied from numpy.ma.core.nonzero. |
|
Return an array of ones with the same shape and type as a given array. |
|
Set the filling value of a, if a is a masked array. |
|
Return a masked array with elements from x or y, depending on condition. |
|
Return an array of zeros with the same shape and type as a given array. |
Random¶
|
Draw samples from a Beta distribution. |
|
Draw samples from a binomial distribution. |
|
Draw samples from a chi-square distribution. |
|
Generates a random sample from a given 1-D array |
|
Construct a new Generator with the default BitGenerator (PCG64). |
|
Draw samples from an exponential distribution. |
|
Draw samples from an F distribution. |
|
Draw samples from a Gamma distribution. |
|
Draw samples from the geometric distribution. |
|
Draw samples from a Gumbel distribution. |
|
Draw samples from a Hypergeometric distribution. |
|
Draw samples from the Laplace or double exponential distribution with specified location (or mean) and scale (decay). |
|
Draw samples from a logistic distribution. |
|
Draw samples from a log-normal distribution. |
|
Draw samples from a logarithmic series distribution. |
|
Draw samples from a multinomial distribution. |
|
Draw samples from a negative binomial distribution. |
|
Draw samples from a noncentral chi-square distribution. |
|
Draw samples from the noncentral F distribution. |
|
Draw random samples from a normal (Gaussian) distribution. |
|
Draw samples from a Pareto II or Lomax distribution with specified shape. |
|
Randomly permute a sequence, or return a permuted range. |
|
Draw samples from a Poisson distribution. |
|
Draws samples in [0, 1] from a power distribution with positive exponent a - 1. |
|
Return random integers from low (inclusive) to high (exclusive). |
|
Return random floats in the half-open interval [0.0, 1.0). |
|
Random integers of type numpy.int_ between low and high, inclusive. |
|
Return random floats in the half-open interval [0.0, 1.0). |
|
Draw samples from a Rayleigh distribution. |
|
Draw samples from a standard Cauchy distribution with mode = 0. |
|
Draw samples from the standard exponential distribution. |
|
Draw samples from a standard Gamma distribution. |
|
Draw samples from a standard Normal distribution (mean=0, stdev=1). |
|
Draw samples from a standard Student's t distribution with df degrees of freedom. |
|
Draw samples from the triangular distribution over the interval |
|
Draw samples from a uniform distribution. |
|
Draw samples from a von Mises distribution. |
|
Draw samples from a Wald, or inverse Gaussian, distribution. |
|
Draw samples from a Weibull distribution. |
|
Draw samples from a Zipf distribution. |
Stats¶
|
This docstring was copied from scipy.stats.ttest_ind. |
|
This docstring was copied from scipy.stats.ttest_1samp. |
|
This docstring was copied from scipy.stats.ttest_rel. |
|
Calculate a one-way chi-square test. |
|
Cressie-Read power divergence statistic and goodness of fit test. |
|
This docstring was copied from scipy.stats.skew. |
|
This docstring was copied from scipy.stats.skewtest. |
|
This docstring was copied from scipy.stats.kurtosis. |
|
This docstring was copied from scipy.stats.kurtosistest. |
|
This docstring was copied from scipy.stats.normaltest. |
|
This docstring was copied from scipy.stats.f_oneway. |
|
This docstring was copied from scipy.stats.moment. |
Image Support¶
|
Read a stack of images into a dask array |
Slightly Overlapping Computations¶
|
Share boundaries between neighboring blocks |
|
Map a function over blocks of arrays with some overlap |
Create a sliding window view into the array with the given window shape. |
|
|
Trim sides from each block |
|
Trim sides from each block. |
Create and Store Arrays¶
|
Create dask array from something that looks like an array. |
|
Create a dask array from a dask delayed value |
|
Load dask array from stack of npy files |
|
Load array from the zarr storage format |
|
Load array from the TileDB storage format |
|
Store dask arrays in array-like objects, overwrite data in target |
|
Store arrays in HDF5 file |
|
Save array to the zarr storage format |
|
Write dask array to a stack of .npy files |
|
Save array to the TileDB storage format |
Generalized Ufuncs¶
|
Apply a generalized ufunc or similar python function to arrays. |
|
Decorator for |
|
Binds pyfunc into |
Internal functions¶
|
Tensor operation: Generalized inner and outer products |
|
Normalize chunks to tuple of tuples |
|
Unify chunks across a sequence of arrays |
Dask Metadata¶
|
Normalize an array to appropriate meta object |