3
���h�� � - @ s� d Z ddddddddd d
d d d
ddddddddddddddd d d d d d!d"d#d$d%d&d'd(d)d*d+d,d-g-Zd.d/lZd.d/lZd0d1lmZ d0d2lmZmZm Z m
Z
m Z m Z m
Z
mZmZmZmZmZmZmZmZmZmZmZmZmZmZm Z d.d/l Z d.d3l m Z m
Z d.d/l!jj"Z"d.d4l#m$Z$ d.d5l%m&Z& d.d6l'm(Z( d.d7l)m*Z* d8d9� Z+dsd:d�Z,e-fd;d �Z.d<d � Z/G d=d>� d>�Z0G d?d@� d@e0�Z1G dAdB� dBe0�Z2G dCdD� dDe0�Z3G dEdF� dFe0�Z4e4d�Z5e4d�Z6e4d�Z7e2d-� Z8Z9e2d�Z:e2d �Z;e2d�Z<e2d)�Z=e1d�Z>e1d�Z?dGdH� Z@dId� ZAe jAj eA_ dJd� ZBeBj d/k �rLe jBj d/e jBj jCdK�� jD� dL eB_ dtdNd�ZEdudOd!�ZFdvdPdQ�ZGdwdRd �ZHdxdSd �ZIdTd
� ZJdUd
� ZKe jLfdVd �ZMe jLfdWd �ZNdydXd�ZOdzdYd*�ZPd{dZd�ZQd|d[d(�ZRd}d\d�ZSd~d]d�ZTd^d+� ZUdd_d'�ZVd�dadb�ZWd�dcd�ZXd/d`e jLd`e jLfddd�ZYG dedf� dfe*�ZZG dgdh� dheZ�Z[e[� Z\did� Z]d�djd$�Z^dkd� Z_d�dld#�Z`dmdn� Zadod� Zbdpd� Zcd�dqd,�Zdejee jdj edj �ed_ d�drd%�Zfejee jfj efj �ef_ d/S )�z�
Masked arrays add-ons.
A collection of utilities for `numpy.ma`.
:author: Pierre Gerard-Marchant
:contact: pierregm_at_uga_dot_edu
:version: $Id: extras.py 3473 2007-10-29 15:18:13Z jarrod.millman $
�apply_along_axis�apply_over_axes�
atleast_1d�
atleast_2d�
atleast_3d�average� clump_masked�clump_unmasked� column_stack�
compress_cols� compress_nd�compress_rowcols�
compress_rows� count_masked�corrcoef�cov�diagflat�dot�dstack�ediff1d�flatnotmasked_contiguous�flatnotmasked_edges�hsplit�hstack�isin�in1d� intersect1d� mask_cols� mask_rowcols� mask_rows�
masked_all�masked_all_like�median�mr_�notmasked_contiguous�notmasked_edges�polyfit� row_stack� setdiff1d�setxor1d�stack�unique�union1d�vander�vstack� N� )�core)� MaskedArray�MAError�add�array�asarray� concatenate�filled�count�getmask� getmaskarray�make_mask_descr�masked� masked_array�mask_or�nomask�ones�sort�zeros�getdata�get_masked_subclassr r )�ndarrayr4 )�normalize_axis_index)�normalize_axis_tuple)�_ureduce)�AxisConcatenatorc C s t | tttf�S )z6
Is seq a sequence (ndarray, list or tuple)?
)�
isinstancerE �tuple�list)�seq� rN �0/tmp/pip-build-5_djhm0z/numpy/numpy/ma/extras.py�
issequence+ s rP c C s t | �}|j|�S )a�
Count the number of masked elements along the given axis.
Parameters
----------
arr : array_like
An array with (possibly) masked elements.
axis : int, optional
Axis along which to count. If None (default), a flattened
version of the array is used.
Returns
-------
count : int, ndarray
The total number of masked elements (axis=None) or the number
of masked elements along each slice of the given axis.
See Also
--------
MaskedArray.count : Count non-masked elements.
Examples
--------
>>> import numpy.ma as ma
>>> a = np.arange(9).reshape((3,3))
>>> a = ma.array(a)
>>> a[1, 0] = ma.masked
>>> a[1, 2] = ma.masked
>>> a[2, 1] = ma.masked
>>> a
masked_array(
data=[[0, 1, 2],
[--, 4, --],
[6, --, 8]],
mask=[[False, False, False],
[ True, False, True],
[False, True, False]],
fill_value=999999)
>>> ma.count_masked(a)
3
When the `axis` keyword is used an array is returned.
>>> ma.count_masked(a, axis=0)
array([1, 1, 1])
>>> ma.count_masked(a, axis=1)
array([0, 2, 1])
)r: �sum)�arr�axis�mrN rN rO r 3 s 2c C s$ t tj| |�tj| t|��d�}|S )a
Empty masked array with all elements masked.
Return an empty masked array of the given shape and dtype, where all the
data are masked.
Parameters
----------
shape : tuple
Shape of the required MaskedArray.
dtype : dtype, optional
Data type of the output.
Returns
-------
a : MaskedArray
A masked array with all data masked.
See Also
--------
masked_all_like : Empty masked array modelled on an existing array.
Examples
--------
>>> import numpy.ma as ma
>>> ma.masked_all((3, 3))
masked_array(
data=[[--, --, --],
[--, --, --],
[--, --, --]],
mask=[[ True, True, True],
[ True, True, True],
[ True, True, True]],
fill_value=1e+20,
dtype=float64)
The `dtype` parameter defines the underlying data type.
>>> a = ma.masked_all((3, 3))
>>> a.dtype
dtype('float64')
>>> a = ma.masked_all((3, 3), dtype=np.int32)
>>> a.dtype
dtype('int32')
)�mask)r= �np�emptyr@ r; )�shape�dtype�arN rN rO r i s / c C s, t j| �jt�}t j|jt|j�d�|_|S )a�
Empty masked array with the properties of an existing array.
Return an empty masked array of the same shape and dtype as
the array `arr`, where all the data are masked.
Parameters
----------
arr : ndarray
An array describing the shape and dtype of the required MaskedArray.
Returns
-------
a : MaskedArray
A masked array with all data masked.
Raises
------
AttributeError
If `arr` doesn't have a shape attribute (i.e. not an ndarray)
See Also
--------
masked_all : Empty masked array with all elements masked.
Examples
--------
>>> import numpy.ma as ma
>>> arr = np.zeros((2, 3), dtype=np.float32)
>>> arr
array([[0., 0., 0.],
[0., 0., 0.]], dtype=float32)
>>> ma.masked_all_like(arr)
masked_array(
data=[[--, --, --],
[--, --, --]],
mask=[[ True, True, True],
[ True, True, True]],
fill_value=1e+20,
dtype=float32)
The dtype of the masked array matches the dtype of `arr`.
>>> arr.dtype
dtype('float32')
>>> ma.masked_all_like(arr).dtype
dtype('float32')
)rY ) rV Z
empty_like�viewr1 r@ rX r; rY �_mask)rR rZ rN rN rO r � s 2c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �_fromnxfunctionaV
Defines a wrapper to adapt NumPy functions to masked arrays.
An instance of `_fromnxfunction` can be called with the same parameters
as the wrapped NumPy function. The docstring of `newfunc` is adapted from
the wrapped function as well, see `getdoc`.
This class should not be used directly. Instead, one of its extensions that
provides support for a specific type of input should be used.
Parameters
----------
funcname : str
The name of the function to be adapted. The function should be
in the NumPy namespace (i.e. ``np.funcname``).
c C s || _ | j� | _d S )N)�__name__�getdoc�__doc__)�self�funcnamerN rN rO �__init__� s z_fromnxfunction.__init__c C sF t t| jd�}t |dd�}|rB| jtj|� }d}dj|||f�S dS )a
Retrieve the docstring and signature from the function.
The ``__doc__`` attribute of the function is used as the docstring for
the new masked array version of the function. A note on application
of the function to the mask is appended.
.. warning::
If the function docstring already contained a Notes section, the
new docstring will have two Notes sections instead of appending a note
to the existing section.
Parameters
----------
None
Nr` zLNotes
-----
The function is applied to both the _data and the _mask, if any.�
)�getattrrV r^ �maZget_object_signature�join)ra Znpfunc�doc�sigZlocdocrN rN rO r_ � s z_fromnxfunction.getdocc O s d S )NrN )ra �args�paramsrN rN rO �__call__
s z_fromnxfunction.__call__N)r^ �
__module__� __qualname__r` rc r_ rl rN rN rN rO r] � s r] c @ s e Zd ZdZdd� ZdS )�_fromnxfunction_singlez�
A version of `_fromnxfunction` that is called with a single array
argument followed by auxiliary args that are passed verbatim for
both the data and mask calls.
c O s� t t| j�}t|t�rJ||j� f|�|�}|t|�f|�|�}t||d�S |tj|�f|�|�}|t|�f|�|�}t||d�S d S )N)rU ) re rV r^ rJ rE Z __array__r: r= r5 )ra �xrj rk �func�_d�_mrN rN rO rl s
z _fromnxfunction_single.__call__N)r^ rm rn r` rl rN rN rN rO ro s ro c @ s e Zd ZdZdd� ZdS )�_fromnxfunction_seqz�
A version of `_fromnxfunction` that is called with a single sequence
of arrays followed by auxiliary args that are passed verbatim for
both the data and mask calls.
c O sT t t| j�}|tdd� |D ��f|�|�}|tdd� |D ��f|�|�}t||d�S )Nc S s g | ]}t j|��qS rN )rV r5 )�.0rZ rN rN rO �
<listcomp>( s z0_fromnxfunction_seq.__call__.<locals>.<listcomp>c S s g | ] }t |��qS rN )r: )ru rZ rN rN rO rv ) s )rU )re rV r^ rK r= )ra rp rj rk rq rr rs rN rN rO rl & s z _fromnxfunction_seq.__call__N)r^ rm rn r` rl rN rN rN rO rt s rt c @ s e Zd ZdZdd� ZdS )�_fromnxfunction_argsa�
A version of `_fromnxfunction` that is called with multiple array
arguments. The first non-array-like input marks the beginning of the
arguments that are passed verbatim for both the data and mask calls.
Array arguments are processed independently and the results are
returned in a list. If only one array is found, the return value is
just the processed array instead of a list.
c O s� t t| j�}g }t|�}x,t|�dkrDt|d �rD|j|jd�� qW g }xH|D ]@}|tj|�f|�|�}|t |�f|�|�}|jt
||d�� qPW t|�dkr�|d S |S )Nr. )rU r/ ) re rV r^ rL �lenrP �append�popr5 r: r= ) ra rj rk rq �arrays�resrp rr rs rN rN rO rl 6 s
z _fromnxfunction_args.__call__N)r^ rm rn r` rl rN rN rN rO rw - s rw c @ s e Zd ZdZdd� ZdS )�_fromnxfunction_allargsa
A version of `_fromnxfunction` that is called with multiple array
arguments. Similar to `_fromnxfunction_args` except that all args
are converted to arrays even if they are not so already. This makes
it possible to process scalars as 1-D arrays. Only keyword arguments
are passed through verbatim for the data and mask calls. Arrays
arguments are processed independently and the results are returned
in a list. If only one arg is present, the return value is just the
processed array instead of a list.
c O sj t t| j�}g }x@|D ]8}|tj|�f|�}|t|�f|�}|jt||d�� qW t|�dkrf|d S |S )N)rU r/ r. )re rV r^ r5 r: ry r= rx )ra rj rk rq r| rp rr rs rN rN rO rl Q s
z _fromnxfunction_allargs.__call__N)r^ rm rn r` rl rN rN rN rO r} F s
r} c C sJ d}x@|t | �krDx&t| | d�r8| | | ||d �< qW |d7 }qW | S )z Flatten a sequence in place.r. �__iter__r/ )rx �hasattr)rM �krN rN rO �flatten_inplaceo s r� c
O s~ t |ddd�}|j}t||�}dg|d }tj|d�}tt|��}|j|� tdd�||< tj |j
�j |�} |j ||� | |t
|j� � f|�|�}
tj|
�} | s�y t|
� W n tk
r� d} Y nX g } | �r�| jtj |
�j� t| t�}
|
|
t
|�< tj| �}d}x�||k �r�|d
d7 < d }xJ|| | | k�rt|d| k�rt||d d7 < d||< |d8 }�q,W |j ||� | |t
|j� � f|�|�}
|
|
t
|�< | jt |
�j� |d7 }�q W �nft |
ddd�}
|j� }tdd�g|
j ||< |j ||� tj| �}| }t|j
�} |
j
| |< | jt |
�j� t| �} t| t�}
|
|
t
t|j� ��< d}x�||k �r0|d d7 < d
}xJ|| || k�r�|d| k�r�||d d7 < d||< |d8 }�q�W |j ||� |j ||� | |t
|j� � f|�|�}
|
|
t
t|j� ��< | jt |
�j� |d7 }�qbW tjtj | �j� �}t|d��sbtj |
|d �}nt |
|d �}tj|�|_ |S )z0
(This docstring should be overwritten)
FT)�copy�subokr. r/ �ONr\ )rY ���r� r� r� ) r4 �ndimrF rV rB rL �range�remove�slicer5 rX Ztake�putrK �tolistZisscalarrx � TypeErrorry rY �object�productr� r� �maxr rf Zdefault_fill_value�
fill_value)Zfunc1drS rR rj �kwargs�nd�ind�iZindlistZoutshaper| ZasscalarZdtypesZoutarrZNtotr� �n�jZ holdshapeZ
max_dtypes�resultrN rN rO r y s�
"
" c C s� t |�}|j}t|�jdkr"|f}xd|D ]\}|dk r<|| }||f}| |� }|j|jkr^|}q(tj||�}|j|jkr||}q(td��q(W |S )z.
(This docstring will be overwritten)
r. z7function is not returning an array of the correct shape)r5 r� r4 rf Z expand_dims�
ValueError)rq rZ �axes�val�NrS rj r| rN rN rO r � s
ZNotesao
Examples
--------
>>> a = np.ma.arange(24).reshape(2,3,4)
>>> a[:,0,1] = np.ma.masked
>>> a[:,1,:] = np.ma.masked
>>> a
masked_array(
data=[[[0, --, 2, 3],
[--, --, --, --],
[8, 9, 10, 11]],
[[12, --, 14, 15],
[--, --, --, --],
[20, 21, 22, 23]]],
mask=[[[False, True, False, False],
[ True, True, True, True],
[False, False, False, False]],
[[False, True, False, False],
[ True, True, True, True],
[False, False, False, False]]],
fill_value=999999)
>>> np.ma.apply_over_axes(np.ma.sum, a, [0,2])
masked_array(
data=[[[46],
[--],
[124]]],
mask=[[[False],
[ True],
[False]]],
fill_value=999999)
Tuple axis arguments to ufuncs are equivalent:
>>> np.ma.sum(a, axis=(0,2)).reshape((1,-1,1))
masked_array(
data=[[[46],
[--],
[124]]],
mask=[[[False],
[ True],
[False]]],
fill_value=999999)
Fc C s` t | �} t| �}|dkr6| j|�}|jj| j|��}n�tj|�}t| jjtj tj
f�rjtj | j|jd�}ntj | j|j�}| j |j kr�|dkr�t
d��|jdkr�t
d��|j d | j | kr�td��tj|| jd d
|j �}|jd |�}|tk �r|| j }|j||d�}tj| ||d �j|�| }|�rX|j |j k�rPtj||j �j� }||fS |S dS ) an
Return the weighted average of array over the given axis.
Parameters
----------
a : array_like
Data to be averaged.
Masked entries are not taken into account in the computation.
axis : int, optional
Axis along which to average `a`. If None, averaging is done over
the flattened array.
weights : array_like, optional
The importance that each element has in the computation of the average.
The weights array can either be 1-D (in which case its length must be
the size of `a` along the given axis) or of the same shape as `a`.
If ``weights=None``, then all data in `a` are assumed to have a
weight equal to one. The 1-D calculation is::
avg = sum(a * weights) / sum(weights)
The only constraint on `weights` is that `sum(weights)` must not be 0.
returned : bool, optional
Flag indicating whether a tuple ``(result, sum of weights)``
should be returned as output (True), or just the result (False).
Default is False.
Returns
-------
average, [sum_of_weights] : (tuple of) scalar or MaskedArray
The average along the specified axis. When returned is `True`,
return a tuple with the average as the first element and the sum
of the weights as the second element. The return type is `np.float64`
if `a` is of integer type and floats smaller than `float64`, or the
input data-type, otherwise. If returned, `sum_of_weights` is always
`float64`.
Examples
--------
>>> a = np.ma.array([1., 2., 3., 4.], mask=[False, False, True, True])
>>> np.ma.average(a, weights=[3, 1, 0, 0])
1.25
>>> x = np.ma.arange(6.).reshape(3, 2)
>>> x
masked_array(
data=[[0., 1.],
[2., 3.],
[4., 5.]],
mask=False,
fill_value=1e+20)
>>> avg, sumweights = np.ma.average(x, axis=0, weights=[1, 2, 3],
... returned=True)
>>> avg
masked_array(data=[2.6666666666666665, 3.6666666666666665],
mask=[False, False],
fill_value=1e+20)
NZf8z;Axis must be specified when shapes of a and weights differ.r/ z81D weights expected when shapes of a and weights differ.r. z5Length of weights not compatible with specified axis.)rS rY )rY )r/ r� )r5 r9 �meanrY �typer8 rV �
asanyarray�
issubclass�integerZbool_Z result_typerX r� r� r� Z broadcast_toZswapaxesr? rU rQ �multiplyr� ) rZ rS �weightsZreturnedrT �avgZsclZwgtZ result_dtyperN rN rO r s< ;
c C sx t | d�sLtjt| dd�||||d�}t|tj�rHd|jkrHt|dd�S |S t| t |||d�\}}|rp|j
|�S |S d S )
a>
Compute the median along the specified axis.
Returns the median of the array elements.
Parameters
----------
a : array_like
Input array or object that can be converted to an array.
axis : int, optional
Axis along which the medians are computed. The default (None) is
to compute the median along a flattened version of the array.
out : ndarray, optional
Alternative output array in which to place the result. It must
have the same shape and buffer length as the expected output
but the type will be cast if necessary.
overwrite_input : bool, optional
If True, then allow use of memory of input array (a) for
calculations. The input array will be modified by the call to
median. This will save memory when you do not need to preserve
the contents of the input array. Treat the input as undefined,
but it will probably be fully or partially sorted. Default is
False. Note that, if `overwrite_input` is True, and the input
is not already an `ndarray`, an error will be raised.
keepdims : bool, optional
If this is set to True, the axes which are reduced are left
in the result as dimensions with size one. With this option,
the result will broadcast correctly against the input array.
.. versionadded:: 1.10.0
Returns
-------
median : ndarray
A new array holding the result is returned unless out is
specified, in which case a reference to out is returned.
Return data-type is `float64` for integers and floats smaller than
`float64`, or the input data-type, otherwise.
See Also
--------
mean
Notes
-----
Given a vector ``V`` with ``N`` non masked values, the median of ``V``
is the middle value of a sorted copy of ``V`` (``Vs``) - i.e.
``Vs[(N-1)/2]``, when ``N`` is odd, or ``{Vs[N/2 - 1] + Vs[N/2]}/2``
when ``N`` is even.
Examples
--------
>>> x = np.ma.array(np.arange(8), mask=[0]*4 + [1]*4)
>>> np.ma.median(x)
1.5
>>> x = np.ma.array(np.arange(10).reshape(2, 5), mask=[0]*6 + [1]*4)
>>> np.ma.median(x)
2.5
>>> np.ma.median(x, axis=-1, overwrite_input=True)
masked_array(data=[2.0, 5.0],
mask=[False, False],
fill_value=1e+20)
rU T)r� )rS �out�overwrite_input�keepdimsr/ F)r� )rq rS r� r� N) r rV r! rC rJ rE r� r= rH �_median�reshape)rZ rS r� r� r� rT �rr� rN rN rO r! s B
c sf t j| jt j�rt j}nd }|rR�d kr>| j� � � j|d� q`| j�|d� | � nt| �|d�� �d krnd�n t�� j��� j � dkr�t
d �g� j }t
dd�|�< t |�}t j j
� | �|d�S � jdk�r�t� �}tt� �d�\}}� || d |d � } t j� jt j��rZ� jdk�rZ| j|d�}
|�sDt j|
dd |d
�}
t jjj� |
�|�}
n | j
|d�}
t j j|
��r�t j� j� �r�t j j� �S |
S t� �d d �}|d } |d dk}t j|| | d �} t j| | g�d
�}
t j � |
�d
�}� �fdd�}||� t j� jt j��rPt j j|�|d�}
t j|
j dd|
j d
� t jjj� |
�|�}
nt j j
|�|d�}
|
S )N)r� )rS r� r. )rS r� r/ � )r� g @�safe)Zcastingr� T)rS r� )rS c sF t jj| �rBt j� j�dd� | j@ }t jj� �| j|< d| j|< d S )NT)rS r� F)rV rf � is_masked�allrU �minimum_fill_value�data)�s�rep)�asortedrS rN rO �replace_masked s z _median.<locals>.replace_maskedZunsafe) rV Z
issubdtyperY Zinexact�inf�ravelrA rF r� rX r� rK rf r� r8 �divmod�sizerQ Z true_divide�lib�utilsZ_median_nancheckr� r� rU r� �wherer6 Ztake_along_axisr� )rZ rS r� r� r� Zindexer�counts�idxZoddZmidr� �h�lZlhZlow_highr� rN )r� rS rO r� � sZ
r� c C s� t | �} t| �}|dkr(tt| j��}n t|| j�}|tksF|j� rL| jS |j � r\t
g �S | j}xR|D ]J}tt t|��t t|d | j�� �}|t d�f| |j|d� f }qhW |S )a� Suppress slices from multiple dimensions which contain masked values.
Parameters
----------
x : array_like, MaskedArray
The array to operate on. If not a MaskedArray instance (or if no array
elements are masked), `x` is interpreted as a MaskedArray with `mask`
set to `nomask`.
axis : tuple of ints or int, optional
Which dimensions to suppress slices from can be configured with this
parameter.
- If axis is a tuple of ints, those are the axes to suppress slices from.
- If axis is an int, then that is the only axis to suppress slices from.
- If axis is None, all axis are selected.
Returns
-------
compress_array : ndarray
The compressed array.
Nr/ )rS )
r5 r9 rK r� r� rG r? �any�_datar� �nxarrayrL r� )rp rS rT r� Zaxr� rN rN rO r ' s
$&c C s" t | �jdkrtd��t| |d�S )a�
Suppress the rows and/or columns of a 2-D array that contain
masked values.
The suppression behavior is selected with the `axis` parameter.
- If axis is None, both rows and columns are suppressed.
- If axis is 0, only rows are suppressed.
- If axis is 1 or -1, only columns are suppressed.
Parameters
----------
x : array_like, MaskedArray
The array to operate on. If not a MaskedArray instance (or if no array
elements are masked), `x` is interpreted as a MaskedArray with
`mask` set to `nomask`. Must be a 2D array.
axis : int, optional
Axis along which to perform the operation. Default is None.
Returns
-------
compressed_array : ndarray
The compressed array.
Examples
--------
>>> x = np.ma.array(np.arange(9).reshape(3, 3), mask=[[1, 0, 0],
... [1, 0, 0],
... [0, 0, 0]])
>>> x
masked_array(
data=[[--, 1, 2],
[--, 4, 5],
[6, 7, 8]],
mask=[[ True, False, False],
[ True, False, False],
[False, False, False]],
fill_value=999999)
>>> np.ma.compress_rowcols(x)
array([[7, 8]])
>>> np.ma.compress_rowcols(x, 0)
array([[6, 7, 8]])
>>> np.ma.compress_rowcols(x, 1)
array([[1, 2],
[4, 5],
[7, 8]])
r� z*compress_rowcols works for 2D arrays only.)rS )r5 r� �NotImplementedErrorr )rp rS rN rN rO r Q s 2c C s$ t | �} | jdkrtd��t| d�S )z�
Suppress whole rows of a 2-D array that contain masked values.
This is equivalent to ``np.ma.compress_rowcols(a, 0)``, see
`extras.compress_rowcols` for details.
See Also
--------
extras.compress_rowcols
r� z'compress_rows works for 2D arrays only.r. )r5 r� r� r )rZ rN rN rO r
� s
c C s$ t | �} | jdkrtd��t| d�S )z�
Suppress whole columns of a 2-D array that contain masked values.
This is equivalent to ``np.ma.compress_rowcols(a, 1)``, see
`extras.compress_rowcols` for details.
See Also
--------
extras.compress_rowcols
r� z'compress_cols works for 2D arrays only.r/ )r5 r� r� r )rZ rN rN rO r
� s
c C s$ |t jk rtjdtdd� t| d�S )a�
Mask rows of a 2D array that contain masked values.
This function is a shortcut to ``mask_rowcols`` with `axis` equal to 0.
See Also
--------
mask_rowcols : Mask rows and/or columns of a 2D array.
masked_where : Mask where a condition is met.
Examples
--------
>>> import numpy.ma as ma
>>> a = np.zeros((3, 3), dtype=int)
>>> a[1, 1] = 1
>>> a
array([[0, 0, 0],
[0, 1, 0],
[0, 0, 0]])
>>> a = ma.masked_equal(a, 1)
>>> a
masked_array(
data=[[0, 0, 0],
[0, --, 0],
[0, 0, 0]],
mask=[[False, False, False],
[False, True, False],
[False, False, False]],
fill_value=1)
>>> ma.mask_rows(a)
masked_array(
data=[[0, 0, 0],
[--, --, --],
[0, 0, 0]],
mask=[[False, False, False],
[ True, True, True],
[False, False, False]],
fill_value=1)
zTThe axis argument has always been ignored, in future passing it will raise TypeErrorr� )�
stacklevelr. )rV �_NoValue�warnings�warn�DeprecationWarningr )rZ rS rN rN rO r � s
*
c C s$ |t jk rtjdtdd� t| d�S )a�
Mask columns of a 2D array that contain masked values.
This function is a shortcut to ``mask_rowcols`` with `axis` equal to 1.
See Also
--------
mask_rowcols : Mask rows and/or columns of a 2D array.
masked_where : Mask where a condition is met.
Examples
--------
>>> import numpy.ma as ma
>>> a = np.zeros((3, 3), dtype=int)
>>> a[1, 1] = 1
>>> a
array([[0, 0, 0],
[0, 1, 0],
[0, 0, 0]])
>>> a = ma.masked_equal(a, 1)
>>> a
masked_array(
data=[[0, 0, 0],
[0, --, 0],
[0, 0, 0]],
mask=[[False, False, False],
[False, True, False],
[False, False, False]],
fill_value=1)
>>> ma.mask_cols(a)
masked_array(
data=[[0, --, 0],
[0, --, 0],
[0, --, 0]],
mask=[[False, True, False],
[False, True, False],
[False, True, False]],
fill_value=1)
zTThe axis argument has always been ignored, in future passing it will raise TypeErrorr� )r� r/ )rV r� r� r� r� r )rZ rS rN rN rO r � s
)
c C sh t j| �j} | dd� | dd� }|g}|dk r>|jd|� |dk rP|j|� t|�dkrdt|�}|S )a!
Compute the differences between consecutive elements of an array.
This function is the equivalent of `numpy.ediff1d` that takes masked
values into account, see `numpy.ediff1d` for details.
See Also
--------
numpy.ediff1d : Equivalent function for ndarrays.
r/ Nr. r� )rf r� Zflat�insertry rx r )rR Zto_endZto_beginZedr{ rN rN rO r s
c C sL t j| ||d�}t|t�r>t|�}|d jt�|d< t|�}n
|jt�}|S )a
Finds the unique elements of an array.
Masked values are considered the same element (masked). The output array
is always a masked array. See `numpy.unique` for more details.
See Also
--------
numpy.unique : Equivalent function for ndarrays.
)� return_index�return_inverser. )rV r* rJ rK rL r[ r1 )�ar1r� r� �outputrN rN rO r* / s
c C sV |rt j| |f�}nt jt| �t|�f�}|j� |dd� |dd� |dd� k S )a>
Returns the unique elements common to both arrays.
Masked values are considered equal one to the other.
The output is always a masked array.
See `numpy.intersect1d` for more details.
See Also
--------
numpy.intersect1d : Equivalent function for ndarrays.
Examples
--------
>>> x = np.ma.array([1, 3, 3, 3], mask=[0, 0, 0, 1])
>>> y = np.ma.array([3, 1, 1, 1], mask=[0, 0, 0, 1])
>>> np.ma.intersect1d(x, y)
masked_array(data=[1, 3, --],
mask=[False, False, True],
fill_value=999999)
Nr/ r� r� )rf r6 r* rA )r� �ar2�
assume_unique�auxrN rN rO r G s
c C s� |st | �} t |�}tj| |f�}|jdkr0|S |j� |j� }tjdg|dd� |dd� kdgf�}|dd� |dd� k}|| S )z�
Set exclusive-or of 1-D arrays with unique elements.
The output is always a masked array. See `numpy.setxor1d` for more details.
See Also
--------
numpy.setxor1d : Equivalent function for ndarrays.
r. Tr/ Nr� r� )r* rf r6 r� rA r7 )r� r� r� r� Zauxf�flagZflag2rN rN rO r( g s
(c C s� |s t | dd�\} }t |�}tj| |f�}|jdd�}|| }|r\|dd� |dd� k}n|dd� |dd� k}tj||gf�} |jdd�dt| �� }
|r�| |
S | |
| S dS ) a�
Test whether each element of an array is also present in a second
array.
The output is always a masked array. See `numpy.in1d` for more details.
We recommend using :func:`isin` instead of `in1d` for new code.
See Also
--------
isin : Version of this function that preserves the shape of ar1.
numpy.in1d : Equivalent function for ndarrays.
Notes
-----
.. versionadded:: 1.4.0
T)r� Z mergesort)�kindr/ Nr� r� )r* rf r6 Zargsortrx ) r� r� r� �invertZrev_idx�ar�orderZsarZbool_arr� ZindxrN rN rO r � s c C s" t j| �} t| |||d�j| j�S )a|
Calculates `element in test_elements`, broadcasting over
`element` only.
The output is always a masked array of the same shape as `element`.
See `numpy.isin` for more details.
See Also
--------
in1d : Flattened version of this function.
numpy.isin : Equivalent function for ndarrays.
Notes
-----
.. versionadded:: 1.13.0
)r� r� )rf r5 r r� rX )�elementZ
test_elementsr� r� rN rN rO r � s
c C s t tj| |fdd��S )z�
Union of two arrays.
The output is always a masked array. See `numpy.union1d` for more details.
See also
--------
numpy.union1d : Equivalent function for ndarrays.
N)rS )r* rf r6 )r� r� rN rN rO r+ � s c C s8 |rt j| �j� } nt| �} t|�}| t| |ddd� S )a�
Set difference of 1D arrays with unique elements.
The output is always a masked array. See `numpy.setdiff1d` for more
details.
See Also
--------
numpy.setdiff1d : Equivalent function for ndarrays.
Examples
--------
>>> x = np.ma.array([1, 2, 3, 4], mask=[0, 1, 0, 1])
>>> np.ma.setdiff1d(x, [1, 2])
masked_array(data=[3, --],
mask=[False, True],
fill_value=999999)
T)r� r� )rf r5 r� r* r )r� r� r� rN rN rO r' � s
Tc
C s` t j| ddtd�} t j| �}| r2|j� r2td��| jd dkrDd}tt|��}d| }|rjt d�df}n dt d�f}|dkr�t
j |�j t�}n�t|ddtd �}t j|�}| r�|j� r�td��|j� s�|j� �r|j| jk�rt
j
||�} | tk �r| } | _ |_}d| _d|_t j| |f|�} t
j t
j||f|��j t�}| | j|d
�| 8 } | ||fS ) z_
Private function for the computation of covariance and correlation
coefficients.
r� T)�ndminr� rY zCannot process masked data.r. r/ NF)r� r� rY )rS )rf r4 �floatr: r� r� rX �int�boolr� rV Z logical_notZastype�
logical_orr? r\ � _sharedmaskr6 r� )
rp �y�rowvar� allow_maskedZxmaskrS �tup�xnotmaskZymaskZ common_maskrN rN rO �
_covhelper� s8
r� c C s� |dk r |t |�kr td��|dkr2|r.d}nd}t| |||�\} }}|s~tj|j|�d | }t| j| j� dd�| j� }n2tj||j�d | }t| | jj� dd�| j� }|S )aJ
Estimate the covariance matrix.
Except for the handling of missing data this function does the same as
`numpy.cov`. For more details and examples, see `numpy.cov`.
By default, masked values are recognized as such. If `x` and `y` have the
same shape, a common mask is allocated: if ``x[i,j]`` is masked, then
``y[i,j]`` will also be masked.
Setting `allow_masked` to False will raise an exception if values are
missing in either of the input arrays.
Parameters
----------
x : array_like
A 1-D or 2-D array containing multiple variables and observations.
Each row of `x` represents a variable, and each column a single
observation of all those variables. Also see `rowvar` below.
y : array_like, optional
An additional set of variables and observations. `y` has the same
form as `x`.
rowvar : bool, optional
If `rowvar` is True (default), then each row represents a
variable, with observations in the columns. Otherwise, the relationship
is transposed: each column represents a variable, while the rows
contain observations.
bias : bool, optional
Default normalization (False) is by ``(N-1)``, where ``N`` is the
number of observations given (unbiased estimate). If `bias` is True,
then normalization is by ``N``. This keyword can be overridden by
the keyword ``ddof`` in numpy versions >= 1.5.
allow_masked : bool, optional
If True, masked values are propagated pair-wise: if a value is masked
in `x`, the corresponding value is masked in `y`.
If False, raises a `ValueError` exception when some values are missing.
ddof : {None, int}, optional
If not ``None`` normalization is by ``(N - ddof)``, where ``N`` is
the number of observations; this overrides the value implied by
``bias``. The default value is ``None``.
.. versionadded:: 1.5
Raises
------
ValueError
Raised if some values are missing and `allow_masked` is False.
See Also
--------
numpy.cov
Nzddof must be an integerr. r/ g �?F)�strict)r� r� r� rV r �T�conj�squeeze) rp r� r� �biasr� �ddofr� �factr� rN rN rO r s 6 c C s d}|t jk s|t jk r(tj|tdd� t| |||�\} }}|spt j|j|�d }t| j| j� dd�| j � } n.t j||j�d }t| | jj� dd�| j � } yt
j | �}
W n t k
r� dS X |j
� r�t
jt
jj|
|
��} �n$t|
�} d| _| jd| } |�r~xvt| d �D ]f}
x^t|
d | �D ]L}tt| |
| | f��jdd�}t
jt
jj|�� | |
|f< | ||
f< �q&W �qW n�x�t| d �D ]v}
xnt|
d | �D ]\}tt| d d �|
f | d d �|f f��jdd�}t
jt
jj|�� | |
|f< | ||
f< �q�W �q�W | | S )
a6
Return Pearson product-moment correlation coefficients.
Except for the handling of missing data this function does the same as
`numpy.corrcoef`. For more details and examples, see `numpy.corrcoef`.
Parameters
----------
x : array_like
A 1-D or 2-D array containing multiple variables and observations.
Each row of `x` represents a variable, and each column a single
observation of all those variables. Also see `rowvar` below.
y : array_like, optional
An additional set of variables and observations. `y` has the same
shape as `x`.
rowvar : bool, optional
If `rowvar` is True (default), then each row represents a
variable, with observations in the columns. Otherwise, the relationship
is transposed: each column represents a variable, while the rows
contain observations.
bias : _NoValue, optional
Has no effect, do not use.
.. deprecated:: 1.10.0
allow_masked : bool, optional
If True, masked values are propagated pair-wise: if a value is masked
in `x`, the corresponding value is masked in `y`.
If False, raises an exception. Because `bias` is deprecated, this
argument needs to be treated as keyword only to avoid a warning.
ddof : _NoValue, optional
Has no effect, do not use.
.. deprecated:: 1.10.0
See Also
--------
numpy.corrcoef : Equivalent function in top-level NumPy module.
cov : Estimate the covariance matrix.
Notes
-----
This function accepts but discards arguments `bias` and `ddof`. This is
for backwards compatibility with previous versions of this function. These
arguments had no effect on the return values of the function and can be
safely ignored in this and previous versions of numpy.
z/bias and ddof have no effect and are deprecatedr� )r� g �?F)r� r/ )rS N)rV r� r� r� r� r� r r� r� r� rf Zdiagonalr� r� �sqrtr� �outerr r� rX r� r r- �var�reduce)rp r� r� r� r� r� �msgr� r� �cZdiagZ_denomr� r� r� �_xrN rN rO r f s: 0 4.2c s8 e Zd ZdZee�Ze� fdd��Z� fdd�Z� Z S )�MAxisConcatenatorz�
Translate slice objects to concatenation along an axis.
For documentation on usage, see `mr_class`.
See Also
--------
mr_class
c s$ t t| �j|jdd�}t||jd�S )NF)r� )rU )�superr� �makematr� r4 rU )�clsrR r� )� __class__rN rO r� � s zMAxisConcatenator.makematc s" t |t�rtd��tt| �j|�S )Nz Unavailable for masked array.)rJ �strr2 r� r� � __getitem__)ra �key)r� rN rO r� � s
z MAxisConcatenator.__getitem__)
r^ rm rn r` � staticmethodr6 � classmethodr� r� �
__classcell__rN rN )r� rO r� � s
r� c @ s e Zd ZdZdd� ZdS )�mr_classa�
Translate slice objects to concatenation along the first axis.
This is the masked array version of `lib.index_tricks.RClass`.
See Also
--------
lib.index_tricks.RClass
Examples
--------
>>> np.ma.mr_[np.ma.array([1,2,3]), 0, 0, np.ma.array([4,5,6])]
masked_array(data=[1, 2, 3, ..., 4, 5, 6],
mask=False,
fill_value=999999)
c C s t j| d� d S )Nr. )r� rc )ra rN rN rO rc � s zmr_class.__init__N)r^ rm rn r` rc rN rN rN rO r� � s r� c C s\ t | �}|tks tj|� r0tjd| jd g�S tj| �}t|�dkrT|ddg S dS dS )a�
Find the indices of the first and last unmasked values.
Expects a 1-D `MaskedArray`, returns None if all values are masked.
Parameters
----------
a : array_like
Input 1-D `MaskedArray`
Returns
-------
edges : ndarray or None
The indices of first and last non-masked value in the array.
Returns None if all values are masked.
See Also
--------
flatnotmasked_contiguous, notmasked_contiguous, notmasked_edges
clump_masked, clump_unmasked
Notes
-----
Only accepts 1-D arrays.
Examples
--------
>>> a = np.ma.arange(10)
>>> np.ma.flatnotmasked_edges(a)
array([0, 9])
>>> mask = (a < 3) | (a > 8) | (a == 5)
>>> a[mask] = np.ma.masked
>>> np.array(a[~a.mask])
array([3, 4, 6, 7, 8])
>>> np.ma.flatnotmasked_edges(a)
array([3, 8])
>>> a[:] = np.ma.masked
>>> print(np.ma.flatnotmasked_edges(a))
None
r. r/ Nr� )r9 r? rV r� r4 r� Z flatnonzerorx )rZ rT ZunmaskedrN rN rO r � s - c s� t | �} � dks| jdkr"t| �S t| �}ttj| j�tj |g| j �d��t� �fdd�t | j�D ��t� �fdd�t | j�D ��gS )a_
Find the indices of the first and last unmasked values along an axis.
If all values are masked, return None. Otherwise, return a list
of two tuples, corresponding to the indices of the first and last
unmasked values respectively.
Parameters
----------
a : array_like
The input array.
axis : int, optional
Axis along which to perform the operation.
If None (default), applies to a flattened version of the array.
Returns
-------
edges : ndarray or list
An array of start and end indexes if there are any masked data in
the array. If there are no masked data in the array, `edges` is a
list of the first and last index.
See Also
--------
flatnotmasked_contiguous, flatnotmasked_edges, notmasked_contiguous
clump_masked, clump_unmasked
Examples
--------
>>> a = np.arange(9).reshape((3, 3))
>>> m = np.zeros_like(a)
>>> m[1:, 1:] = 1
>>> am = np.ma.array(a, mask=m)
>>> np.array(am[~am.mask])
array([0, 1, 2, 3, 6])
>>> np.ma.notmasked_edges(am)
array([0, 6])
Nr/ )rU c s g | ]}�| j � �j� �qS rN )�min�
compressed)ru r� )rS r� rN rO rv _ s z#notmasked_edges.<locals>.<listcomp>c s g | ]}�| j � �j� �qS rN )r� r� )ru r� )rS r� rN rO rv ` s )
r5 r� r r: r4 rV �indicesrX rK r� )rZ rS rT rN )rS r� rO r$ 0 s *" c C sr t | �}|tkr td| j�gS d}g }xFtj|j� �D ]4\}}tt|��}|sb|j t||| �� ||7 }q6W |S )a�
Find contiguous unmasked data in a masked array along the given axis.
Parameters
----------
a : narray
The input array.
Returns
-------
slice_list : list
A sorted sequence of `slice` objects (start index, end index).
..versionchanged:: 1.15.0
Now returns an empty list instead of None for a fully masked array
See Also
--------
flatnotmasked_edges, notmasked_contiguous, notmasked_edges
clump_masked, clump_unmasked
Notes
-----
Only accepts 2-D arrays at most.
Examples
--------
>>> a = np.ma.arange(10)
>>> np.ma.flatnotmasked_contiguous(a)
[slice(0, 10, None)]
>>> mask = (a < 3) | (a > 8) | (a == 5)
>>> a[mask] = np.ma.masked
>>> np.array(a[~a.mask])
array([3, 4, 6, 7, 8])
>>> np.ma.flatnotmasked_contiguous(a)
[slice(3, 5, None), slice(6, 9, None)]
>>> a[:] = np.ma.masked
>>> np.ma.flatnotmasked_contiguous(a)
[]
r. )
r9 r? r� r� � itertools�groupbyr� rx rL ry )rZ rT r� r� r� �gr� rN rN rO r c s , c C s� t | �} | j}|dkr td��|dks.|dkr6t| �S g }|d d }ddg}tdd�||< x4t| j| �D ]"}|||< |jt| t|� �� qlW |S )a�
Find contiguous unmasked data in a masked array along the given axis.
Parameters
----------
a : array_like
The input array.
axis : int, optional
Axis along which to perform the operation.
If None (default), applies to a flattened version of the array, and this
is the same as `flatnotmasked_contiguous`.
Returns
-------
endpoints : list
A list of slices (start and end indexes) of unmasked indexes
in the array.
If the input is 2d and axis is specified, the result is a list of lists.
See Also
--------
flatnotmasked_edges, flatnotmasked_contiguous, notmasked_edges
clump_masked, clump_unmasked
Notes
-----
Only accepts 2-D arrays at most.
Examples
--------
>>> a = np.arange(12).reshape((3, 4))
>>> mask = np.zeros_like(a)
>>> mask[1:, :-1] = 1; mask[0, 1] = 1; mask[-1, 0] = 0
>>> ma = np.ma.array(a, mask=mask)
>>> ma
masked_array(
data=[[0, --, 2, 3],
[--, --, --, 7],
[8, --, --, 11]],
mask=[[False, True, False, False],
[ True, True, True, False],
[False, True, True, False]],
fill_value=999999)
>>> np.array(ma[~ma.mask])
array([ 0, 2, 3, 7, 8, 11])
>>> np.ma.notmasked_contiguous(ma)
[slice(0, 1, None), slice(2, 4, None), slice(7, 9, None), slice(11, 12, None)]
>>> np.ma.notmasked_contiguous(ma, axis=0)
[[slice(0, 1, None), slice(2, 3, None)], [], [slice(0, 1, None)], [slice(0, 3, None)]]
>>> np.ma.notmasked_contiguous(ma, axis=1)
[[slice(0, 1, None), slice(2, 4, None)], [slice(3, 4, None)], [slice(0, 1, None), slice(3, 4, None)]]
r� z%Currently limited to atmost 2D array.Nr/ r. ) r5 r� r� r r� r� rX ry rK )rZ rS r� r� �otherr� r� rN rN rO r# � s : c C s� | j dkr| j� } | dd� | dd � A j� }|d d }| d r�t|�dkr\td| j�gS td|d �g}|jdd� t|dd
d� |ddd� �D �� n8t|�dkr�g S dd� t|dd d� |ddd� �D �}| d r�|jt|d
| j�� |S )zv
Finds the clumps (groups of data with the same values) for a 1D bool array.
Returns a series of slices.
r/ Nr. c s s | ]\}}t ||�V qd S )N)r� )ru �left�rightrN rN rO � <genexpr>� s z_ezclump.<locals>.<genexpr>r� c S s g | ]\}}t ||��qS rN )r� )ru r r rN rN rO rv � s z _ezclump.<locals>.<listcomp>r� r� r� r� r� ) r� r� Znonzerorx r� r� �extend�zipry )rU r� r� rN rN rO �_ezclump� s
& (r c C s, t | dt�}|tkr"td| j�gS t| �S )a�
Return list of slices corresponding to the unmasked clumps of a 1-D array.
(A "clump" is defined as a contiguous region of the array).
Parameters
----------
a : ndarray
A one-dimensional masked array.
Returns
-------
slices : list of slice
The list of slices, one for each continuous region of unmasked
elements in `a`.
Notes
-----
.. versionadded:: 1.4.0
See Also
--------
flatnotmasked_edges, flatnotmasked_contiguous, notmasked_edges
notmasked_contiguous, clump_masked
Examples
--------
>>> a = np.ma.masked_array(np.arange(10))
>>> a[[0, 1, 2, 6, 8, 9]] = np.ma.masked
>>> np.ma.clump_unmasked(a)
[slice(3, 6, None), slice(7, 8, None)]
r\ r. )re r? r� r� r )rZ rU rN rN rO r s ! c C s t j| �}|tkrg S t|�S )a
Returns a list of slices corresponding to the masked clumps of a 1-D array.
(A "clump" is defined as a contiguous region of the array).
Parameters
----------
a : ndarray
A one-dimensional masked array.
Returns
-------
slices : list of slice
The list of slices, one for each continuous region of masked elements
in `a`.
Notes
-----
.. versionadded:: 1.4.0
See Also
--------
flatnotmasked_edges, flatnotmasked_contiguous, notmasked_edges
notmasked_contiguous, clump_unmasked
Examples
--------
>>> a = np.ma.masked_array(np.arange(10))
>>> a[[0, 1, 2, 6, 8, 9]] = np.ma.masked
>>> np.ma.clump_masked(a)
[slice(0, 3, None), slice(6, 7, None), slice(8, 10, None)]
)rf r9 r? r )rZ rU rN rN rO r , s !
c C s( t j| |�}t| �}|tk r$d||< |S )zD
Masked values in the input array result in rows of zeros.
r. )rV r, r9 r? )rp r� Z_vanderrT rN rN rO r, X s
c
C s t | �} t |�}t| �}|jdkr2t|t|��}n>|jdkrhtt|��}|tk rpt||dd�df �}ntd��|dk r�t |�}|jdkr�td��|jd |jd kr�td��t|t|��}|tk r�| } |dk r�|| }tj | | || |||||�S tj | ||||||�S dS )zE
Any masked values in x is propagated in y, and vice-versa.
r/ r� Nr. z Expected a 1D or 2D array for y!z expected a 1-d array for weightsz(expected w and y to have the same length)
r5 r9 r� r> r r? r� rX rV r% )
rp r� �degZrcond�full�wr rT ZmyZnot_mrN rN rO r% f s.
)N)NNF)NNFF)NNF)N)N)NN)FF)F)F)FF)FF)F)NTT)NTFTN)N)N)N)NFNF)gr` �__all__r� r� � r0 rf r1 r2 r3 r4 r5 r6 r7 r8 r9 r: r; r< r= r> r? r@ rA rB rC rD r r ZnumpyrV rE r� Znumpy.core.umathZumathZnumpy.core.multiarrayrF Znumpy.core.numericrG Znumpy.lib.function_baserH Znumpy.lib.index_tricksrI rP r r� r r r] ro rt rw r} r r r r- r& r r r r) r r r� r r �find�rstripr r! r� r r r
r
r� r r r r* r r( r r r+ r' r� r r r� r� r" r r$ r r# r r r r, Zdoc_noter% rN rN rN rO �<module>
s�
`
6 4:7
P
,
j
R
V
*
726
*
!
+
I
Y 7
38
M ',
" |