Current File : //lib64/python3.9/site-packages/numpy/ma/__pycache__/core.cpython-39.pyc
a
z[yc7 �
@ s�
d Z ddlZddlZddlZddlZddlZddlZddlmZ ddl Z
ddl m m
Z
ddlm mZ ddl mZmZmZmZmZmZ ddl mZ ddlmZ ddlm Z m Z m Z m Z m Z ddl m!Z! dd l"m#Z# g d
�Z$e
jZ%e%d�Z&G d d � d e'�Z(d
d� Z)dd� Z*dd� Z+G dd� de,�Z-G dd� de-�Z.dddddd dd d d � Z/d D ]6Z0e
�1d!e0�e/d"e0 d# < e
�2d!e0�e/d$e0 d# < �qRe
j3e
j4e
j5e
j6e
j7e
j8e
j9gZ:ej;Z<e<�=d%d&� e:dd'� D �� e<�=d(d&� e:d)d� D �� ej>Z?e?�=d*d&� e:dd'� D �� e?�=d+d&� e:d)d� D �� [:d,d-� Z@d.d/� ZAd0d1� ZBd2d3� ZCd4d5� ZDd6d7� ZEd8d9� ZFd:d;� ZGd<d=� ZHd>d?� ZId@dA� ZJ�dMdBdC�ZKdDdE� ZL�dNdFdG�ZMeMZNe&ddfdHdI�ZOdJdK� ZPi ZQi ZRG dLdM� dM�ZSG dNdO� dO�ZTG dPdQ� dQ�ZUG dRdS� dS�ZVG dTdU� dU�ZWG dVdW� dW�ZXG dXdY� dYeX�ZYG dZd[� d[eX�ZZG d\d]� d]eX�Z[eYe
j\�Z\eYe
j]�Z]eYe
j^�Z^eYe
j_�Z_eYe
j`�Z`eYe
ja�ZaeYe
jb�ZbeYe
jc�ZceYe
jd�ZdeYe
je� ZfZeeYe�ZeYe
jg�ZgeYe
jh�ZheYe
ji�ZieYe
jj�ZjeYe
jk�ZleYe
jm�ZmeYe
jnd^eWd^��ZneYe
jod_eVd^��ZoeYe
jpd_eVd^��ZpeYe
jqd_eVd^��ZqeYe
jrd^eTd`��ZreYe
jsd^eSdad_��ZseYe
jtd^eSdad_��ZteYe
jud_eWd_��ZueYe
jvd^eSdbdc��ZveZe
jw�ZweZe
jx�ZxeZe
jydddd�ZyeZe
jzd^d_�ZzeZe
j{�Z{de{_eZe
j|�Z|de|_eZe
j}�Z}de}_eZe
j~�Z~de~_eZe
j�Zde_eZe
j��Z�de�_eZe
j��Z�eZe
j�dddd�jZ�eZe
j��Z�e�jZ�eZe
j��Z�eZe
j��Z�eZe
j��Z�eZe
j��Z�eZe
j��Z�e[e
j�eU� ddd�Z�e[e
j�eU� ddd�Z�e[e
j�eU� ddd�Z�e[e
j�eU� ddd�Z�e[e
j�eU� ddd�Z�e[e
j�eU� ddd�Z�dedf� Z�dgdh� Z�didj� Z�dkdl� Z�e�Z�dmdn� Z�dodp� Z�dqdr� Z�dsde%fdtdu�Z��dOdvdw�Z�dxdy� Z��dPdzd{�Z�d|d}� Z�e
jfd~d�Z��dQd�d��Z��dRd�d��Z��dSd�d��Z��dTd�d��Z��dUd�d��Z��dVd�d��Z��dWd�d��Z��dXd�d��Z��dYd�d��Z��dZd�d��Z��d[d�d��Z��d\d�d��Z�G d�d�� d��Z�e�d��Z�d�d�� Z�e�e��d��e��d��e��d��e��d��d��Z�d�d�� Z�d�d�� Z��d]d�d��Z�G d�d�� d��Z�G d�d�� d�e�Z�d�d�� Z�G d�d�� d�e��Z�d�d�� Z�e�Z�e�Z�G d�d�� d�e��Z�e�� Z�Z�e�Z�ddsde&dddsdddf
d�d��Ze�j e_ d�d�� Z�G d�d�� d�eX�Z�ddde
jfd�d��Z�e�j�j e�_ ddde
jfd�d��Z�e�j�j e�_ ddde
jfd�d��Z�e�j�j e�_ G d�dÄ dÃZ�e�dăZ�e�dŃ Z�Z�e�dƃZ�e�d�ddȍZ�e�dɃZ�e�dʃZ�e�d˃Z�e�d̃Z�e�d̓Z�e�dZ�e�e
j�e�eE�Z�e�dσZ�e�e
j�eeD�Z�e�dЃZ�e�dуZ�e�dуZ�e�d҃Z�e�dӃZ�e�dԃZ�e�dՃZ�e�dփZ�e�d׃Z�e�dZ�e�dكZ�e�dڃZ�e�dۃZސd^d�dބZߐd_d�d�Z�e�d�Z�e�d�Z�e
jddddfd�d�Z�e�j�j e�_ �d`d�d�Z�d�d� Z�dad�d�Z�dbd�d�Z�d�d� Z�d�d� Z�dcd�d�Z�d�d�� Z�ddd�d��Z�ded�d��Z�d�d�� Z�d�d�� Z�e
j�j e�_ d��d � Z�e
j�j e�_ �df�d�d�Z�e
j�j e�_ eef�d�d�Z�dg�d�d�Z�dh�d�d�ZkekZ�di�d �d
�Z��dj�d �d �Z��d
�d� Z�e*e
j�j �d�e�_ e�Z��d�d� Z�e*e
j�j �d�e�_ e�Z��d�d� Z��dk�d�d�Z��dl�d�d�Z��dm�d�d�Z��dn�d �d �Z��do�d �d ��Z �dp�d �d!��Z�d"�d#� �Z�ed�d$f�d%�d&��Z�d'�d(� �ZG �d)�d*� �d*��Z�e�d+e�dds�d,��d-�d.�d/��Z�e�d0e�dds�d,��d1�d2�d/��Z�e�d3e�dds�d,��d4�d5�d/��Z �e�d6e�dds�d,��d7�d8�d/��Z
�e�d9�d7�d8�d:��Z �e�d;�d7�d<�d:��Z �e�d=�d>�d?�d:��Z
�e�d@e�dds�d,��d7�d8�d/��Z�e�dAe�dds�d,��dB�dC�d/��Z�e�dDe�dds�d,��d7�d8�d/��Z�e�dE�d7�d8�d:��Z�e�dFe�dds�d,��dG�dH�d/��Z�e�dIe�dds�d,��d7�d8�d/��Z�e�dJ�d7�d8�d:��Z�dq�dK�dL��ZdS (r a�
numpy.ma : a package to handle missing or invalid values.
This package was initially written for numarray by Paul F. Dubois
at Lawrence Livermore National Laboratory.
In 2006, the package was completely rewritten by Pierre Gerard-Marchant
(University of Georgia) to make the MaskedArray class a subclass of ndarray,
and to improve support of structured arrays.
Copyright 1999, 2000, 2001 Regents of the University of California.
Released for unlimited redistribution.
* Adapted for numpy_core 2005 by Travis Oliphant and (mainly) Paul Dubois.
* Subclassing of the base `ndarray` 2006 by Pierre Gerard-Marchant
(pgmdevlist_AT_gmail_DOT_com)
* Improvements suggested by Reggie Dugard (reggie_AT_merfinllc_DOT_com)
.. moduleauthor:: Pierre Gerard-Marchant
� N)�reduce)�ndarray�amax�amin� iscomplexobj�bool_�_NoValue)�array)�angle)�
getargspec�
formatargspec�long�unicode�bytes)� expand_dims)�normalize_axis_tuple)��MAError� MaskError�MaskType� MaskedArray�abs�absolute�add�all�allclose�allequal�alltruer r r
�anom� anomalies�any�append�arange�arccos�arccosh�arcsin�arcsinh�arctan�arctan2�arctanh�argmax�argmin�argsort�aroundr �
asanyarray�asarray� bitwise_and�
bitwise_or� bitwise_xorr �ceil�choose�clip�common_fill_value�compress�
compressed� concatenate� conjugate�convolve�copy� correlate�cos�cosh�count�cumprod�cumsum�default_fill_value�diag�diagonal�diff�divide�empty�
empty_like�equal�expr �fabs�filled� fix_invalid� flatten_mask�flatten_structured_array�floor� floor_divide�fmod�
frombuffer�fromflex� fromfunction�getdata�getmask� getmaskarray�greater�
greater_equal� harden_mask�hypot�identity�ids�indices�inner� innerproduct�isMA�
isMaskedArray�is_mask� is_masked�isarray�
left_shift�less�
less_equal�log�log10�log2� logical_and� logical_not�
logical_or� logical_xor� make_mask�make_mask_descr�make_mask_none�mask_or�masked� masked_array� masked_equal�masked_greater�masked_greater_equal�
masked_inside�masked_invalid� masked_less�masked_less_equal�masked_not_equal�
masked_object�masked_outside�masked_print_option�masked_singleton�
masked_values� masked_where�max�maximum�maximum_fill_value�mean�min�minimum�minimum_fill_value�mod�multiply�mvoid�ndim�negative�nomask�nonzero� not_equal�ones� ones_like�outer� outerproduct�power�prod�product�ptp�put�putmask�ravel� remainder�repeat�reshape�resize� right_shift�round�round_�set_fill_value�shape�sin�sinh�size� soften_mask�sometrue�sort�sqrt�squeeze�std�subtract�sum�swapaxes�take�tan�tanh�trace� transpose� true_divide�var�where�zeros�
zeros_likec @ s e Zd ZdS )�MaskedArrayFutureWarningN)�__name__�
__module__� __qualname__� r� r� �3/usr/lib64/python3.9/site-packages/numpy/ma/core.pyr� S s r� c C s& | j dkrdS tjdtdd� dS dS )a�
Adjust the axis passed to argsort, warning if necessary
Parameters
----------
arr
The array which argsort was called on
np.ma.argsort has a long-term bug where the default of the axis argument
is wrong (gh-8701), which now must be kept for backwards compatibility.
Thankfully, this only makes a difference when arrays are 2- or more-
dimensional, so we only need a warning then.
� ���z�In the future the default for argsort will be axis=-1, not the current None, to match its documentation and np.argsort. Explicitly pass -1 or None to silence this warning.� ��
stacklevelN)r� �warnings�warnr� )�arrr� r� r� �_deprecate_argsort_axisV s
�r� c C s\ | du r dS |du r| S t �dt�| ��}dt�|� }d�|dd� |g |dd� �S )z9
Adds a Notes section to an existing docstring.
Nz\n\s*?Notes\n\s*?-----z
Notes
-----
%s
� r� )�re�split�inspectZcleandoc�join)Z
initialdocZnoteZ notesplitZnotedocr� r� r� �doc_noter s r� c C s, zt t| �� }W n ty& d}Y n0 |S )z%
Get the signature from obj
r� )r r � TypeError)�obj�sigr� r� r� �get_object_signature� s
r� c @ s e Zd ZdZdS )r z1
Class for masked array related errors.
N�r� r� r� �__doc__r� r� r� r� r � s r c @ s e Zd ZdZdS )r z)
Class for mask related errors.
Nr� r� r� r� r� r � s r Ty@��x �D g@��x �Di?B �?s N/As ???zN/A) �b�c�f�i�O�S�u�V�U)
�Y�M�W�D�h�m�s�ms�us�nsZpsZfs�asZNaTzM8[�]zm8[c C s g | ]}|t j f�qS r� ��np�inf��.0�kr� r� r� �
<listcomp>� � r� � c C s" g | ]}|t tj tj �f�qS r� ��complexr� r� r� r� r� r� r� � r� ���c C s g | ]}|t j
f�qS r� r� r� r� r� r� r� � r� c C s" g | ]}|t tj
tj
�f�qS r� r� r� r� r� r� r� � r� c sh � j dur6t� �fdd�� j D ��}tj|� d�d S � jr\� j\}}t|��}t�||�S �� �S dS )zR
Recursively produce a fill value for `dtype`, calling f on scalar dtypes
Nc 3 s | ]}t � | ��V qd S �N)�_recursive_fill_value�r� �name��dtyper� r� r� � <genexpr>� r� z(_recursive_fill_value.<locals>.<genexpr>�r r� )�names�tupler� r �subdtyper� �full)r r� Zvals�subtyper� Zsubvalr� r� r� r� � s
r� c C s0 t | tj�r| S t| d�r | jS t�| �jS dS )z4 Convert the argument for *_fill_value into a dtype r N)�
isinstancer� r �hasattrr- �r� r� r� r� �
_get_dtype_of� s
r c C s dd� }t | �}t||�S )aN
Return the default fill value for the argument object.
The default filling value depends on the datatype of the input
array or the type of the input scalar:
======== ========
datatype default
======== ========
bool True
int 999999
float 1.e20
complex 1.e20+0j
object '?'
string 'N/A'
======== ========
For structured types, a structured scalar is returned, with each field the
default fill value for its type.
For subarray types, the fill value is an array of the same size containing
the default scalar fill value.
Parameters
----------
obj : ndarray, dtype or scalar
The array data-type or scalar for which the default fill value
is returned.
Returns
-------
fill_value : scalar
The default fill value.
Examples
--------
>>> np.ma.default_fill_value(1)
999999
>>> np.ma.default_fill_value(np.array([1.1, 2., np.pi]))
1e+20
>>> np.ma.default_fill_value(np.dtype(complex))
(1e+20+0j)
c S s2 | j dv r t�| jdd � d�S t�| j d�S d S )NZMmr� r� )�kind�default_filler�get�strr r� r� r� �_scalar_fill_value s
z.default_fill_value.<locals>._scalar_fill_value�r r� )r� r r r� r� r� rB � s -rB c s � �fdd�}t | �}t||�S )Nc
sL z
� | W S t yF } z$td| � d�� d��d �W Y d }~n
d }~0 0 d S )NzUnsuitable type z for calculating �.)�KeyErrorr� )r �e��extremum�
extremum_namer� r� r s
��z0_extremum_fill_value.<locals>._scalar_fill_valuer )r� r r r r r� r r� �_extremum_fill_value s r c C s t | td�S )a`
Return the maximum value that can be represented by the dtype of an object.
This function is useful for calculating a fill value suitable for
taking the minimum of an array with a given dtype.
Parameters
----------
obj : ndarray, dtype or scalar
An object that can be queried for it's numeric type.
Returns
-------
val : scalar
The maximum representable value.
Raises
------
TypeError
If `obj` isn't a suitable numeric type.
See Also
--------
maximum_fill_value : The inverse function.
set_fill_value : Set the filling value of a masked array.
MaskedArray.fill_value : Return current fill value.
Examples
--------
>>> import numpy.ma as ma
>>> a = np.int8()
>>> ma.minimum_fill_value(a)
127
>>> a = np.int32()
>>> ma.minimum_fill_value(a)
2147483647
An array of numeric data can also be passed.
>>> a = np.array([1, 2, 3], dtype=np.int8)
>>> ma.minimum_fill_value(a)
127
>>> a = np.array([1, 2, 3], dtype=np.float32)
>>> ma.minimum_fill_value(a)
inf
r� )r �
min_fillerr
r� r� r� r� $ s 0r� c C s t | td�S )ad
Return the minimum value that can be represented by the dtype of an object.
This function is useful for calculating a fill value suitable for
taking the maximum of an array with a given dtype.
Parameters
----------
obj : ndarray, dtype or scalar
An object that can be queried for it's numeric type.
Returns
-------
val : scalar
The minimum representable value.
Raises
------
TypeError
If `obj` isn't a suitable numeric type.
See Also
--------
minimum_fill_value : The inverse function.
set_fill_value : Set the filling value of a masked array.
MaskedArray.fill_value : Return current fill value.
Examples
--------
>>> import numpy.ma as ma
>>> a = np.int8()
>>> ma.maximum_fill_value(a)
-128
>>> a = np.int32()
>>> ma.maximum_fill_value(a)
-2147483648
An array of numeric data can also be passed.
>>> a = np.array([1, 2, 3], dtype=np.int8)
>>> ma.maximum_fill_value(a)
-128
>>> a = np.array([1, 2, 3], dtype=np.float32)
>>> ma.maximum_fill_value(a)
-inf
r� )r �
max_fillerr
r� r� r� r� W s 0r� c C s� t �| t|j��} g }t| |j�D ]X\}}|| }|jrB|jd }|jdurb|�tt||��� q"|�t j ||d��
� � q"t|�S )a�
Create a fill value for a structured dtype.
Parameters
----------
fillvalue : scalar or array_like
Scalar or array representing the fill value. If it is of shorter
length than the number of fields in dt, it will be resized.
dt : dtype
The structured dtype for which to create the fill value.
Returns
-------
val : tuple
A tuple of values corresponding to the structured fill value.
r Nr ) r� r� �lenr �zipr r r �_recursive_set_fill_valuer �item)� fillvalueZdtZ output_value�fvalr� Zcdtyper� r� r� r � s
r c
C s4 t �|�}| du r t|�} �n |jdur�t| tt jf�r�zt j| d|d�} W q� ty� } z"d}t|| |f �|�W Y d}~q�d}~0 0 n"t j | t
d�} t jt | |�|d�} n|t| t �r�|j
dvr�d}t|| ��nVzt j| d|d�} W n@ ttf�y( } z"d}t|| |f �|�W Y d}~n
d}~0 0 t �| �S ) a
Private function validating the given `fill_value` for the given dtype.
If fill_value is None, it is set to the default corresponding to the dtype.
If fill_value is not None, its value is forced to the given dtype.
The result is always a 0d array.
NF�r; r z"Unable to transform %s to dtype %sr ZOSVUz6Cannot set fill value of string with array of dtype %sz(Cannot convert fill_value %s to dtype %s)r� r rB r r r �voidr �
ValueErrorr. �objectr r �charr� �
OverflowError)�
fill_value�ndtyper �err_msgr� r� r� �_check_fill_value� s.
* �(r* c C s t | t�r| �|� dS )a�
Set the filling value of a, if a is a masked array.
This function changes the fill value of the masked array `a` in place.
If `a` is not a masked array, the function returns silently, without
doing anything.
Parameters
----------
a : array_like
Input array.
fill_value : dtype
Filling value. A consistency test is performed to make sure
the value is compatible with the dtype of `a`.
Returns
-------
None
Nothing returned by this function.
See Also
--------
maximum_fill_value : Return the default fill value for a dtype.
MaskedArray.fill_value : Return current fill value.
MaskedArray.set_fill_value : Equivalent method.
Examples
--------
>>> import numpy.ma as ma
>>> a = np.arange(5)
>>> a
array([0, 1, 2, 3, 4])
>>> a = ma.masked_where(a < 3, a)
>>> a
masked_array(data=[--, --, --, 3, 4],
mask=[ True, True, True, False, False],
fill_value=999999)
>>> ma.set_fill_value(a, -999)
>>> a
masked_array(data=[--, --, --, 3, 4],
mask=[ True, True, True, False, False],
fill_value=-999)
Nothing happens if `a` is not a masked array.
>>> a = list(range(5))
>>> a
[0, 1, 2, 3, 4]
>>> ma.set_fill_value(a, 100)
>>> a
[0, 1, 2, 3, 4]
>>> a = np.arange(5)
>>> a
array([0, 1, 2, 3, 4])
>>> ma.set_fill_value(a, 100)
>>> a
array([0, 1, 2, 3, 4])
N)r r r� ��ar' r� r� r� r� � s <
r� c C s t | t�r| j}nt| �}|S )zr
Return the filling value of a, if any. Otherwise, returns the
default filling value for that type.
)r r r' rB )r, �resultr� r� r� �get_fill_value s
r. c C s t | �}t |�}||kr |S dS )a
Return the common filling value of two masked arrays, if any.
If ``a.fill_value == b.fill_value``, return the fill value,
otherwise return None.
Parameters
----------
a, b : MaskedArray
The masked arrays for which to compare fill values.
Returns
-------
fill_value : scalar or None
The common fill value, or None.
Examples
--------
>>> x = np.ma.array([0, 1.], fill_value=3)
>>> y = np.ma.array([0, 1.], fill_value=3)
>>> np.ma.common_fill_value(x, y)
3.0
N)r. )r, r� �t1�t2r� r� r� r5 $ s
r5 c C sF t | d�r| �|�S t| t�r"| S t| t�r8t�| d�S t�| �S dS )a�
Return input as an array with masked data replaced by a fill value.
If `a` is not a `MaskedArray`, `a` itself is returned.
If `a` is a `MaskedArray` and `fill_value` is None, `fill_value` is set to
``a.fill_value``.
Parameters
----------
a : MaskedArray or array_like
An input object.
fill_value : array_like, optional.
Can be scalar or non-scalar. If non-scalar, the
resulting filled array should be broadcastable
over input array. Default is None.
Returns
-------
a : ndarray
The filled array.
See Also
--------
compressed
Examples
--------
>>> x = np.ma.array(np.arange(9).reshape(3, 3), mask=[[1, 0, 0],
... [1, 0, 0],
... [0, 0, 0]])
>>> x.filled()
array([[999999, 1, 2],
[999999, 4, 5],
[ 6, 7, 8]])
>>> x.filled(fill_value=333)
array([[333, 1, 2],
[333, 4, 5],
[ 6, 7, 8]])
>>> x.filled(fill_value=np.arange(3))
array([[0, 1, 2],
[0, 4, 5],
[6, 7, 8]])
rL r� N)r rL r r �dictr� r r+ r� r� r� rL D s -
rL c G s� t | �dkr.| d }t|t�r(t|�}qrt}nDdd� | D �}|d }t|t�sRt}|dd� D ]}t||�r^|}q^|jdkr�tS |S )z�
Return the youngest subclass of MaskedArray from a list of (masked) arrays.
In case of siblings, the first listed takes over.
r� r c S s g | ] }t |��qS r� )�type�r� r, r� r� r� r� � r� z'get_masked_subclass.<locals>.<listcomp>N�MaskedConstant)r r r r2 �
issubclassr� )�arraysr� �rclsZarrcls�clsr� r� r� �get_masked_subclass} s
r9 c C s@ z
| j }W n" ty, tj| d|d�}Y n0 |s<|�t�S |S )aE
Return the data of a masked array as an ndarray.
Return the data of `a` (if any) as an ndarray if `a` is a ``MaskedArray``,
else return `a` as a ndarray or subclass (depending on `subok`) if not.
Parameters
----------
a : array_like
Input ``MaskedArray``, alternatively a ndarray or a subclass thereof.
subok : bool
Whether to force the output to be a `pure` ndarray (False) or to
return a subclass of ndarray if appropriate (True, default).
See Also
--------
getmask : Return the mask of a masked array, or nomask.
getmaskarray : Return the mask of a masked array, or full array of False.
Examples
--------
>>> import numpy.ma as ma
>>> a = ma.masked_equal([[1,2],[3,4]], 2)
>>> a
masked_array(
data=[[1, --],
[3, 4]],
mask=[[False, True],
[False, False]],
fill_value=2)
>>> ma.getdata(a)
array([[1, 2],
[3, 4]])
Equivalently use the ``MaskedArray`` `data` attribute.
>>> a.data
array([[1, 2],
[3, 4]])
F�r; �subok)�_data�AttributeErrorr� r �viewr )r, r; �datar� r� r� rV � s *
rV c C sX t | ||dd�} t�t�| j��}|�� s.| S | j|O _|du rJ| j}|| j|< | S )aQ
Return input with invalid data masked and replaced by a fill value.
Invalid data means values of `nan`, `inf`, etc.
Parameters
----------
a : array_like
Input array, a (subclass of) ndarray.
mask : sequence, optional
Mask. Must be convertible to an array of booleans with the same
shape as `data`. True indicates a masked (i.e. invalid) data.
copy : bool, optional
Whether to use a copy of `a` (True) or to fix `a` in place (False).
Default is True.
fill_value : scalar, optional
Value used for fixing invalid data. Default is None, in which case
the ``a.fill_value`` is used.
Returns
-------
b : MaskedArray
The input array with invalid entries fixed.
Notes
-----
A copy is performed by default.
Examples
--------
>>> x = np.ma.array([1., -1, np.nan, np.inf], mask=[1] + [0]*3)
>>> x
masked_array(data=[--, -1.0, nan, inf],
mask=[ True, False, False, False],
fill_value=1e+20)
>>> np.ma.fix_invalid(x)
masked_array(data=[--, -1.0, --, --],
mask=[ True, False, True, True],
fill_value=1e+20)
>>> fixed = np.ma.fix_invalid(x)
>>> fixed.data
array([ 1.e+00, -1.e+00, 1.e+20, 1.e+20])
>>> x.data
array([ 1., -1., nan, inf])
T)r; �maskr; N)rv r� rn �isfiniter< r �_maskr' )r, r@ r; r' �invalidr� r� r� rM � s 0
rM c C s, t | t�p*t | t�o*| o*t�dd� | D ��S )Nc s s | ]}t |t�V qd S r� )r r )r� r� r� r� r� r r� z/is_string_or_list_of_strings.<locals>.<genexpr>)r r �list�builtinsr )�valr� r� r� � is_string_or_list_of_strings s
�rG c @ s e Zd ZdZdd� Zdd� ZdS )�_DomainCheckIntervalz~
Define a valid interval, so that :
``domain_check_interval(a,b)(x) == True`` where
``x < a`` or ``x > b``.
c C s" ||kr|| }}|| _ || _dS )z9domain_check_interval(a,b)(x) = true where x < a or y > bN)r, r� ��selfr, r� r� r� r� �__init__ s
z _DomainCheckInterval.__init__c C sP t jdd��0 t�t�|| j�t�|| j��W d � S 1 sB0 Y dS )�Execute the call behavior.�ignore�rC N)r� �errstate�umathro rY r� rh r, �rJ �xr� r� r� �__call__& s �z _DomainCheckInterval.__call__N�r� r� r� r� rK rS r� r� r� r� rH s rH c @ s e Zd ZdZdd� Zdd� ZdS )�
_DomainTanz
Define a valid interval for the `tan` function, so that:
``domain_tan(eps) = True`` where ``abs(cos(x)) < eps``
c C s
|| _ dS )z/domain_tan(eps) = true where abs(cos(x)) < eps)N)�eps)rJ rV r� r� r� rK 7 s z_DomainTan.__init__c C sJ t jdd��* t�t�t�|��| j�W d � S 1 s<0 Y dS ��Executes the call behavior.rM rN N)r� rO rP rh r r= rV rQ r� r� r� rS ; s z_DomainTan.__call__NrT r� r� r� r� rU / s rU c @ s" e Zd ZdZddd�Zdd� ZdS )�_DomainSafeDividez-
Define a domain for safe division.
Nc C s
|| _ d S r� )� tolerance)rJ rZ r� r� r� rK G s z_DomainSafeDivide.__init__c C sx | j d u rt�t�j| _ t�|�t�|� }}tjdd��* t�|�| j t�|�kW d � S 1 sj0 Y d S )NrM rN ) rZ r� Zfinfo�floatZtinyr. rO rP r rI r� r� r� rS J s
z_DomainSafeDivide.__call__)NrT r� r� r� r� rY A s
rY c @ s e Zd ZdZdd� Zdd� ZdS )�_DomainGreaterz4
DomainGreater(v)(x) is True where x <= v.
c C s
|| _ dS )z'DomainGreater(v)(x) = true where x <= vN��critical_value�rJ r^ r� r� r� rK \ s z_DomainGreater.__init__c C s> t jdd�� t�|| j�W d � S 1 s00 Y dS rW )r� rO rP ri r^ rQ r� r� r� rS ` s z_DomainGreater.__call__NrT r� r� r� r� r\ V s r\ c @ s e Zd ZdZdd� Zdd� ZdS )�_DomainGreaterEqualz8
DomainGreaterEqual(v)(x) is True where x < v.
c C s
|| _ dS )z+DomainGreaterEqual(v)(x) = true where x < vNr] r_ r� r� r� rK l s z _DomainGreaterEqual.__init__c C s> t jdd�� t�|| j�W d � S 1 s00 Y dS rW )r� rO rP rh r^ rQ r� r� r� rS p s z _DomainGreaterEqual.__call__NrT r� r� r� r� r` f s r` c @ s e Zd Zdd� Zdd� ZdS )� _MaskedUFuncc C s || _ |j| _|j| _d S r� )r� r� r� )rJ �ufuncr� r� r� rK w s z_MaskedUFunc.__init__c C s d| j � �S )NzMasked version of )r� �rJ r� r� r� �__str__| s z_MaskedUFunc.__str__N)r� r� r� rK rd r� r� r� r� ra v s ra c s* e Zd ZdZd� fdd� Zdd� Z� ZS ) �_MaskedUnaryOperationa�
Defines masked version of unary operations, where invalid values are
pre-masked.
Parameters
----------
mufunc : callable
The function for which to define a masked version. Made available
as ``_MaskedUnaryOperation.f``.
fill : scalar, optional
Filling value, default is 0.
domain : class instance
Domain for the function. Should be one of the ``_Domain*``
classes. Default is None.
r Nc s, t � �|� || _|| _|t|< |t|< d S r� )�superrK �fill�domain� ufunc_domain� ufunc_fills)rJ Zmufuncrg rh �� __class__r� r� rK � s
z _MaskedUnaryOperation.__init__c O s6 t |�}| jdur�tjddd��( | j|g|�R i |��}W d � n1 sN0 Y t�|� }|| �|�O }|t|�O }nNtjddd��( | j|g|�R i |��}W d � n1 s�0 Y t|�}|js�|r�t S |S |t
u�rztj |||d� W n t �y Y n0 |�
t|��}||_|�|� |S )�-
Execute the call behavior.
NrM �rF rC �r� )rV rh r� rO r� rP rA rW r� ru r� �copytor� r> r9 rB � _update_from)rJ r, �args�kwargs�dr- r� �
masked_resultr� r� r� rS � s.
6 6
z _MaskedUnaryOperation.__call__)r N�r� r� r� r� rK rS �
__classcell__r� r� rk r� re � s re c sF e Zd ZdZd� fdd� Zdd� Zddd �Zd
d � Zdd d
�Z� Z S )�_MaskedBinaryOperationaC
Define masked version of binary operations, where invalid
values are pre-masked.
Parameters
----------
mbfunc : function
The function for which to define a masked version. Made available
as ``_MaskedBinaryOperation.f``.
domain : class instance
Default domain for the function. Should be one of the ``_Domain*``
classes. Default is None.
fillx : scalar, optional
Filling value for the first argument, default is 0.
filly : scalar, optional
Filling value for the second argument, default is 0.
r c s0 t � �|� || _|| _dt|< ||ft|< dS )zr
abfunc(fillx, filly) must be defined.
abfunc(x, filly) = x for all x to enable reduce.
N)rf rK �fillx�fillyri rj )rJ Zmbfuncry rz rk r� r� rK � s
z _MaskedBinaryOperation.__init__c O s\ t |�t |� }}t�� �8 tjddd� | j||g|�R i |��}W d � n1 sX0 Y t|�t|� }} |tu r�| tu r�t}
q�t�t |�| �}
n&| tu r�t�|t |��}
n t�|| �}
|j
s�|
r�t S |S |
tu�r|
� � �rztj
||d|
d� W n t�y Y n0 |�t||��} |
| _t|t��rB| �|� nt|t��rX| �|� | S )rm rM rn N�unsafe��castingr� )rV r� rO Zseterrr� rW r� rP ro rX r� ru r rp � Exceptionr> r9 rB r r rq ) rJ r, r� rr rs �da�dbr- �ma�mbr� ru r� r� r� rS � s8
8
z _MaskedBinaryOperation.__call__Nc
C s� t |�}t|�}t|| j�}|jdkrJ|�d�}|turJt|dd�}d|_|tu rf| j� ||�}t}n | jj |||d�}t
j � ||�}|js�|r�t S |S |�
|�} || _| S )z:
Reduce `target` along the given `axis`.
r� r� T�r; �r� r )r9 rW rL rz r� r� r� rq r� r rP rm ru r> rB )
rJ �target�axisr �tclassr� �t�tr�mrZ masked_trr� r� r� r s(
z _MaskedBinaryOperation.reducec
C s� t |�t |� }}| j�||�}t|�}t|�}|tu rF|tu rFt}n t|�}t|�}tj�||�}|jsr|rrt S |tur�t
j |||d� |j s�|S |�
t||��} || _| S )zO
Return the function applied to the outer product of a and b.
ro )rV r� r� rW r� rX rP ro r� ru r� rp r� r> r9 rB )
rJ r, r� r r� rt r� r� r� Zmasked_dr� r� r� r� 8 s$
z _MaskedBinaryOperation.outerc C s0 t |�}t|| j�}| j�||�}|�|�}|S )zSAccumulate `target` along `axis` after filling with y fill
value.
)r9 rL rz r� �
accumulater> )rJ r� r� r� r� r- ru r� r� r� r� Q s
z!_MaskedBinaryOperation.accumulate)r r )r N)r )
r� r� r� r� rK rS r r� r� rw r� r� rk r� rx � s
/
rx c s* e Zd ZdZd� fdd� Zdd� Z� ZS )�_DomainedBinaryOperationaH
Define binary operations that have a domain, like divide.
They have no reduce, outer or accumulate.
Parameters
----------
mbfunc : function
The function for which to define a masked version. Made available
as ``_DomainedBinaryOperation.f``.
domain : class instance
Default domain for the function. Should be one of the ``_Domain*``
classes.
fillx : scalar, optional
Filling value for the first argument, default is 0.
filly : scalar, optional
Filling value for the second argument, default is 0.
r c s6 t � �|� || _|| _|| _|t|< ||ft|< dS )zjabfunc(fillx, filly) must be defined.
abfunc(x, filly) = x for all x to enable reduce.
N)rf rK rh ry rz ri rj )rJ Zdbfuncrh ry rz rk r� r� rK s s z!_DomainedBinaryOperation.__init__c O sP t |�t |� }}tjddd��* | j||g|�R i |��}W d � n1 sP0 Y t�|� }|t|�O }|t|�O }t�| jd�} | dur�|| ||�O }|j s�|r�t
S |S z>tj |dd|d� t� ||�}
tj
|
j|jdd�r�||
7 }W n t�y Y n0 |�t||��} || _t|t��r6| �|� nt|t��rL| �|� | S ) rL rM rn Nr r{ r| �safe)r} )rV r� rO r� rP rA rW ri r r� ru rp r� Zcan_castr r~ r> r9 rB r r rq ) rJ r, r� rr rs r r� r- r� rh Z masked_daru r� r� r� rS ~ s6 8
z!_DomainedBinaryOperation.__call__)r r rv r� r� rk r� r� ^ s r� � � �?gz�����8g �g�������g�������?r� c C s� t }| jdurdg }| jD ]>}| j| }t|�dkr>|d |f}|�|||d |�f� qt�|�}n8| jr�t| j�}|| jd |�|d< t�t |��}n|}|| kr�| }|S )z=Private function allowing recursion in _replace_dtype_fields.Nr� r� r )
� _replace_dtype_fields_recursiver �fieldsr r r� r r rD r )r �primitive_dtypeZ_recurseZdescrr� ZfieldZ new_dtyper� r� r� r� � s"
r� c C s t �| �} t �|�}t| |�S )z�
Construct a dtype description list from a given dtype.
Returns a new dtype object, with all fields and subtypes in the given type
recursively replaced with `primitive_dtype`.
Arguments are coerced to dtypes first.
)r� r r� )r r� r� r� r� �_replace_dtype_fields s
r� c C s
t | t�S )a�
Construct a dtype description list from a given dtype.
Returns a new dtype object, with the type of all fields in `ndtype` to a
boolean type. Field names are not altered.
Parameters
----------
ndtype : dtype
The dtype to convert.
Returns
-------
result : dtype
A dtype that looks like `ndtype`, the type of all fields is boolean.
Examples
--------
>>> import numpy.ma as ma
>>> dtype = np.dtype({'names':['foo', 'bar'],
... 'formats':[np.float32, np.int64]})
>>> dtype
dtype([('foo', '<f4'), ('bar', '<i8')])
>>> ma.make_mask_descr(dtype)
dtype([('foo', '|b1'), ('bar', '|b1')])
>>> ma.make_mask_descr(np.float32)
dtype('bool')
)r� r )r( r� r� r� rr * s rr c C s t | dt�S )a
Return the mask of a masked array, or nomask.
Return the mask of `a` as an ndarray if `a` is a `MaskedArray` and the
mask is not `nomask`, else return `nomask`. To guarantee a full array
of booleans of the same shape as a, use `getmaskarray`.
Parameters
----------
a : array_like
Input `MaskedArray` for which the mask is required.
See Also
--------
getdata : Return the data of a masked array as an ndarray.
getmaskarray : Return the mask of a masked array, or full array of False.
Examples
--------
>>> import numpy.ma as ma
>>> a = ma.masked_equal([[1,2],[3,4]], 2)
>>> a
masked_array(
data=[[1, --],
[3, 4]],
mask=[[False, True],
[False, False]],
fill_value=2)
>>> ma.getmask(a)
array([[False, True],
[False, False]])
Equivalently use the `MaskedArray` `mask` attribute.
>>> a.mask
array([[False, True],
[False, False]])
Result when mask == `nomask`
>>> b = ma.masked_array([[1,2],[3,4]])
>>> b
masked_array(
data=[[1, 2],
[3, 4]],
mask=False,
fill_value=999999)
>>> ma.nomask
False
>>> ma.getmask(b) == ma.nomask
True
>>> b.mask == ma.nomask
True
rB )�getattrr� )r, r� r� r� rW K s 8rW c C s, t | �}|tu r(tt�| �t| dd��}|S )ae
Return the mask of a masked array, or full boolean array of False.
Return the mask of `arr` as an ndarray if `arr` is a `MaskedArray` and
the mask is not `nomask`, else return a full boolean array of False of
the same shape as `arr`.
Parameters
----------
arr : array_like
Input `MaskedArray` for which the mask is required.
See Also
--------
getmask : Return the mask of a masked array, or nomask.
getdata : Return the data of a masked array as an ndarray.
Examples
--------
>>> import numpy.ma as ma
>>> a = ma.masked_equal([[1,2],[3,4]], 2)
>>> a
masked_array(
data=[[1, --],
[3, 4]],
mask=[[False, True],
[False, False]],
fill_value=2)
>>> ma.getmaskarray(a)
array([[False, True],
[False, False]])
Result when mask == ``nomask``
>>> b = ma.masked_array([[1,2],[3,4]])
>>> b
masked_array(
data=[[1, 2],
[3, 4]],
mask=False,
fill_value=999999)
>>> ma.getmaskarray(b)
array([[False, False],
[False, False]])
r N)rW r� rs r� r� r� )r� r@ r� r� r� rX � s /rX c C s( z| j jtu W S ty" Y dS 0 dS )a)
Return True if m is a valid, standard mask.
This function does not check the contents of the input, only that the
type is MaskType. In particular, this function returns False if the
mask has a flexible dtype.
Parameters
----------
m : array_like
Array to test.
Returns
-------
result : bool
True if `m.dtype.type` is MaskType, False otherwise.
See Also
--------
ma.isMaskedArray : Test whether input is an instance of MaskedArray.
Examples
--------
>>> import numpy.ma as ma
>>> m = ma.masked_equal([0, 1, 0, 2, 3], 0)
>>> m
masked_array(data=[--, 1, --, 2, 3],
mask=[ True, False, True, False, False],
fill_value=0)
>>> ma.is_mask(m)
False
>>> ma.is_mask(m.mask)
True
Input must be an ndarray (or have similar attributes)
for it to be considered a valid mask.
>>> m = [False, True, False]
>>> ma.is_mask(m)
False
>>> m = np.array([False, True, False])
>>> m
array([False, True, False])
>>> ma.is_mask(m)
True
Arrays with complex dtypes don't return True.
>>> dtype = np.dtype({'names':['monty', 'pithon'],
... 'formats':[bool, bool]})
>>> dtype
dtype([('monty', '|b1'), ('pithon', '|b1')])
>>> m = np.array([(True, False), (False, True), (True, False)],
... dtype=dtype)
>>> m
array([( True, False), (False, True), ( True, False)],
dtype=[('monty', '?'), ('pithon', '?')])
>>> ma.is_mask(m)
False
FN)r r2 r r= �r� r� r� r� rd � s > rd c C s | j jdu r| �� stS | S dS )z-
Shrink a mask to nomask if possible
N)r r r r� r� r� r� r� � _shrink_mask s r� Fc C sh | t u r t S t|�}t| t�r@| jjr@|tjkr@tj| j |d�S tj
t | d�||dd�}|rdt |�}|S )a�
Create a boolean mask from an array.
Return `m` as a boolean mask, creating a copy if necessary or requested.
The function can accept any sequence that is convertible to integers,
or ``nomask``. Does not require that contents must be 0s and 1s, values
of 0 are interpreted as False, everything else as True.
Parameters
----------
m : array_like
Potential mask.
copy : bool, optional
Whether to return a copy of `m` (True) or `m` itself (False).
shrink : bool, optional
Whether to shrink `m` to ``nomask`` if all its values are False.
dtype : dtype, optional
Data-type of the output mask. By default, the output mask has a
dtype of MaskType (bool). If the dtype is flexible, each field has
a boolean dtype. This is ignored when `m` is ``nomask``, in which
case ``nomask`` is always returned.
Returns
-------
result : ndarray
A boolean mask derived from `m`.
Examples
--------
>>> import numpy.ma as ma
>>> m = [True, False, True, True]
>>> ma.make_mask(m)
array([ True, False, True, True])
>>> m = [1, 0, 1, 1]
>>> ma.make_mask(m)
array([ True, False, True, True])
>>> m = [1, 0, 2, -3]
>>> ma.make_mask(m)
array([ True, False, True, True])
Effect of the `shrink` parameter.
>>> m = np.zeros(4)
>>> m
array([0., 0., 0., 0.])
>>> ma.make_mask(m)
False
>>> ma.make_mask(m, shrink=False)
array([False, False, False, False])
Using a flexible `dtype`.
>>> m = [1, 0, 1, 1]
>>> n = [0, 1, 0, 0]
>>> arr = []
>>> for man, mouse in zip(m, n):
... arr.append((man, mouse))
>>> arr
[(1, 0), (0, 1), (1, 0), (1, 0)]
>>> dtype = np.dtype({'names':['man', 'mouse'],
... 'formats':[np.int64, np.int64]})
>>> arr = np.array(arr, dtype=dtype)
>>> arr
array([(1, 0), (0, 1), (1, 0), (1, 0)],
dtype=[('man', '<i8'), ('mouse', '<i8')])
>>> ma.make_mask(arr, dtype=dtype)
array([(True, False), (False, True), (True, False), (True, False)],
dtype=[('man', '|b1'), ('mouse', '|b1')])
r T)r; r r; )
r� rr r r r r� r� r r� r� r rL r� )r� r; �shrinkr r- r� r� r� rq s G rq c C s. |du rt j| td�}nt j| t|�d�}|S )a&
Return a boolean mask of the given shape, filled with False.
This function returns a boolean ndarray with all entries False, that can
be used in common mask manipulations. If a complex dtype is specified, the
type of each field is converted to a boolean type.
Parameters
----------
newshape : tuple
A tuple indicating the shape of the mask.
dtype : {None, dtype}, optional
If None, use a MaskType instance. Otherwise, use a new datatype with
the same fields as `dtype`, converted to boolean types.
Returns
-------
result : ndarray
An ndarray of appropriate shape and dtype, filled with False.
See Also
--------
make_mask : Create a boolean mask from an array.
make_mask_descr : Construct a dtype description list from a given dtype.
Examples
--------
>>> import numpy.ma as ma
>>> ma.make_mask_none((3,))
array([False, False, False])
Defining a more complex dtype.
>>> dtype = np.dtype({'names':['foo', 'bar'],
... 'formats':[np.float32, np.int64]})
>>> dtype
dtype([('foo', '<f4'), ('bar', '<i8')])
>>> ma.make_mask_none((3,), dtype=dtype)
array([(False, False), (False, False), (False, False)],
dtype=[('foo', '|b1'), ('bar', '|b1')])
Nr )r� r� r rr )�newshaper r- r� r� r� rs e s +rs c C sV | j j}|D ]D}| | }|j jd ur:t||| || � q t�||| || � q d S r� )r r �_recursive_mask_orrP ro )�m1�m2�newmaskr r� Zcurrent1r� r� r� r� � s r� c C s� | t u s| du r,t|dt�}t||||d�S |t u s<|du rXt| dt�}t| |||d�S | |u rlt| �rl| S t| dd�t|dd� }}||kr�td||f ��|jdur�t�t� | |�j
|�}t | ||� |S tt �
| |�||d�S )a�
Combine two masks with the ``logical_or`` operator.
The result may be a view on `m1` or `m2` if the other is `nomask`
(i.e. False).
Parameters
----------
m1, m2 : array_like
Input masks.
copy : bool, optional
If copy is False and one of the inputs is `nomask`, return a view
of the other input mask. Defaults to False.
shrink : bool, optional
Whether to shrink the output to `nomask` if all its values are
False. Defaults to True.
Returns
-------
mask : output mask
The result masks values that are masked in either `m1` or `m2`.
Raises
------
ValueError
If `m1` and `m2` have different flexible dtypes.
Examples
--------
>>> m1 = np.ma.make_mask([0, 1, 1, 0])
>>> m2 = np.ma.make_mask([1, 0, 0, 0])
>>> np.ma.mask_or(m1, m2)
array([ True, True, True, False])
Fr )r; r� r Nz Incompatible dtypes '%s'<>'%s'�r; r� )r� r� r rq rd r# r r� rG � broadcastr� r� rP ro )r� r� r; r� r Zdtype1Zdtype2r� r� r� r� rt � s %
rt c sB dd� }� fdd�� t �| �} � || ��}t jdd� |D �td�S )a&
Returns a completely flattened version of the mask, where nested fields
are collapsed.
Parameters
----------
mask : array_like
Input array, which will be interpreted as booleans.
Returns
-------
flattened_mask : ndarray of bools
The flattened input.
Examples
--------
>>> mask = np.array([0, 0, 1])
>>> np.ma.flatten_mask(mask)
array([False, False, True])
>>> mask = np.array([(0, 0), (0, 1)], dtype=[('a', bool), ('b', bool)])
>>> np.ma.flatten_mask(mask)
array([False, False, False, True])
>>> mdtype = [('a', bool), ('b', [('ba', bool), ('bb', bool)])]
>>> mask = np.array([(0, (0, 0)), (0, (0, 1))], dtype=mdtype)
>>> np.ma.flatten_mask(mask)
array([False, False, False, False, False, True])
c s* � j j}|dur"� fdd�|D �S � S dS )zCFlatten the mask and returns a (maybe nested) sequence of booleans.Nc s g | ]}t � | ��qS r� )rN r� �r@ r� r� r� � r� z3flatten_mask.<locals>._flatmask.<locals>.<listcomp>�r r )r@ Zmnamesr� r� r� � _flatmask� s z flatten_mask.<locals>._flatmaskc 3 sL z.| D ]$}t |d�r$� |�E dH q|V qW n tyF | V Y n0 dS )z.Generates a flattened version of the sequence.�__iter__N)r r� )Zsequence�element��
_flatsequencer� r� r� s
z#flatten_mask.<locals>._flatsequencec S s g | ]}|�qS r� r� �r� �_r� r� r� r� r� z flatten_mask.<locals>.<listcomp>r )r� r. r �bool)r@ r� Z flattenedr� r� r� rN � s
rN c C s6 |t ju ri nd|i}| tur2| jf d|i|��S tS )z:Check whether there are masked values along the given axis�keepdimsr� )r� r r� r )r@ r� r� rs r� r� r� �_check_mask_axis s r� c C s� t | dd�}tj||dd�}|j|j }}|rF||krFtd||f ��t|d�rft||j�}t|�}nt }|�
|�}t |�|_ |s�t|d�r�t
|�tu r�|j�
� |_|S )a�
Mask an array where a condition is met.
Return `a` as an array masked where `condition` is True.
Any masked values of `a` or `condition` are also masked in the output.
Parameters
----------
condition : array_like
Masking condition. When `condition` tests floating point values for
equality, consider using ``masked_values`` instead.
a : array_like
Array to mask.
copy : bool
If True (default) make a copy of `a` in the result. If False modify
`a` in place and return a view.
Returns
-------
result : MaskedArray
The result of masking `a` where `condition` is True.
See Also
--------
masked_values : Mask using floating point equality.
masked_equal : Mask where equal to a given value.
masked_not_equal : Mask where `not` equal to a given value.
masked_less_equal : Mask where less than or equal to a given value.
masked_greater_equal : Mask where greater than or equal to a given value.
masked_less : Mask where less than a given value.
masked_greater : Mask where greater than a given value.
masked_inside : Mask inside a given interval.
masked_outside : Mask outside a given interval.
masked_invalid : Mask invalid values (NaNs or infs).
Examples
--------
>>> import numpy.ma as ma
>>> a = np.arange(4)
>>> a
array([0, 1, 2, 3])
>>> ma.masked_where(a <= 2, a)
masked_array(data=[--, --, --, 3],
mask=[ True, True, True, False],
fill_value=999999)
Mask array `b` conditional on `a`.
>>> b = ['a', 'b', 'c', 'd']
>>> ma.masked_where(a == 2, b)
masked_array(data=['a', 'b', --, 'd'],
mask=[False, False, True, False],
fill_value='N/A',
dtype='<U1')
Effect of the `copy` argument.
>>> c = ma.masked_where(a <= 2, a)
>>> c
masked_array(data=[--, --, --, 3],
mask=[ True, True, True, False],
fill_value=999999)
>>> c[0] = 99
>>> c
masked_array(data=[99, --, --, 3],
mask=[False, True, True, False],
fill_value=999999)
>>> a
array([0, 1, 2, 3])
>>> c = ma.masked_where(a <= 2, a, copy=False)
>>> c[0] = 99
>>> c
masked_array(data=[99, --, --, 3],
mask=[False, True, True, False],
fill_value=999999)
>>> a
array([99, 1, 2, 3])
When `condition` or `a` contain masked values.
>>> a = np.arange(4)
>>> a = ma.masked_where(a == 2, a)
>>> a
masked_array(data=[0, 1, --, 3],
mask=[False, False, True, False],
fill_value=999999)
>>> b = np.arange(4)
>>> b = ma.masked_where(b == 0, b)
>>> b
masked_array(data=[--, 1, 2, 3],
mask=[ True, False, False, False],
fill_value=999999)
>>> ma.masked_where(a == 3, b)
masked_array(data=[--, 1, --, --],
mask=[ True, False, True, True],
fill_value=999999)
F�r� Tr: zFInconsistent shape between the condition and the input (got %s and %s)rB )rq r� r r� �
IndexErrorr rt rB r2 r r> r� r@ rW r� )� conditionr, r; ZcondZcshapeZashaper8 r- r� r� r� r� s d �
r� c C s t t| |�| |d�S )a�
Mask an array where greater than a given value.
This function is a shortcut to ``masked_where``, with
`condition` = (x > value).
See Also
--------
masked_where : Mask where a condition is met.
Examples
--------
>>> import numpy.ma as ma
>>> a = np.arange(4)
>>> a
array([0, 1, 2, 3])
>>> ma.masked_greater(a, 2)
masked_array(data=[0, 1, 2, --],
mask=[False, False, False, True],
fill_value=999999)
r� )r� rY �rR �valuer; r� r� r� rx � s rx c C s t t| |�| |d�S )a
Mask an array where greater than or equal to a given value.
This function is a shortcut to ``masked_where``, with
`condition` = (x >= value).
See Also
--------
masked_where : Mask where a condition is met.
Examples
--------
>>> import numpy.ma as ma
>>> a = np.arange(4)
>>> a
array([0, 1, 2, 3])
>>> ma.masked_greater_equal(a, 2)
masked_array(data=[0, 1, --, --],
mask=[False, False, True, True],
fill_value=999999)
r� )r� rZ r� r� r� r� ry � s ry c C s t t| |�| |d�S )a�
Mask an array where less than a given value.
This function is a shortcut to ``masked_where``, with
`condition` = (x < value).
See Also
--------
masked_where : Mask where a condition is met.
Examples
--------
>>> import numpy.ma as ma
>>> a = np.arange(4)
>>> a
array([0, 1, 2, 3])
>>> ma.masked_less(a, 2)
masked_array(data=[--, --, 2, 3],
mask=[ True, True, False, False],
fill_value=999999)
r� )r� rh r� r� r� r� r| � s r| c C s t t| |�| |d�S )a�
Mask an array where less than or equal to a given value.
This function is a shortcut to ``masked_where``, with
`condition` = (x <= value).
See Also
--------
masked_where : Mask where a condition is met.
Examples
--------
>>> import numpy.ma as ma
>>> a = np.arange(4)
>>> a
array([0, 1, 2, 3])
>>> ma.masked_less_equal(a, 2)
masked_array(data=[--, --, --, 3],
mask=[ True, True, True, False],
fill_value=999999)
r� )r� ri r� r� r� r� r} � s r} c C s t t| |�| |d�S )a�
Mask an array where `not` equal to a given value.
This function is a shortcut to ``masked_where``, with
`condition` = (x != value).
See Also
--------
masked_where : Mask where a condition is met.
Examples
--------
>>> import numpy.ma as ma
>>> a = np.arange(4)
>>> a
array([0, 1, 2, 3])
>>> ma.masked_not_equal(a, 2)
masked_array(data=[--, --, 2, --],
mask=[ True, True, False, True],
fill_value=999999)
r� )r� r� r� r� r� r� r~ � s r~ c C s t t| |�| |d�}||_|S )af
Mask an array where equal to a given value.
This function is a shortcut to ``masked_where``, with
`condition` = (x == value). For floating point arrays,
consider using ``masked_values(x, value)``.
See Also
--------
masked_where : Mask where a condition is met.
masked_values : Mask using floating point equality.
Examples
--------
>>> import numpy.ma as ma
>>> a = np.arange(4)
>>> a
array([0, 1, 2, 3])
>>> ma.masked_equal(a, 2)
masked_array(data=[0, 1, --, 3],
mask=[False, False, True, False],
fill_value=2)
r� )r� rI r' )rR r� r; �outputr� r� r� rw s rw c C s8 ||k r|| }}t | �}||k||k@ }t|| |d�S )a�
Mask an array inside a given interval.
Shortcut to ``masked_where``, where `condition` is True for `x` inside
the interval [v1,v2] (v1 <= x <= v2). The boundaries `v1` and `v2`
can be given in either order.
See Also
--------
masked_where : Mask where a condition is met.
Notes
-----
The array `x` is prefilled with its filling value.
Examples
--------
>>> import numpy.ma as ma
>>> x = [0.31, 1.2, 0.01, 0.2, -0.4, -1.1]
>>> ma.masked_inside(x, -0.3, 0.3)
masked_array(data=[0.31, 1.2, --, --, -0.4, -1.1],
mask=[False, False, True, True, False, False],
fill_value=1e+20)
The order of `v1` and `v2` doesn't matter.
>>> ma.masked_inside(x, 0.3, -0.3)
masked_array(data=[0.31, 1.2, --, --, -0.4, -1.1],
mask=[False, False, True, True, False, False],
fill_value=1e+20)
r� �rL r� �rR Zv1Zv2r; Zxfr� r� r� r� rz 7 s
!
rz c C s8 ||k r|| }}t | �}||k ||kB }t|| |d�S )a�
Mask an array outside a given interval.
Shortcut to ``masked_where``, where `condition` is True for `x` outside
the interval [v1,v2] (x < v1)|(x > v2).
The boundaries `v1` and `v2` can be given in either order.
See Also
--------
masked_where : Mask where a condition is met.
Notes
-----
The array `x` is prefilled with its filling value.
Examples
--------
>>> import numpy.ma as ma
>>> x = [0.31, 1.2, 0.01, 0.2, -0.4, -1.1]
>>> ma.masked_outside(x, -0.3, 0.3)
masked_array(data=[--, --, 0.01, 0.2, --, --],
mask=[ True, True, False, False, True, True],
fill_value=1e+20)
The order of `v1` and `v2` doesn't matter.
>>> ma.masked_outside(x, 0.3, -0.3)
masked_array(data=[--, --, 0.01, 0.2, --, --],
mask=[ True, True, False, False, True, True],
fill_value=1e+20)
r� r� r� r� r� r� r� _ s
!
r� c C sV t | �r t�| j|�}| j}nt�t�| �|�}t}t|t ||d��}t
| |||d�S )a�
Mask the array `x` where the data are exactly equal to value.
This function is similar to `masked_values`, but only suitable
for object arrays: for floating point, use `masked_values` instead.
Parameters
----------
x : array_like
Array to mask
value : object
Comparison value
copy : {True, False}, optional
Whether to return a copy of `x`.
shrink : {True, False}, optional
Whether to collapse a mask full of False to nomask
Returns
-------
result : MaskedArray
The result of masking `x` where equal to `value`.
See Also
--------
masked_where : Mask where a condition is met.
masked_equal : Mask where equal to a given value (integers).
masked_values : Mask using floating point equality.
Examples
--------
>>> import numpy.ma as ma
>>> food = np.array(['green_eggs', 'ham'], dtype=object)
>>> # don't eat spoiled food
>>> eat = ma.masked_object(food, 'green_eggs')
>>> eat
masked_array(data=[--, 'ham'],
mask=[ True, False],
fill_value='green_eggs',
dtype=object)
>>> # plain ol` ham is boring
>>> fresh_food = np.array(['cheese', 'ham', 'pineapple'], dtype=object)
>>> eat = ma.masked_object(fresh_food, 'green_eggs')
>>> eat
masked_array(data=['cheese', 'ham', 'pineapple'],
mask=False,
fill_value='green_eggs',
dtype=object)
Note that `mask` is set to ``nomask`` if possible.
>>> eat
masked_array(data=['cheese', 'ham', 'pineapple'],
mask=False,
fill_value='green_eggs',
dtype=object)
r� �r@ r; r' ) rc rP rI r< rB r� r. r� rt rq rv )rR r� r; r� r� r@ r� r� r� r � s :r ��h㈵��>�:�0�yE>c C sZ t | |�}t�|jtj�r.tj||||d�}n t�||�}t||||d�}|rV|� � |S )a�
Mask using floating point equality.
Return a MaskedArray, masked where the data in array `x` are approximately
equal to `value`, determined using `isclose`. The default tolerances for
`masked_values` are the same as those for `isclose`.
For integer types, exact equality is used, in the same way as
`masked_equal`.
The fill_value is set to `value` and the mask is set to ``nomask`` if
possible.
Parameters
----------
x : array_like
Array to mask.
value : float
Masking value.
rtol, atol : float, optional
Tolerance parameters passed on to `isclose`
copy : bool, optional
Whether to return a copy of `x`.
shrink : bool, optional
Whether to collapse a mask full of False to ``nomask``.
Returns
-------
result : MaskedArray
The result of masking `x` where approximately equal to `value`.
See Also
--------
masked_where : Mask where a condition is met.
masked_equal : Mask where equal to a given value (integers).
Examples
--------
>>> import numpy.ma as ma
>>> x = np.array([1, 1.1, 2, 1.1, 3])
>>> ma.masked_values(x, 1.1)
masked_array(data=[1.0, --, 2.0, --, 3.0],
mask=[False, True, False, True, False],
fill_value=1.1)
Note that `mask` is set to ``nomask`` if possible.
>>> ma.masked_values(x, 1.5)
masked_array(data=[1. , 1.1, 2. , 1.1, 3. ],
mask=False,
fill_value=1.5)
For integers, the fill value will be different in general to the
result of ``masked_equal``.
>>> x = np.arange(5)
>>> x
array([0, 1, 2, 3, 4])
>>> ma.masked_values(x, 2)
masked_array(data=[0, 1, --, 3, 4],
mask=[False, False, True, False, False],
fill_value=2)
>>> ma.masked_equal(x, 2)
masked_array(data=[0, 1, --, 3, 4],
mask=[False, False, True, False, False],
fill_value=2)
)�atol�rtolr� )
rL r� �
issubdtyper �floatingZiscloserP rI rv � shrink_mask) rR r� r� r� r; r� Zxnewr@ �retr� r� r� r� � s E
r� c C sr t j| |dd�} t| dd�}|durNt �t| �� }|turD||O }t| �}nt �| � }t}| �|�}||_ |S )a�
Mask an array where invalid values occur (NaNs or infs).
This function is a shortcut to ``masked_where``, with
`condition` = ~(np.isfinite(a)). Any pre-existing mask is conserved.
Only applies to arrays with a dtype where NaNs or infs make sense
(i.e. floating point types), but accepts any array_like object.
See Also
--------
masked_where : Mask where a condition is met.
Examples
--------
>>> import numpy.ma as ma
>>> a = np.arange(5, dtype=float)
>>> a[2] = np.NaN
>>> a[3] = np.PINF
>>> a
array([ 0., 1., nan, inf, 4.])
>>> ma.masked_invalid(a)
masked_array(data=[0.0, 1.0, --, --, 4.0],
mask=[False, False, True, True, False],
fill_value=1e+20)
Tr: rB N)
r� r r� rA rV r� r2 r r> rB )r, r; r@ r� r8 r- r� r� r� r{ s
r{ c @ sF e Zd ZdZdd� Zdd� Zdd� Zdd � Zdd d �Zd
d� Z e Z
dS )�_MaskedPrintOptionzN
Handle the string used to represent missing data in a masked array.
c C s || _ d| _dS )z9
Create the masked_print_option object.
TN)�_display�_enabled)rJ �displayr� r� r� rK P s z_MaskedPrintOption.__init__c C s | j S )zA
Display the string to print for masked values.
�r� rc r� r� r� r� X s z_MaskedPrintOption.displayc C s
|| _ dS )z=
Set the string to print for masked values.
Nr� )rJ r� r� r� r� � set_display_ s z _MaskedPrintOption.set_displayc C s | j S )z;
Is the use of the display value enabled?
�r� rc r� r� r� �enabledf s z_MaskedPrintOption.enabledr� c C s
|| _ dS )z7
Set the enabling shrink to `shrink`.
Nr� )rJ r� r� r� r� �enablem s z_MaskedPrintOption.enablec C s
t | j�S r� )r r� rc r� r� r� rd t s z_MaskedPrintOption.__str__N)r� ) r� r� r� r� rK r� r� r� r� rd �__repr__r� r� r� r� r� J s
r� z--c C sL | j j}|dur8|D ] }| | }|| }t|||� qntj| ||d� dS )zg
Puts printoptions in result where mask is True.
Private function allowing for recursion
Nro )r r �_recursive_printoptionr� rp )r- r@ Zprintoptr r� ZcurdataZcurmaskr� r� r� r� } s r� z� masked_%(name)s(data =
%(data)s,
%(nlen)s mask =
%(mask)s,
%(nlen)s fill_value = %(fill)s)
z� masked_%(name)s(data =
%(data)s,
%(nlen)s mask =
%(mask)s,
%(nlen)s fill_value = %(fill)s,
%(nlen)s dtype = %(dtype)s)
z� masked_%(name)s(data = %(data)s,
%(nlen)s mask = %(mask)s,
%(nlen)s fill_value = %(fill)s)
z� masked_%(name)s(data = %(data)s,
%(nlen)s mask = %(mask)s,
%(nlen)s fill_value = %(fill)s,
%(nlen)s dtype = %(dtype)s)
)Zlong_stdZlong_flxZ short_stdZ short_flxc C sX | j j}|D ]F}| | }|j jdur:t||| || � q tj||| || d� q dS )z2
Recursively fill `a` with `fill_value`.
Nro )r r �_recursive_filledr� rp )r, r@ r' r r� �currentr� r� r� r� � s r� c s� � fdd�� t �| �} | j}| �� } t| t�rrt �� fdd�| jD ��}|�t�}t �� fdd�t | �D ��|_
nt �� fdd�| D ��}t |�dkr�t |j�}||d< t
� |��|_|S ) a:
Flatten a structured array.
The data type of the output is chosen such that it can represent all of the
(nested) fields.
Parameters
----------
a : structured array
Returns
-------
output : masked array or ndarray
A flattened masked array if the input is a masked array, otherwise a
standard ndarray.
Examples
--------
>>> ndtype = [('a', int), ('b', float)]
>>> a = np.array([(1, 1), (2, 2)], dtype=ndtype)
>>> np.ma.flatten_structured_array(a)
array([[1., 1.],
[2., 2.]])
c 3 s2 t | �D ]$}t|d�r&� |�E dH q|V qdS )z;
Flattens a compound of nested iterables.
r� N)�iterr )�iterableZelm��flatten_sequencer� r� r� � s
z2flatten_structured_array.<locals>.flatten_sequencec s g | ]}t � |�� ���qS r� �r r �r� rt r� r� r� r� � r� z,flatten_structured_array.<locals>.<listcomp>c s g | ]}t � |�� ���qS r� r� r� r� r� r� r� � s �c s g | ]}t � |�� ���qS r� r� r� r� r� r� r� � r� r� r )r� r- r� r� r r r r< r> rX rB r rD r )r, �inishape�outr� r� r� r� rO � s
�
rO c s@ � �fdd�}t t� d�p$t t� d�}|dur6|j|_� |_|S )a
Return a class method wrapper around a basic array method.
Creates a class method which returns a masked array, where the new
``_data`` array is the output of the corresponding basic method called
on the original ``_data``.
If `onmask` is True, the new mask is the output of the method called
on the initial mask. Otherwise, the new mask is just a reference
to the initial mask.
Parameters
----------
funcname : str
Name of the function to apply on data.
onmask : bool
Whether the mask must be processed also (True) or left
alone (False). Default is True. Make available as `_onmask`
attribute.
Returns
-------
method : instancemethod
Class method wrapper of the specified basic array method.
c sf t | j� �|i |��}|�t| ��}|�| � | j}�sD|�|� n |turbt |� �|i |��|_|S r� )r� r< r> r2 rq rB � __setmask__r� )rJ rr �paramsr- r@ ��funcname�onmaskr� r� �wrapped_method
s
z$_arraymethod.<locals>.wrapped_methodN)r� r r� r� r� )r� r� r� Zmethdocr� r� r� � _arraymethod� s r� c @ s8 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd S )
�MaskedIteratora�
Flat iterator object to iterate over masked arrays.
A `MaskedIterator` iterator is returned by ``x.flat`` for any masked array
`x`. It allows iterating over the array as if it were a 1-D array,
either in a for-loop or by calling its `next` method.
Iteration is done in C-contiguous style, with the last index varying the
fastest. The iterator can also be indexed using basic slicing or
advanced indexing.
See Also
--------
MaskedArray.flat : Return a flat iterator over an array.
MaskedArray.flatten : Returns a flattened copy of an array.
Notes
-----
`MaskedIterator` is not exported by the `ma` module. Instead of
instantiating a `MaskedIterator` directly, use `MaskedArray.flat`.
Examples
--------
>>> x = np.ma.array(arange(6).reshape(2, 3))
>>> fl = x.flat
>>> type(fl)
<class 'numpy.ma.core.MaskedIterator'>
>>> for item in fl:
... print(item)
...
0
1
2
3
4
5
Extracting more than a single element b indexing the `MaskedIterator`
returns a masked array:
>>> fl[2:4]
masked_array(data = [2 3],
mask = False,
fill_value = 999999)
c C s0 || _ |jj| _|jtu r"d | _n
|jj| _d S r� )r� r< �flat�dataiterrB r� �maskiter)rJ r� r� r� r� rK S
s
zMaskedIterator.__init__c C s | S r� r� rc r� r� r� r� \
s zMaskedIterator.__iter__c C sr | j �|��t| j��}| jd urn| j�|�}t|t�rH|j|_||_ n&t|t
j �rft ||| jj
d�S |rntS |S )N�r@ �hardmask)r� � __getitem__r> r2 r� r� r r r� rB r� r" r� � _hardmaskru )rJ �indxr- rB r� r� r� r� _
s
zMaskedIterator.__getitem__c C s* t |�| j|< | jd ur&t|�| j|< d S r� )rV r� r� rX )rJ �indexr� r� r� r� � __setitem__n
s
zMaskedIterator.__setitem__c C sH t | j�}| jdurDt | j�}t|tj�r<t||| jjd�S |rDt S |S )aT
Return the next value, or raise StopIteration.
Examples
--------
>>> x = np.ma.array([3, 2], mask=[0, 1])
>>> fl = x.flat
>>> next(fl)
3
>>> next(fl)
masked
>>> next(fl)
Traceback (most recent call last):
...
StopIteration
Nr� )
�nextr� r� r r� r" r� r� r� ru )rJ rt r� r� r� r� �__next__s
s
zMaskedIterator.__next__N) r� r� r� r� rK r� r� r� r� r� r� r� r� r� #
s / r� c sP e Zd ZdZdZeZdZeZ dZ
dZ dedddddddddf d d
�Z d d � Z
d
d� Zd�dd�Zd�dd�Zdd� Zdd� Ze� fdd��Zej� fdd��Ze� fdd��Zej� fd d��Zd�d d �ZeZed d � �Zejd!d � �Zed"d#� �Zejd$d#� �Zd%d&� Zd'd(� Z ed)d*� �Z d+d,� Z ed-d.� �Z d/d0� Z ed1d2� �Z!d3d4� Z"ee"d5�Z#ee"d5�Z$ed6d7� �Z%e%jd8d7� �Z%ed9d:� �Z&e&jd�d;d:��Z&e&j'Z(e&j)Z*d�d<d=�Z+d>d?� Z,d�d@dA�Z-dBdC� Z.dDdE� Z/dFdG� Z0dHdI� Z1dJdK� Z2dLdM� Z3dNdO� Z4dPdQ� Z5dRdS� Z6dTdU� Z7dVdW� Z8dXdY� Z9dZd[� Z:d\d]� Z;d^d_� Z<d`da� Z=dbdc� Z>ddde� Z?dfdg� Z@dhdi� ZAdjdk� ZBdldm� ZCdndo� ZDdpdq� ZEdrds� ZFdtdu� ZGdvdw� ZHdxdy� ZIdzd{� ZJed|d}� �ZKeKj'ZLed~d� �ZMeMj'ZNdeOjPfd�d��ZQd�d�d��ZRd�d�� ZSd�d�d��ZTd�d�d��ZUd�d�� ZVd�d�� ZWddeOjPfd�d��ZXddeOjPfd�d��ZYd�d�� ZZd� fd�d�� Z[ej[je[_d�d�d��Z\dddeOjPfd�d��Z]d�d�d��Z^dddeOjPfd�d��Z_e_Z`d�d�d��ZadddeOjPf� fd�d�� Zbd�d�d��ZcddddeOjPf� fd�d�� ZdeOjdjed_ddddeOjPfd�d��Zed�d�d��ZfeOjPddddfd�d��Zgd�eOjPd��d�d��Zhd�eOjPd��d�d��Zid�d�d��ZjdddeOjPfd�d��Zkd�d�d��ZldddeOjPfd�d��Zmd�d�d��Zn� fd�d��Zo� fd�dZpd�d�dĄZqerdŃZserdƃZterdǃZuerdȃZverdɃZwerdʃZxed�d̄ d5�Zyerd̓Zzd�d�dτZ{d�d�dфZ|d�d�dӄZ}d�d�dׄZ~d�dل ZeZ�� fd�dۄZ�� fd�d݄Z�d�d߄ Z�d�d�d�Z�� Z�S )�r az
An array class with possibly masked values.
Masked values of True exclude the corresponding element from any
computation.
Construction::
x = MaskedArray(data, mask=nomask, dtype=None, copy=False, subok=True,
ndmin=0, fill_value=None, keep_mask=True, hard_mask=None,
shrink=True, order=None)
Parameters
----------
data : array_like
Input data.
mask : sequence, optional
Mask. Must be convertible to an array of booleans with the same
shape as `data`. True indicates a masked (i.e. invalid) data.
dtype : dtype, optional
Data type of the output.
If `dtype` is None, the type of the data argument (``data.dtype``)
is used. If `dtype` is not None and different from ``data.dtype``,
a copy is performed.
copy : bool, optional
Whether to copy the input data (True), or to use a reference instead.
Default is False.
subok : bool, optional
Whether to return a subclass of `MaskedArray` if possible (True) or a
plain `MaskedArray`. Default is True.
ndmin : int, optional
Minimum number of dimensions. Default is 0.
fill_value : scalar, optional
Value used to fill in the masked values when necessary.
If None, a default based on the data-type is used.
keep_mask : bool, optional
Whether to combine `mask` with the mask of the input data, if any
(True), or to use only `mask` for the output (False). Default is True.
hard_mask : bool, optional
Whether to use a hard mask or not. With a hard mask, masked values
cannot be unmasked. Default is False.
shrink : bool, optional
Whether to force compression of an empty mask. Default is True.
order : {'C', 'F', 'A'}, optional
Specify the order of the array. If order is 'C', then the array
will be in C-contiguous order (last-index varies the fastest).
If order is 'F', then the returned array will be in
Fortran-contiguous order (first-index varies the fastest).
If order is 'A' (default), then the returned array may be
in any order (either C-, Fortran-contiguous, or even discontiguous),
unless a copy is required, in which case it will be C-contiguous.
Examples
--------
The ``mask`` can be initialized with an array of boolean values
with the same shape as ``data``.
>>> data = np.arange(6).reshape((2, 3))
>>> np.ma.MaskedArray(data, mask=[[False, True, False],
... [False, False, True]])
masked_array(
data=[[0, --, 2],
[3, 4, --]],
mask=[[False, True, False],
[False, False, True]],
fill_value=999999)
Alternatively, the ``mask`` can be initialized to homogeneous boolean
array with the same shape as ``data`` by passing in a scalar
boolean value:
>>> np.ma.MaskedArray(data, mask=False)
masked_array(
data=[[0, 1, 2],
[3, 4, 5]],
mask=[[False, False, False],
[False, False, False]],
fill_value=999999)
>>> np.ma.MaskedArray(data, mask=True)
masked_array(
data=[[--, --, --],
[--, --, --]],
mask=[[ True, True, True],
[ True, True, True]],
fill_value=999999,
dtype=int64)
.. note::
The recommended practice for initializing ``mask`` with a scalar
boolean value is to use ``True``/``False`` rather than
``np.True_``/``np.False_``. The reason is :attr:`nomask`
is represented internally as ``np.False_``.
>>> np.False_ is np.ma.nomask
True
� F�d i� NTr c s. t j|||| d|d�� t|dt� ��} t|t�r@|j� jkr@d}t|| �rj|rjt|t�sjt� � t|��� n t� � | �� t
|d�r�t|t�s�|j � _ t � j
��|tu �rl|s�|
r�t� _ nt j� j�d�� _ n�t|ttf��r6z t j� fdd�|D ��d�}W n t�y t}Y n0 �tk�rh|�� �rh|� _ d� _n2| � _|�rֈ j �� � _ t|�tu�r�|j|j _�nj|du �r��tk�r�t j� j�d�}nl|du �r��tk�r�t j� j�d�}nFzt j||�d �}W n0 t�y� t j�fd
d�|D ��d�}Y n0 |j� jk�rf� j|j }
}|d k�r4t �|� j�}n.||
k�rNt � |� j�}nd }t ||
|f ��d}� j tu �r�|� _ | � _nT|�s�|� _ | � _n>� j
j d
u�r��fdd���� j |� nt � |� j �� _ d� _|d
u �r�t|dd
�}|d
u�rt |� j
�� _!| d
u �r t|dd�� _"n| � _"| � _#� S )z�
Create a new masked array from scratch.
Notes
-----
A masked array can also be created by taking a .view(MaskedArray).
T)r r; �orderr; �ndmin�
_baseclassrB r c s g | ]}t tj|� jd ���qS )r )rX r� r- r �r� r� )r< r� r� r� 1 s �z'MaskedArray.__new__.<locals>.<listcomp>Fr! c s g | ]}t |gt� � ��qS r� �r r r� ��mdtyper� r� r� N r� r� z?Mask and data not compatible: data size is %i, mask size is %i.Nc sD | j jD ]6}| | || }}|j jdur6� ||� q||O }qdS )z'do a|=b on each field of a, recursivelyNr� )r, r� r� �afZbf)�
_recursive_orr� r� r� f s
z*MaskedArray.__new__.<locals>._recursive_or� _fill_valuer� )$r� r r� r2 r r r� r4 r r> r rB rr r r� r� r rD r# r r � _sharedmaskr; rW r� r� r� r� r� r r ro r* r� r� r� )r8 r? r@ r r; r; r� r' � keep_mask� hard_maskr� r� r� ZndZnm�msgr� )r< r� r� r� �__new__�
s�
�
��
�
zMaskedArray.__new__c C s� t |t�rt|�}nt}i }|�t|di �� |�t|di �� t |t�s\|�t|di �� tt|dd�t|dd�t|dd�t|d d�t|d
|�||d �}| j�|� | j�|� dS ) z9
Copies some attributes of obj to self.
�_optinfo� _basedict�__dict__r� Nr� Fr� �_isfieldr� )r� r� r� r� r� r� r� )r r r2 �updater� r r1 r� )rJ r� r� r� �_dictr� r� r� rq � s&
� zMaskedArray._update_fromc C s: | � |� t|t�r�|jjdur*t|�}nt|�}|tur�|jd d | jd d kr�| j|jkrj|j}n
t | j�}| j
j r�d}n| j
j r�d}nd}|�
||�}q�|�� }nt}|| _| jtur�z| j| j_W n, ty� t| _Y n ttfy� Y n0 | jdu�rt| j| j�| _n | jjdu�r6td| j�| _dS )z.
Finalizes the masked array.
Nr? r �C�F�K)rq r r r r rX rW r� Z__array_interface__rr �flags� c_contiguous� f_contiguous�astyper> rB r� r# r� r= r� r* )rJ r� rB Z _mask_dtyper� r� r� r� �__array_finalize__� s>
�
z MaskedArray.__array_finalize__c C s` || u r|}n|� t| ��}|�| � |du�r\|j�� |_|\}}}|d|j� }ttdd� |D ��}t� |d�} | du�r0t
j ddd�� t | |� d�}
W d � n1 s�0 Y |
�
� �r0zt| d } W n2 ty� t| } Y n t�y | j} Y n0 t
j|| |
d� |tu �r(|
}n||
B }|| u�rP|jd k�rP|�rPtS ||_d
|_|S ) zr
Special hook for ufuncs.
Wraps the numpy array and sets the mask according to context.
Nc S s g | ] }t |��qS r� �rX )r� �argr� r� r� r� r� z.MaskedArray.__array_wrap__.<locals>.<listcomp>rM rn Tr� ro r� F)r> r2 rq rB r; Zninr rt ri r r� rO rL r rj r� r r' rp r� r� ru r� ) rJ r� �contextr- �funcrr Zout_iZ
input_argsr� rh rt r' r� r� r� �__array_wrap__� s:
,
zMaskedArray.__array_wrap__c C s� |du r*|du r t �| �}q�t �| |�}nd|du r�z,t|t �rPt �| |�}d}n t �| |�}W q� ty| t �| |�}Y q�0 nt �| ||�}t|�tur�|j�� |_t|dd�dur�|du r�|du r�q�d|_n||_ |S )a3
Return a view of the MaskedArray data.
Parameters
----------
dtype : data-type or ndarray sub-class, optional
Data-type descriptor of the returned view, e.g., float32 or int16.
The default, None, results in the view having the same data-type
as `a`. As with ``ndarray.view``, dtype can also be specified as
an ndarray sub-class, which then specifies the type of the
returned object (this is equivalent to setting the ``type``
parameter).
type : Python type, optional
Type of the returned view, either ndarray or a subclass. The
default None results in type preservation.
fill_value : scalar, optional
The value to use for invalid entries (None by default).
If None, then this argument is inferred from the passed `dtype`, or
in its absence the original array, as discussed in the notes below.
See Also
--------
numpy.ndarray.view : Equivalent method on ndarray object.
Notes
-----
``a.view()`` is used two different ways:
``a.view(some_dtype)`` or ``a.view(dtype=some_dtype)`` constructs a view
of the array's memory with a different data-type. This can cause a
reinterpretation of the bytes of memory.
``a.view(ndarray_subclass)`` or ``a.view(type=ndarray_subclass)`` just
returns an instance of `ndarray_subclass` that looks at the same array
(same shape, dtype, etc.) This does not cause a reinterpretation of the
memory.
If `fill_value` is not specified, but `dtype` is specified (and is not
an ndarray sub-class), the `fill_value` of the MaskedArray will be
reset. If neither `fill_value` nor `dtype` are specified (or if
`dtype` is an ndarray sub-class), then the fill value is preserved.
Finally, if `fill_value` is specified, but `dtype` is not, the fill
value is set to the specified value.
For ``a.view(some_dtype)``, if ``some_dtype`` has a different number of
bytes per entry than the previous dtype (for example, converting a
regular array to a structured array), then the behavior of the view
cannot be predicted just from the superficial appearance of ``a`` (shown
by ``print(a)``). It also depends on exactly how ``a`` is stored in
memory. Therefore if ``a`` is C-ordered versus fortran-ordered, versus
defined as a slice or transpose, etc., the view may give different
results.
Nr� )
r r> r5 r� rW r� rB r� r� r' )rJ r r2 r' r� r� r� r� r> 1 s, 8
zMaskedArray.viewc C s� | j | }| j}dd� }dd� }|tur:|| }||�}n(t}|| j |�}|du rb|t| �| �}|r�t|tj�r�t||| jd�S | j j
tj u r�t|tj �r�|t
ur�|r�t|dd�S |S n |r�t
S |S n�|�t
| ��}|�| � t|��r�| jdu�r|| j| |_t|jtj ��std ��|jjd
k�r||j|jjd
k�� �sbtjd |�d |jd
�d
�dd� |jjd
d� jd
d�|_d|_|tu�r�t||j �|_d|_ |S )zi
x.__getitem__(y) <==> x[y]
Return the item described by i, as a masked array.
c S s t | tj� S r� )r r� r r� r� r� r� �
_is_scalar� s z+MaskedArray.__getitem__.<locals>._is_scalarc S sH t |tj�sdS | jjtju r0| j|jurDdS nt| �jtjkrDdS dS )z�
Return whether `elem` is a scalar result of indexing `arr`, or None
if undecidable without promoting nomask to a full mask
TFN)r r� r r r2 �object_r� )r� �elemr� r� r� �_scalar_heuristic� s z2MaskedArray.__getitem__.<locals>._scalar_heuristicNr� Tr� zInternal NumPy error.r z&Upon accessing multidimensional field zi, need to keep dimensionality of fill_value at 0. Discarding heterogeneous fill_value and setting all to r � r� r� �r� ) r? rB r� rX r r� r" r� r� r r2 r
r ru r r> rq rG r� � RuntimeErrorr� r� r r� r� r� r� r� r� r� )rJ r� ZdoutrB r r ZmoutZscalar_expectedr� r� r� r� � sd
��
�
���
zMaskedArray.__getitem__c C s | t u rtd��| j}| j}t|t�rZ|||< |tu rJt| j| j � | _}t
|�||< dS |j }|t u r�|tu r�t| j|� }| _|j dur�t dgt
|j � �||< nd||< dS t|d|�}t
|�}|j dur�|tu r�t dgt
|j � �}|tu �r$|||< |tu�rt| j|� }| _|||< n�| j�sbt|t��rPt|t��sP|||j< n|||< |||< n�t|d��r�|j tk�r�|t�|� }|||< nr|j du�r�d}t|��t|| |dd�} | j| }
|
jd k�r�tj|
|| d
� n| tu �r�|}
|
||< | ||< dS ) z�
x.__setitem__(i, y) <==> x[i]=y
Set item described by index. If value is masked, masks those
locations.
z Cannot alter the masked element.NTr< Fr z,Flexible 'hard' masks are not yet supported.r� r� ro )ru r r< rB r r r� rs r� r rW r r r r� r� rv r? r r rP rn �NotImplementedErrorrt r� r� rp ) rJ r� r� r< rB Z_dtypeZdvalZmvalr) ZmindxZdindxr� r� r� r�
sb
�
zMaskedArray.__setitem__c s t � jS r� )rf r rc rk r� r� r O
s zMaskedArray.dtypec s` t tt| ��j�| |� | jtur\| j�t|�t �| _z| j
| j_
W n t t fyZ Y n0 d S r� )
rf r r2 r �__set__rB r� r> rr r r� r= r� )rJ r rk r� r� r S
s
c s t � jS r� )rf r� rc rk r� r� r� _
s zMaskedArray.shapec s2 t tt| ��j�| |� t| �tur.| j| j_d S r� )rf r r2 r� r rW r� rB )rJ r� rk r� r� r� c
s c s� | j }| j}|tu rd}|tu r>|tu r,dS t| j|� }| _|jdu r�| jrX||O }n&t|t t
t j t j
f�rx||d< n||_n�|j � t j|dd�}|js�|j jdkr�t jt|�� gt� � �� d�}n
|�� �}nFzt j||� d�}W n0 t�y t j� fd d
�|D �� d�}Y n0 | j�rF|jD ]}|| || O < �q(n(t|t t
t j t j
f��rh||d< n||_|j�r~| j|_dS ) z
Set the mask.
TN.Fr� r� r r! c s g | ]}t |gt� � ��qS r� r� r� r� r� r� r� �
r� z+MaskedArray.__setmask__.<locals>.<listcomp>)r rB ru r� rs r� r r� r �intr[ r� r �numberr� r r� r r r r r r� )rJ r@ r; ZidtypeZ current_mask�nr� r� r� r� k
sJ
� �
zMaskedArray.__setmask__c C s
| j �� S )z Current mask. )rB r> rc r� r� r� r@ �
s zMaskedArray.maskc C s | � |� d S r� )r� )rJ r� r� r� r� r@ �
s c C s. | j �t�}|jjdu r |S tjt|�dd�S )a�
Get or set the mask of the array if it has no named fields. For
structured arrays, returns a ndarray of booleans where entries are
``True`` if **all** the fields are masked, ``False`` otherwise:
>>> x = np.ma.array([(1, 1), (2, 2), (3, 3), (4, 4), (5, 5)],
... mask=[(0, 0), (1, 0), (1, 1), (0, 1), (0, 0)],
... dtype=[('a', int), ('b', int)])
>>> x.recordmask
array([False, False, True, False, False])
Nr� r )rB r> r r r r� r rO )rJ rB r� r� r� �
recordmask�
s zMaskedArray.recordmaskc C s t d��d S )Nz*Coming soon: setting the mask per records!�r )rJ r@ r� r� r� r �
s c C s
d| _ | S )a�
Force the mask to hard, preventing unmasking by assignment.
Whether the mask of a masked array is hard or soft is determined by
its `~ma.MaskedArray.hardmask` property. `harden_mask` sets
`~ma.MaskedArray.hardmask` to ``True`` (and returns the modified
self).
See Also
--------
ma.MaskedArray.hardmask
ma.MaskedArray.soften_mask
T�r� rc r� r� r� r[ �
s zMaskedArray.harden_maskc C s
d| _ | S )a�
Force the mask to soft (default), allowing unmasking by assignment.
Whether the mask of a masked array is hard or soft is determined by
its `~ma.MaskedArray.hardmask` property. `soften_mask` sets
`~ma.MaskedArray.hardmask` to ``False`` (and returns the modified
self).
See Also
--------
ma.MaskedArray.hardmask
ma.MaskedArray.harden_mask
Fr rc r� r� r� r� �
s zMaskedArray.soften_maskc C s | j S )a�
Specifies whether values can be unmasked through assignments.
By default, assigning definite values to masked array entries will
unmask them. When `hardmask` is ``True``, the mask will not change
through assignments.
See Also
--------
ma.MaskedArray.harden_mask
ma.MaskedArray.soften_mask
Examples
--------
>>> x = np.arange(10)
>>> m = np.ma.masked_array(x, x>5)
>>> assert not m.hardmask
Since `m` has a soft mask, assigning an element value unmasks that
element:
>>> m[8] = 42
>>> m
masked_array(data=[0, 1, 2, 3, 4, 5, --, --, 42, --],
mask=[False, False, False, False, False, False,
True, True, False, True],
fill_value=999999)
After hardening, the mask is not affected by assignments:
>>> hardened = np.ma.harden_mask(m)
>>> assert m.hardmask and hardened is m
>>> m[:] = 23
>>> m
masked_array(data=[23, 23, 23, 23, 23, 23, --, --, 23, --],
mask=[False, False, False, False, False, False,
True, True, False, True],
fill_value=999999)
r rc r� r� r� r� �
s *zMaskedArray.hardmaskc C s | j r| j�� | _d| _ | S )aY
Copy the mask and set the `sharedmask` flag to ``False``.
Whether the mask is shared between masked arrays can be seen from
the `sharedmask` property. `unshare_mask` ensures the mask is not
shared. A copy of the mask is only made if it was shared.
See Also
--------
sharedmask
F)r� rB r; rc r� r� r� � unshare_mask' s
zMaskedArray.unshare_maskc C s | j S )z' Share status of the mask (read-only). )r� rc r� r� r� �
sharedmask9 s zMaskedArray.sharedmaskc C s t | j�| _| S )a
Reduce a mask to nomask when possible.
Parameters
----------
None
Returns
-------
None
Examples
--------
>>> x = np.ma.array([[1,2 ], [3, 4]], mask=[0]*4)
>>> x.mask
array([[False, False],
[False, False]])
>>> x.shrink_mask()
masked_array(
data=[[1, 2],
[3, 4]],
mask=False,
fill_value=999999)
>>> x.mask
False
)r� rB rc r� r� r� r� > s zMaskedArray.shrink_maskc C s | j S )z+ Class of the underlying data (read-only). )r� rc r� r� r� � baseclass] s zMaskedArray.baseclassc C s t �| | j�S )a�
Returns the underlying data, as a view of the masked array.
If the underlying data is a subclass of :class:`numpy.ndarray`, it is
returned as such.
>>> x = np.ma.array(np.matrix([[1, 2], [3, 4]]), mask=[[0, 1], [1, 0]])
>>> x.data
matrix([[1, 2],
[3, 4]])
The type of the data can be accessed through the :attr:`baseclass`
attribute.
)r r> r� rc r� r� r� � _get_datab s zMaskedArray._get_data)�fgetc C s t | �S )zF Return a flat iterator, or set a flattened version of self to value. )r� rc r� r� r� r� v s zMaskedArray.flatc C s | � � }||d d �< d S r� )r� )rJ r� �yr� r� r� r� { s c C s4 | j du rtd| j�| _ t| j t�r.| j d S | j S )a�
The filling value of the masked array is a scalar. When setting, None
will set to a default based on the data type.
Examples
--------
>>> for dt in [np.int32, np.int64, np.float64, np.complex128]:
... np.ma.array([0, 1], dtype=dt).get_fill_value()
...
999999
999999
1e+20
(1e+20+0j)
>>> x = np.ma.array([0, 1.], fill_value=-np.inf)
>>> x.fill_value
-inf
>>> x.fill_value = np.pi
>>> x.fill_value
3.1415926535897931 # may vary
Reset to default:
>>> x.fill_value = None
>>> x.fill_value
1e+20
Nr� )r� r* r r r rc r� r� r� r' � s
zMaskedArray.fill_valuec C sH t || j�}|jdks&tjdtdd� | j}|d u r<|| _n||d< d S )Nr z�Non-scalar arrays for the fill value are deprecated. Use arrays with scalar values instead. The filled function still supports any array as `fill_value`.r
r� r� )r* r r� r� r� �DeprecationWarningr� )rJ r� r� r� r� r� r� r' � s
�c C s | j }|tu r| jS |du r$| j}n t|| j�}| tu rBt�|�S |jj durj| j�
d�}t || j |� n�|� � sx| jS | j�
d�}ztj
|||d� W nx ttfy� t|td�}|�t�}t�|||f�}Y n> t�y | jjr� n |�rtj|| jd�}n| j}Y n0 |S )a�
Return a copy of self, with masked values filled with a given value.
**However**, if there are no masked values to fill, self will be
returned instead as an ndarray.
Parameters
----------
fill_value : array_like, optional
The value to use for invalid entries. Can be scalar or non-scalar.
If non-scalar, the resulting ndarray must be broadcastable over
input array. Default is None, in which case, the `fill_value`
attribute of the array is used instead.
Returns
-------
filled_array : ndarray
A copy of ``self`` with invalid entries replaced by *fill_value*
(be it the function argument or the attribute of ``self``), or
``self`` itself as an ndarray if there are no invalid entries to
be replaced.
Notes
-----
The result is **not** a MaskedArray!
Examples
--------
>>> x = np.ma.array([1,2,3,4,5], mask=[0,0,1,0,1], fill_value=-999)
>>> x.filled()
array([ 1, 2, -999, 4, -999])
>>> x.filled(fill_value=1000)
array([ 1, 2, 1000, 4, 1000])
>>> type(x.filled())
<class 'numpy.ndarray'>
Subclassing is preserved. This means that if, e.g., the data part of
the masked array is a recarray, `filled` returns a recarray:
>>> x = np.array([(-1, 2), (-3, 4)], dtype='i8,i8').view(np.recarray)
>>> m = np.ma.array(x, mask=[(True, False), (False, True)])
>>> m.filled()
rec.array([(999999, 2), ( -3, 999999)],
dtype=[('f0', '<i8'), ('f1', '<i8')])
Nr� ro r )rB r� r< r' r* r r� r� r- r r; r� r rp r� r= �narrayr$ r r3 r� r� r )rJ r' r� r- rt r� r� r� rL � s6 -
zMaskedArray.filledc C s2 t �| j�}| jtur.|�t�t �| j���}|S )a�
Return all the non-masked data as a 1-D array.
Returns
-------
data : ndarray
A new `ndarray` holding the non-masked data is returned.
Notes
-----
The result is **not** a MaskedArray!
Examples
--------
>>> x = np.ma.array(np.arange(5), mask=[0]*2 + [1]*3)
>>> x.compressed()
array([0, 1])
>>> type(x.compressed())
<class 'numpy.ndarray'>
)r r� r< rB r� r6 r� rn )rJ r? r� r� r� r7 s
zMaskedArray.compressedc C sX | j | j }}t�|�}|j|||d��t| ��}|�| � |turT|j||d�|_|S )a+
Return `a` where condition is ``True``.
If condition is a `~ma.MaskedArray`, missing values are considered
as ``False``.
Parameters
----------
condition : var
Boolean 1-d array selecting which entries to return. If len(condition)
is less than the size of a along the axis, then output is truncated
to length of condition array.
axis : {None, int}, optional
Axis along which the operation must be performed.
out : {None, ndarray}, optional
Alternative output array in which to place the result. It must have
the same shape as the expected output but the type will be cast if
necessary.
Returns
-------
result : MaskedArray
A :class:`~ma.MaskedArray` object.
Notes
-----
Please note the difference with :meth:`compressed` !
The output of :meth:`compress` has a mask, the output of
:meth:`compressed` does not.
Examples
--------
>>> x = np.ma.array([[1,2,3],[4,5,6],[7,8,9]], mask=[0] + [1,0]*4)
>>> x
masked_array(
data=[[1, --, 3],
[--, 5, --],
[7, --, 9]],
mask=[[False, True, False],
[ True, False, True],
[False, True, False]],
fill_value=999999)
>>> x.compress([1, 0, 1])
masked_array(data=[1, 3],
mask=[False, False],
fill_value=999999)
>>> x.compress([1, 0, 1], axis=1)
masked_array(
data=[[1, 3],
[--, --],
[7, 9]],
mask=[[False, False],
[ True, True],
[False, False]],
fill_value=999999)
�r� r� r ) r< rB r� r. r6 r> r2 rq r� )rJ r� r� r� r< rB Z_newr� r� r� r6 + s <
zMaskedArray.compressc C s� t �� r�| j}|tu r | j}q�| j}| jdkr4| jn| j}t| j�D ]z}|j | |krD|d }t
j ||| f|d�}t
j |d |d f|d�}t
j ||| f|d�}t
j |d |d f|d�}qDt
| jd�}|�|�}t||t � n | �| j�}|S )zq
Replace masked values with masked_print_option, casting all innermost
dtypes to object.
r� r
r r r� )r� r� rB r� r< r� � _print_width�_print_width_1d�ranger� r� r� r8 r� r r r� rL r' ) rJ r@ �resr? Z print_widthr� Zindr� �rdtyper� r� r� �_insert_masked_prints s( �
z MaskedArray._insert_masked_printc C s t | �� �S r� )r r& rc r� r� r� rd � s zMaskedArray.__str__c
s | j tju rd}n| j j}tjj�� dkr�| jdk}t|dt |� t
| �t
| j �t
| j �t
| j
�d�}t| j
j�}d�|r~dnd|r�d nd
�}t| | S d |� d �}tjj�| j
� p�t�| j�p�| jd
k}g d�}|r�|�d� t�dd� | jdd� D ��} d�| �rbi � |� |d
< |dd� D ]2}
t��t ||d
�t |
� �} d| � |
< �q(d}n�fdd�|D �� |d }i �tj| �� d� d d d d ��d< tj| j d� d d d d ��d < t | j ��d < |�r�tjj� | j
��d< d!� � �fd"d�|D ��} || d# S )$z1
Literal string representation.
r �q r� � )r� Znlenr? r@ rg r z{}_{}r
ZshortZflxr� Zmasked_�(r )r? r@ r' r c s s | ]}|d kV qdS )r� Nr� )r� Zdimr� r� r� r � r� z'MaskedArray.__repr__.<locals>.<genexpr>Nr� r
r� c s i | ]}|d � �qS )r( r� r� )�
min_indentr� r� �
<dictcomp>� r� z(MaskedArray.__repr__.<locals>.<dictcomp>�
z, r? zdata=�,)� separator�prefix�suffixr@ zmask=r' z,
c 3 s$ | ] }d � � | |�| �V qdS )z{}{}={}N)�formatr� )�indents�reprsr� r� r � s ��)) r� r� r r� �coreZ
arrayprintZ_get_legacy_print_moder� r1 r r rB r' r r� r r1 �_legacy_print_templatesZdtype_is_impliedr r@ r� r rE r� r� Z array2stringr& �reprZdtype_short_reprr� )
rJ r� Zis_long�
parametersZ
is_structured�keyr/ Z dtype_needed�keysZ
is_one_rowr� r r- r� )r2 r* r3 r� r� � sv
�
�
��
�
�
�zMaskedArray.__repr__c C sH t |t| ��rdS t|dd�}|du r<t|dd�}| j|k S |d u S d S )NFZ__array_ufunc__�__array_priority__i���)r r2 r� r; )rJ �otherZ array_ufuncZother_priorityr� r� r� �_delegate_binop� s
zMaskedArray._delegate_binopc C sD t |�}| j}t||dd�}t|�}|jjdurrt�| |�j}tj | |dd�}||_
|� |�} |t� d|j�k}n| j
} || |�}
t|
tjtf�r�|r�tS |
S |tur�t�||||�|
�}
|j|
jkr�t� ||
j��� }|
�t| ��}
|
�| � ||
_
|
jdu�r@zt|
jtj�} W n$ ttf�y8 tdtj�} Y n0 | |
_|
S )a� Compare self with other using operator.eq or operator.ne.
When either of the elements is masked, the result is masked as well,
but the underlying boolean data are still set, with self and other
considered equal if both are masked, and unequal otherwise.
For structured arrays, all fields are combined, with masked values
ignored. The result is masked if all fields were masked, with self
and other considered equal only if both were fully masked.
Tr� N�r; r� ) rW r@ rt rV r r r� r� r� Z broadcast_torB rL r� r? r r r� ru r� r� r; r> r2 rq r� r* r� r# ) rJ r< �compareZomaskZsmaskr@ ZodataZbroadcast_shapeZ
sbroadcastZsdata�checkrg r� r� r� � _comparison� s8
zMaskedArray._comparisonc C s | � |tj�S )a� Check whether other equals self elementwise.
When either of the elements is masked, the result is masked as well,
but the underlying boolean data are still set, with self and other
considered equal if both are masked, and unequal otherwise.
For structured arrays, all fields are combined, with masked values
ignored. The result is masked if all fields were masked, with self
and other considered equal only if both were fully masked.
)rA �operator�eq�rJ r< r� r� r� �__eq__7 s zMaskedArray.__eq__c C s | � |tj�S )a� Check whether other does not equal self elementwise.
When either of the elements is masked, the result is masked as well,
but the underlying boolean data are still set, with self and other
considered equal if both are masked, and unequal otherwise.
For structured arrays, all fields are combined, with masked values
ignored. The result is masked if all fields were masked, with self
and other considered equal only if both were fully masked.
)rA rB �nerD r� r� r� �__ne__D s zMaskedArray.__ne__c C s | � |�rtS t| |�S )zD
Add self to other, and return a new masked array.
)r= �NotImplementedr rD r� r� r� �__add__Q s
zMaskedArray.__add__c C s
t || �S )zD
Add other to self, and return a new masked array.
)r rD r� r� r� �__radd__Z s zMaskedArray.__radd__c C s | � |�rtS t| |�S )zK
Subtract other from self, and return a new masked array.
)r= rH r� rD r� r� r� �__sub__c s
zMaskedArray.__sub__c C s
t || �S )zK
Subtract self from other, and return a new masked array.
)r� rD r� r� r� �__rsub__l s zMaskedArray.__rsub__c C s | � |�rtS t| |�S )z6Multiply self by other, and return a new masked array.)r= rH r� rD r� r� r� �__mul__s s
zMaskedArray.__mul__c C s
t || �S )zI
Multiply other by self, and return a new masked array.
)r� rD r� r� r� �__rmul__y s zMaskedArray.__rmul__c C s | � |�rtS t| |�S �zI
Divide other into self, and return a new masked array.
)r= rH rF rD r� r� r� �__div__� s
zMaskedArray.__div__c C s | � |�rtS t| |�S rO )r= rH r� rD r� r� r� � __truediv__� s
zMaskedArray.__truediv__c C s
t || �S �zI
Divide self into other, and return a new masked array.
)r� rD r� r� r� � __rtruediv__� s zMaskedArray.__rtruediv__c C s | � |�rtS t| |�S rO )r= rH rQ rD r� r� r� � __floordiv__� s
zMaskedArray.__floordiv__c C s
t || �S rR )rQ rD r� r� r� �
__rfloordiv__� s zMaskedArray.__rfloordiv__c C s | � |�rtS t| |�S )zQ
Raise self to the power other, masking the potential NaNs/Infs
)r= rH r� rD r� r� r� �__pow__� s
zMaskedArray.__pow__c C s
t || �S )zQ
Raise other to the power self, masking the potential NaNs/Infs
)r� rD r� r� r� �__rpow__� s zMaskedArray.__rpow__c C s� t |�}| jtu rB|turX|�� rXt| j| j�| _| j|7 _n|turX| j|7 _| j�t �
| j| j� d�t |��� | S )z.
Add other to self in-place.
r )
rW rB r� r rs r� r r< �__iadd__r� r� r2 rV �rJ r< r� r� r� r� rX � s
�zMaskedArray.__iadd__c C s� t |�}| jtu rB|turX|�� rXt| j| j�| _| j|7 _n|turX| j|7 _| j�t �
| j| j� d�t |��� | S )z5
Subtract other from self in-place.
r )
rW rB r� r rs r� r r< �__isub__r� r� r2 rV rY r� r� r� rZ � s
�zMaskedArray.__isub__c C s� t |�}| jtu rB|turX|�� rXt| j| j�| _| j|7 _n|turX| j|7 _| j�t �
| j| j� d�t |��� | S )z3
Multiply self by other in-place.
r� )
rW rB r� r rs r� r r< �__imul__r� r� r2 rV rY r� r� r� r[ � s
�zMaskedArray.__imul__c C s� t |�}t� �| j|�}t|�}t||�}|�� rNttj \}}t�
|||�}| j |O _ | j� t�
| j | j
�d�|�� | S )z1
Divide self by other in-place.
r� )rV rY rS r< rW rt r rj r� rF r� rB �__idiv__r r2 �rJ r< �
other_dataZdom_mask�
other_mask�new_maskr� r r� r� r� r\ � s
�zMaskedArray.__idiv__c C s� t |�}t� �| j|�}t|�}t||�}|�� rNttj \}}t�
|||�}| j |O _ | j� t�
| j | j
�d�|�� | S )z7
Floor divide self by other in-place.
r� )rV rY rS r< rW rt r rj r� rQ r� rB �
__ifloordiv__r r2 r] r� r� r� ra � s
�zMaskedArray.__ifloordiv__c C s� t |�}t� �| j|�}t|�}t||�}|�� rNttj \}}t�
|||�}| j |O _ | j� t�
| j | j
�d�|�� | S )z6
True divide self by other in-place.
r� )rV rY rS r< rW rt r rj r� r� r� rB � __itruediv__r r2 r] r� r� r� rb s
�zMaskedArray.__itruediv__c C s� t |�}t|�}tjddd��0 | j�t�| j| j� d�|�� W d � n1 sT0 Y t�
t� | j��}|� � r�| jt
ur�| j|O _n|| _tj| j| j|d� t||�}t| j|�| _| S )z;
Raise self to the power other, in place.
rM rn r� Nro )rV rW r� rO r< �__ipow__r� rB r r2 rn rA r r� rp r' rt )rJ r< r^ r_ rC r` r� r� r� rc " s �$
zMaskedArray.__ipow__c C s: | j dkrtd��n| jr.tjddd� tjS t| �� �S )z$
Convert to float.
r� �7Only length-1 arrays can be converted to Python scalarsz,Warning: converting a masked element to nan.r
r� ) r� r� rB r� r� r� �nanr[ r rc r� r� r� � __float__7 s
zMaskedArray.__float__c C s. | j dkrtd��n| jr"td��t| �� �S )z"
Convert to int.
r� rd z.Cannot convert masked element to a Python int.)r� r� rB r r r rc r� r� r� �__int__D s
zMaskedArray.__int__c C s" | j j�t| ��}|�| j� |S )a�
The imaginary part of the masked array.
This property is a view on the imaginary part of this `MaskedArray`.
See Also
--------
real
Examples
--------
>>> x = np.ma.array([1+1.j, -2j, 3.45+1.6j], mask=[False, True, False])
>>> x.imag
masked_array(data=[1.0, --, 1.6],
mask=[False, True, False],
fill_value=1e+20)
)r< �imagr> r2 r� rB �rJ r- r� r� r� rh P s zMaskedArray.imagc C s" | j j�t| ��}|�| j� |S )a�
The real part of the masked array.
This property is a view on the real part of this `MaskedArray`.
See Also
--------
imag
Examples
--------
>>> x = np.ma.array([1+1.j, -2j, 3.45+1.6j], mask=[False, True, False])
>>> x.real
masked_array(data=[1.0, --, 3.45],
mask=[False, True, False],
fill_value=1e+20)
)r< �realr> r2 r� rB ri r� r� r� rj k s zMaskedArray.realc sZ |t ju ri nd|i}| j}t| jt j�rT|tu rDt j| jt j d�}|�
t | j��}|tu �r2| jdkr�|dvr�t j || j
d��dS |du r�|�dd�r�t j| jt j| j
d �S | jS t|| j
�� d}� D ]}|| j| 9 }q�|�dd��rt| j�}� D ] }d||< q�n� fd
d �t| j�D �}t j||t jd�S | tu �r@d S | jf |t jd
�|��S )a
Count the non-masked elements of the array along the given axis.
Parameters
----------
axis : None or int or tuple of ints, optional
Axis or axes along which the count is performed.
The default, None, performs the count over all
the dimensions of the input array. `axis` may be negative, in
which case it counts from the last to the first axis.
.. versionadded:: 1.10.0
If this is a tuple of ints, the count is performed on multiple
axes, instead of a single axis or all the axes as before.
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 array.
Returns
-------
result : ndarray or scalar
An array with the same shape as the input array, with the specified
axis removed. If the array is a 0-d array, or if `axis` is None, a
scalar is returned.
See Also
--------
ma.count_masked : Count masked elements in array or along a given axis.
Examples
--------
>>> import numpy.ma as ma
>>> a = ma.arange(6).reshape((2, 3))
>>> a[1, :] = ma.masked
>>> a
masked_array(
data=[[0, 1, 2],
[--, --, --]],
mask=[[False, False, False],
[ True, True, True]],
fill_value=999999)
>>> a.count()
3
When the `axis` keyword is specified an array of appropriate size is
returned.
>>> a.count(axis=0)
array([1, 1, 1])
>>> a.count(axis=1)
array([3, 0])
r� r r� �Nr )r� r� r� NF)r r� c s g | ]\}}|� vr|�qS r� r� )r� r rt ��axesr� r� r� � s �z%MaskedArray.count.<locals>.<listcomp>r �r� r )r� r rB r r? Zmatrixr� r� r� r r> r2 Z AxisErrorr� r r r� Zintpr rD � enumerater ru r� ) rJ r� r� rs r� �items�axZout_dimsr, r� rl r� r? � s8 8
zMaskedArray.countr� c C sT t j| j|d��t| ��}|�| � | jturJt j| j|d��|j �|_nt|_|S )a
Returns a 1D version of self, as a view.
Parameters
----------
order : {'C', 'F', 'A', 'K'}, optional
The elements of `a` are read using this index order. 'C' means to
index the elements in C-like order, with the last axis index
changing fastest, back to the first axis index changing slowest.
'F' means to index the elements in Fortran-like index order, with
the first index changing fastest, and the last index changing
slowest. Note that the 'C' and 'F' options take no account of the
memory layout of the underlying array, and only refer to the order
of axis indexing. 'A' means to read the elements in Fortran-like
index order if `m` is Fortran *contiguous* in memory, C-like order
otherwise. 'K' means to read the elements in the order they occur
in memory, except for reversing the data when strides are negative.
By default, 'C' index order is used.
Returns
-------
MaskedArray
Output view is of shape ``(self.size,)`` (or
``(np.ma.product(self.shape),)``).
Examples
--------
>>> x = np.ma.array([[1,2,3],[4,5,6],[7,8,9]], mask=[0] + [1,0]*4)
>>> x
masked_array(
data=[[1, --, 3],
[--, 5, --],
[7, --, 9]],
mask=[[False, True, False],
[ True, False, True],
[False, True, False]],
fill_value=999999)
>>> x.ravel()
masked_array(data=[1, --, 3, --, 5, --, 7, --, 9],
mask=[False, True, False, True, False, True, False, True,
False],
fill_value=999999)
�r� )
r r� r< r> r2 rq rB r� r� r� )rJ r� �rr� r� r� r� � s -
zMaskedArray.ravelc O s^ |j |�dd�d� | jj|i |���t| ��}|�| � | j}|turZ|j|i |��|_|S )a�
Give a new shape to the array without changing its data.
Returns a masked array containing the same data, but with a new shape.
The result is a view on the original array; if this is not possible, a
ValueError is raised.
Parameters
----------
shape : int or tuple of ints
The new shape should be compatible with the original shape. If an
integer is supplied, then the result will be a 1-D array of that
length.
order : {'C', 'F'}, optional
Determines whether the array data should be viewed as in C
(row-major) or FORTRAN (column-major) order.
Returns
-------
reshaped_array : array
A new view on the array.
See Also
--------
reshape : Equivalent function in the masked array module.
numpy.ndarray.reshape : Equivalent method on ndarray object.
numpy.reshape : Equivalent function in the NumPy module.
Notes
-----
The reshaping operation cannot guarantee that a copy will not be made,
to modify the shape in place, use ``a.shape = s``
Examples
--------
>>> x = np.ma.array([[1,2],[3,4]], mask=[1,0,0,1])
>>> x
masked_array(
data=[[--, 2],
[3, --]],
mask=[[ True, False],
[False, True]],
fill_value=999999)
>>> x = x.reshape((4,1))
>>> x
masked_array(
data=[[--],
[2],
[3],
[--]],
mask=[[ True],
[False],
[False],
[ True]],
fill_value=999999)
r� r� rr ) r� r r< r� r> r2 rq rB r� )rJ r� rs r- r@ r� r� r� r� s :
zMaskedArray.reshapec C s d}t |��dS )av
.. warning::
This method does nothing, except raise a ValueError exception. A
masked array does not own its data and therefore cannot safely be
resized in place. Use the `numpy.ma.resize` function instead.
This method is difficult to implement safely and may be deprecated in
future releases of NumPy.
zoA masked array does not own its data and therefore cannot be resized.
Use the numpy.ma.resize function instead.N)r# )rJ r� Zrefcheckr� �errmsgr� r� r� r� a s
zMaskedArray.resize�raisec C s� | j rT| jturT| j| }t|dd�}t|ddd�}|�|j� || }|| }| jj|||d� | jtu r�t|�tu r�dS t | �}t|�tu r�|j|d|d� n|j||j|d� t
|ddd�}|| _dS )aD
Set storage-indexed locations to corresponding values.
Sets self._data.flat[n] = values[n] for each n in indices.
If `values` is shorter than `indices` then it will repeat.
If `values` has some masked values, the initial mask is updated
in consequence, else the corresponding values are unmasked.
Parameters
----------
indices : 1-D array_like
Target indices, interpreted as integers.
values : array_like
Values to place in self._data copy at target indices.
mode : {'raise', 'wrap', 'clip'}, optional
Specifies how out-of-bounds indices will behave.
'raise' : raise an error.
'wrap' : wrap around.
'clip' : clip to the range.
Notes
-----
`values` can be a scalar or length 1 array.
Examples
--------
>>> x = np.ma.array([[1,2,3],[4,5,6],[7,8,9]], mask=[0] + [1,0]*4)
>>> x
masked_array(
data=[[1, --, 3],
[--, 5, --],
[7, --, 9]],
mask=[[False, True, False],
[ True, False, True],
[False, True, False]],
fill_value=999999)
>>> x.put([0,4,8],[10,20,30])
>>> x
masked_array(
data=[[10, --, 3],
[--, 20, --],
[7, --, 30]],
mask=[[False, True, False],
[ True, False, True],
[False, True, False]],
fill_value=999999)
>>> x.put(4,999)
>>> x
masked_array(
data=[[10, --, 3],
[--, 999, --],
[7, --, 30]],
mask=[[False, True, False],
[ True, False, True],
[False, True, False]],
fill_value=999999)
Fr� Tr: ��modeNr� ) r� rB r� r r� r� r< r� rW rX rq )rJ r_ �valuesrw r@ r� r� r� r� r� s s" =
zMaskedArray.putc C s, | j tu r| jjtt�fS | jj| j jjfS )a
Return the addresses of the data and mask areas.
Parameters
----------
None
Examples
--------
>>> x = np.ma.array([1, 2, 3], mask=[0, 1, 1])
>>> x.ids()
(166670640, 166659832) # may vary
If the array has no mask, the address of `nomask` is returned. This address
is typically not close to the data in memory:
>>> x = np.ma.array([1, 2, 3])
>>> x.ids()
(166691080, 3083169284) # may vary
)rB r� Zctypesr? �idrc r� r� r� r^ � s
zMaskedArray.idsc C s
| j d S )a�
Return a boolean indicating whether the data is contiguous.
Parameters
----------
None
Examples
--------
>>> x = np.ma.array([1, 2, 3])
>>> x.iscontiguous()
True
`iscontiguous` returns one of the flags of the masked array:
>>> x.flags
C_CONTIGUOUS : True
F_CONTIGUOUS : True
OWNDATA : False
WRITEABLE : True
ALIGNED : True
WRITEBACKIFCOPY : False
Z
CONTIGUOUS)r� rc r� r� r� � iscontiguous� s zMaskedArray.iscontiguousc C s� |t ju ri nd|i}t| j|fi |��}|du rt| �d�jf d|i|���t| ��}|jrh|� |� n|rpt
S |S | �d�jf ||d�|�� t |t �r�|js�|r�|� |� |S )a�
Returns True if all elements evaluate to True.
The output array is masked where all the values along the given axis
are masked: if the output would have been a scalar and that all the
values are masked, then the output is `masked`.
Refer to `numpy.all` for full documentation.
See Also
--------
numpy.ndarray.all : corresponding function for ndarrays
numpy.all : equivalent function
Examples
--------
>>> np.ma.array([1,2,3]).all()
True
>>> a = np.ma.array([1,2,3], mask=True)
>>> (a.all() is np.ma.masked)
True
r� NTr� r )
r� r r� rB rL r r> r2 r� r� ru r r �rJ r� r� r� rs r@ rt r� r� r� r � s $
zMaskedArray.allc C s� |t ju ri nd|i}t| j|fi |��}|du rt| �d�jf d|i|���t| ��}|jrh|� |� n|rpt
}|S | �d�jf ||d�|�� t |t �r�|js�|r�|� |� |S )aS
Returns True if any of the elements of `a` evaluate to True.
Masked values are considered as False during computation.
Refer to `numpy.any` for full documentation.
See Also
--------
numpy.ndarray.any : corresponding function for ndarrays
numpy.any : equivalent function
r� NFr� r )
r� r r� rB rL r r> r2 r� r� ru r r r{ r� r� r� r % s $
zMaskedArray.anyc C s t | �d�dd��� S )a�
Return the indices of unmasked elements that are not zero.
Returns a tuple of arrays, one for each dimension, containing the
indices of the non-zero elements in that dimension. The corresponding
non-zero values can be obtained with::
a[a.nonzero()]
To group the indices by element, rather than dimension, use
instead::
np.transpose(a.nonzero())
The result of this is always a 2d array, with a row for each non-zero
element.
Parameters
----------
None
Returns
-------
tuple_of_arrays : tuple
Indices of elements that are non-zero.
See Also
--------
numpy.nonzero :
Function operating on ndarrays.
flatnonzero :
Return indices that are non-zero in the flattened version of the input
array.
numpy.ndarray.nonzero :
Equivalent ndarray method.
count_nonzero :
Counts the number of non-zero elements in the input array.
Examples
--------
>>> import numpy.ma as ma
>>> x = ma.array(np.eye(3))
>>> x
masked_array(
data=[[1., 0., 0.],
[0., 1., 0.],
[0., 0., 1.]],
mask=False,
fill_value=1e+20)
>>> x.nonzero()
(array([0, 1, 2]), array([0, 1, 2]))
Masked elements are ignored.
>>> x[1, 1] = ma.masked
>>> x
masked_array(
data=[[1.0, 0.0, 0.0],
[0.0, --, 0.0],
[0.0, 0.0, 1.0]],
mask=[[False, False, False],
[False, True, False],
[False, False, False]],
fill_value=1e+20)
>>> x.nonzero()
(array([0, 2]), array([0, 2]))
Indices can also be grouped by element.
>>> np.transpose(x.nonzero())
array([[0, 0],
[2, 2]])
A common use for ``nonzero`` is to find the indices of an array, where
a condition is True. Given an array `a`, the condition `a` > 3 is a
boolean array and since False is interpreted as 0, ma.nonzero(a > 3)
yields the indices of the `a` where the condition is true.
>>> a = ma.array([[1,2,3],[4,5,6],[7,8,9]])
>>> a > 3
masked_array(
data=[[False, False, False],
[ True, True, True],
[ True, True, True]],
mask=False,
fill_value=True)
>>> ma.nonzero(a > 3)
(array([1, 1, 1, 2, 2, 2]), array([0, 1, 2, 0, 1, 2]))
The ``nonzero`` method of the condition array can also be called.
>>> (a > 3).nonzero()
(array([1, 1, 1, 2, 2, 2]), array([0, 1, 2, 0, 1, 2]))
r Fr� )r rL r� rc r� r� r� r� C s `zMaskedArray.nonzeror� c sZ | j }|tu r,t� j||||d�}|�|�S | j|||d�}|�|��d�jd|d�S dS )z8
(this docstring should be overwritten)
)�offset�axis1�axis2r� )r| r} r~ r r� r N)rB r� rf r� r rD rL r� ) rJ r| r} r~ r r� r� r- r� rk r� r� r� � s �
zMaskedArray.tracec C s t | |||d�S )a�
a.dot(b, out=None)
Masked dot product of two arrays. Note that `out` and `strict` are
located in different positions than in `ma.dot`. In order to
maintain compatibility with the functional version, it is
recommended that the optional arguments be treated as keyword only.
At some point that may be mandatory.
.. versionadded:: 1.10.0
Parameters
----------
b : masked_array_like
Inputs array.
out : masked_array, optional
Output argument. This must have the exact kind that would be
returned if it was not used. In particular, it must have the
right type, must be C-contiguous, and its dtype must be the
dtype that would be returned for `ma.dot(a,b)`. This is a
performance feature. Therefore, if these conditions are not
met, an exception is raised, instead of attempting to be
flexible.
strict : bool, optional
Whether masked data are propagated (True) or set to 0 (False)
for the computation. Default is False. Propagating the mask
means that if a masked value appears in a row or column, the
whole row or column is considered masked.
.. versionadded:: 1.10.2
See Also
--------
numpy.ma.dot : equivalent function
)r� �strict)�dot)rJ r� r� r r� r� r� r� � s %zMaskedArray.dotc C s� |t ju ri nd|i}| j}t||fi |��}|du r�| �d�j|fd|i|��}t|dd�} | r||�t| ��}|� |� n|r�t
}|S | �d�j|f||d�|��}t |t �r�t
|�}
|
tu r�t|j� }
|_||
_|S )aW
Return the sum of the array elements over the given axis.
Masked elements are set to 0 internally.
Refer to `numpy.sum` for full documentation.
See Also
--------
numpy.ndarray.sum : corresponding function for ndarrays
numpy.sum : equivalent function
Examples
--------
>>> x = np.ma.array([[1,2,3],[4,5,6],[7,8,9]], mask=[0] + [1,0]*4)
>>> x
masked_array(
data=[[1, --, 3],
[--, 5, --],
[7, --, 9]],
mask=[[False, True, False],
[ True, False, True],
[False, True, False]],
fill_value=999999)
>>> x.sum()
25
>>> x.sum(axis=1)
masked_array(data=[4, 5, 16],
mask=[False, False, False],
fill_value=999999)
>>> x.sum(axis=0)
masked_array(data=[8, 5, 12],
mask=[False, False, False],
fill_value=999999)
>>> print(type(x.sum(axis=0, dtype=np.int64)[0]))
<class 'numpy.int64'>
r� Nr r r� �r r� )r� r rB r� rL r� r� r> r2 r� ru r r rW r� rs r� r� � rJ r� r r� r� rs rB r� r- Zrndim�outmaskr� r� r� r� � s& '
zMaskedArray.sumc C sV | � d�j|||d�}|dur8t|t�r4|�| j� |S |�t| ��}|�| j� |S )a
Return the cumulative sum of the array elements over the given axis.
Masked values are set to 0 internally during the computation.
However, their position is saved, and the result will be masked at
the same locations.
Refer to `numpy.cumsum` for full documentation.
Notes
-----
The mask is lost if `out` is not a valid :class:`ma.MaskedArray` !
Arithmetic is modular when using integer types, and no error is
raised on overflow.
See Also
--------
numpy.ndarray.cumsum : corresponding function for ndarrays
numpy.cumsum : equivalent function
Examples
--------
>>> marr = np.ma.array(np.arange(10), mask=[0,0,0,1,1,1,0,0,0,0])
>>> marr.cumsum()
masked_array(data=[0, 1, 3, --, --, --, 9, 16, 24, 33],
mask=[False, False, False, True, True, True, False, False,
False, False],
fill_value=999999)
r �r� r r� N) rL rA r r r� r@ r> r2 rB �rJ r� r r� r- r� r� r� rA s
zMaskedArray.cumsumc C s� |t ju ri nd|i}| j}t||fi |��}|du r�| �d�j|fd|i|��}t|dd�} | r||�t| ��}|� |� n|r�t
}|S | �d�j|f||d�|��}t |t �r�t
|�}
|
tu r�t|j� }
|_||
_|S )a�
Return the product of the array elements over the given axis.
Masked elements are set to 1 internally for computation.
Refer to `numpy.prod` for full documentation.
Notes
-----
Arithmetic is modular when using integer types, and no error is raised
on overflow.
See Also
--------
numpy.ndarray.prod : corresponding function for ndarrays
numpy.prod : equivalent function
r� Nr� r r� r r� )r� r rB r� rL r� r� r> r2 r� ru r r rW r� rs r� r� r� r� r� r� r� B s&
zMaskedArray.prodc C sV | � d�j|||d�}|dur8t|t�r4|�| j� |S |�t| ��}|�| j� |S )a�
Return the cumulative product of the array elements over the given axis.
Masked values are set to 1 internally during the computation.
However, their position is saved, and the result will be masked at
the same locations.
Refer to `numpy.cumprod` for full documentation.
Notes
-----
The mask is lost if `out` is not a valid MaskedArray !
Arithmetic is modular when using integer types, and no error is
raised on overflow.
See Also
--------
numpy.ndarray.cumprod : corresponding function for ndarrays
numpy.cumprod : equivalent function
r� r� N)rL r@ r r r� rB r> r2 r� r� r� r� r@ l s
zMaskedArray.cumprodc
s� |t ju ri nd|i}| jtu r>t� jf ||d�|��d }nN| jf ||d�|��}| jf d|i|��}|jdkr�|dkr�t }n |d | }|dur�||_
t |t �r�t
|�} | tu r�t|j� } |_t
|�| _
|S |S )a�
Returns the average of the array elements along given axis.
Masked entries are ignored, and result elements which are not
finite will be masked.
Refer to `numpy.mean` for full documentation.
See Also
--------
numpy.ndarray.mean : corresponding function for ndarrays
numpy.mean : Equivalent function
numpy.ma.average : Weighted average.
Examples
--------
>>> a = np.ma.array([1,2,3], mask=[False, False, True])
>>> a
masked_array(data=[1, 2, --],
mask=[False, False, True],
fill_value=999999)
>>> a.mean()
1.5
r� rn r� r� r r� N)r� r rB r� rf r� r� r? r� ru r� r r rW rs )
rJ r� r r� r� rs r- Zdsum�cntr� rk r� r� r� � s"
zMaskedArray.meanc C s* | � ||�}|s| | S | t||� S dS )a�
Compute the anomalies (deviations from the arithmetic mean)
along the given axis.
Returns an array of anomalies, with the same shape as the input and
where the arithmetic mean is computed along the given axis.
Parameters
----------
axis : int, optional
Axis over which the anomalies are taken.
The default is to use the mean of the flattened array as reference.
dtype : dtype, optional
Type to use in computing the variance. For arrays of integer type
the default is float32; for arrays of float types it is the same as
the array type.
See Also
--------
mean : Compute the mean of the array.
Examples
--------
>>> a = np.ma.array([1,2,3])
>>> a.anom()
masked_array(data=[-1., 0., 1.],
mask=False,
fill_value=1e+20)
N)r� r )rJ r� r r� r� r� r� r � s zMaskedArray.anomc s� |t ju ri nd|i}| jtu rdt� jf ||||d�|��d }|dur`t|t�r\|�t� |S |S | j f d|i|��| }| | j
||dd� } t | �r�t �
| �d } n| | 9 } t| j|fi |��|��t| ��}
|
j�rt| jj|fi |��|d k�|
_|
�| � n^t|
��rdt}
|du�rdt|t��r<d |_|�d� n$|jjd
v �rXd } t| ��nt j |_|S |du�r�|
|_t|t��r�|�|
j � |S |
S ) au
Returns the variance of the array elements along given axis.
Masked entries are ignored, and result elements which are not
finite will be masked.
Refer to `numpy.var` for full documentation.
See Also
--------
numpy.ndarray.var : corresponding function for ndarrays
numpy.var : Equivalent function
r� )r� r r� �ddofr� Nr� T�r� r
r �biu�>Masked data information would be lost in one or more location.) r� r rB r� rf r� r r r� r? r� r rP r rF r� r> r2 r� rt r rq rW ru r� r r r re r@ ) rJ r� r r� r� r� rs r� r� Zdanom�dvarrt rk r� r� r� � sL
��
"
zMaskedArray.varc C s` |t ju ri nd|i}| j||||fi |��}|tur\|durTt j|d|dd� |S t|�}|S )a>
Returns the standard deviation of the array elements along given axis.
Masked entries are ignored.
Refer to `numpy.std` for full documentation.
See Also
--------
numpy.ndarray.std : corresponding function for ndarrays
numpy.std : Equivalent function
r� Ng �?r{ �r� r} )r� r r� ru r� r� )rJ r� r r� r� r� rs r� r� r� r� r� s zMaskedArray.stdc C sh | j j||d��t| ��}|jdkr8| j|_|�| � n
| jrBt}|du rN|S t|t �rd|�
| j� |S )a
Return each element rounded to the given number of decimals.
Refer to `numpy.around` for full documentation.
See Also
--------
numpy.ndarray.round : corresponding function for ndarrays
numpy.around : equivalent function
)�decimalsr� r N) r< r� r> r2 r� rB rq ru r r r� )rJ r� r� r- r� r� r� r� 7 s
zMaskedArray.roundc C sb |t ju rt| �}|du rH|r@t �| jt j�r6t j}qHt| �}nt| �}| � |�}|j
|||d�S )a!
Return an ndarray of indices that sort the array along the
specified axis. Masked values are filled beforehand to
`fill_value`.
Parameters
----------
axis : int, optional
Axis along which to sort. If None, the default, the flattened array
is used.
.. versionchanged:: 1.13.0
Previously, the default was documented to be -1, but that was
in error. At some future date, the default will change to -1, as
originally intended.
Until then, the axis should be given explicitly when
``arr.ndim > 1``, to avoid a FutureWarning.
kind : {'quicksort', 'mergesort', 'heapsort', 'stable'}, optional
The sorting algorithm used.
order : list, optional
When `a` is an array with fields defined, this argument specifies
which fields to compare first, second, etc. Not all fields need be
specified.
endwith : {True, False}, optional
Whether missing values (if any) should be treated as the largest values
(True) or the smallest values (False)
When the array contains unmasked values at the same extremes of the
datatype, the ordering of these values and the masked values is
undefined.
fill_value : scalar or None, optional
Value used internally for the masked values.
If ``fill_value`` is not None, it supersedes ``endwith``.
Returns
-------
index_array : ndarray, int
Array of indices that sort `a` along the specified axis.
In other words, ``a[index_array]`` yields a sorted `a`.
See Also
--------
ma.MaskedArray.sort : Describes sorting algorithms used.
lexsort : Indirect stable sort with multiple keys.
numpy.ndarray.sort : Inplace sort.
Notes
-----
See `sort` for notes on the different sorting algorithms.
Examples
--------
>>> a = np.ma.array([3,2,1], mask=[False, False, True])
>>> a
masked_array(data=[3, 2, --],
mask=[False, False, True],
fill_value=999999)
>>> a.argsort()
array([1, 0, 2])
N�r� r r� ) r� r r� r� r r� re r� r� rL r+ )rJ r� r r� �endwithr' rL r� r� r� r+ P s @
zMaskedArray.argsortr� c C sF |du rt | �}| �|��t�}|tju r.dnt|�}|j|||d�S )a<
Return array of indices to the minimum values along the given axis.
Parameters
----------
axis : {None, integer}
If None, the index is into the flattened array, otherwise along
the specified axis
fill_value : scalar or None, optional
Value used to fill in the masked values. If None, the output of
minimum_fill_value(self._data) is used instead.
out : {None, array}, optional
Array into which the result can be placed. Its type is preserved
and it must be of the right shape to hold the output.
Returns
-------
ndarray or scalar
If multi-dimension input, returns a new ndarray of indices to the
minimum values along the given axis. Otherwise, returns a scalar
of index to the minimum values along the given axis.
Examples
--------
>>> x = np.ma.array(np.arange(4), mask=[1,1,0,0])
>>> x.shape = (2,2)
>>> x
masked_array(
data=[[--, --],
[2, 3]],
mask=[[ True, True],
[False, False]],
fill_value=999999)
>>> x.argmin(axis=0, fill_value=-1)
array([0, 0])
>>> x.argmin(axis=0, fill_value=9)
array([1, 1])
NF�r� r� )r� rL r> r r� r r� r* �rJ r� r' r� r� rt r� r� r� r* � s
)zMaskedArray.argminc C sH |du rt | j�}| �|��t�}|tju r0dnt|�}|j|||d�S )a�
Returns array of indices of the maximum values along the given axis.
Masked values are treated as if they had the value fill_value.
Parameters
----------
axis : {None, integer}
If None, the index is into the flattened array, otherwise along
the specified axis
fill_value : scalar or None, optional
Value used to fill in the masked values. If None, the output of
maximum_fill_value(self._data) is used instead.
out : {None, array}, optional
Array into which the result can be placed. Its type is preserved
and it must be of the right shape to hold the output.
Returns
-------
index_array : {integer_array}
Examples
--------
>>> a = np.arange(6).reshape(2,3)
>>> a.argmax()
5
>>> a.argmax(0)
array([1, 1, 1])
>>> a.argmax(1)
array([2, 2])
NFr� ) r� r< rL r> r r� r r� r) r� r� r� r� r) � s
!
zMaskedArray.argmaxr� c C sX | j tu r tj| |||d� dS | tu r,dS | j|||||d�}tj| ||d�| d< dS )a
Sort the array, in-place
Parameters
----------
a : array_like
Array to be sorted.
axis : int, optional
Axis along which to sort. If None, the array is flattened before
sorting. The default is -1, which sorts along the last axis.
kind : {'quicksort', 'mergesort', 'heapsort', 'stable'}, optional
The sorting algorithm used.
order : list, optional
When `a` is a structured array, this argument specifies which fields
to compare first, second, and so on. This list does not need to
include all of the fields.
endwith : {True, False}, optional
Whether missing values (if any) should be treated as the largest values
(True) or the smallest values (False)
When the array contains unmasked values sorting at the same extremes of the
datatype, the ordering of these values and the masked values is
undefined.
fill_value : scalar or None, optional
Value used internally for the masked values.
If ``fill_value`` is not None, it supersedes ``endwith``.
Returns
-------
sorted_array : ndarray
Array of the same type and shape as `a`.
See Also
--------
numpy.ndarray.sort : Method to sort an array in-place.
argsort : Indirect sort.
lexsort : Indirect stable sort on multiple keys.
searchsorted : Find elements in a sorted array.
Notes
-----
See ``sort`` for notes on the different sorting algorithms.
Examples
--------
>>> a = np.ma.array([1, 2, 5, 4, 3],mask=[0, 1, 0, 1, 0])
>>> # Default
>>> a.sort()
>>> a
masked_array(data=[1, 3, 5, --, --],
mask=[False, False, False, True, True],
fill_value=999999)
>>> a = np.ma.array([1, 2, 5, 4, 3],mask=[0, 1, 0, 1, 0])
>>> # Put missing values in the front
>>> a.sort(endwith=False)
>>> a
masked_array(data=[--, --, 1, 3, 5],
mask=[ True, True, False, False, False],
fill_value=999999)
>>> a = np.ma.array([1, 2, 5, 4, 3],mask=[0, 1, 0, 1, 0])
>>> # fill_value takes over endwith
>>> a.sort(endwith=False, fill_value=3)
>>> a
masked_array(data=[1, --, --, 3, 5],
mask=[False, True, True, False, False],
fill_value=999999)
r� N)r� r r� r' r� r .)rB r� r r� ru r+ r� Ztake_along_axis)rJ r� r r� r� r' Zsidxr� r� r� r� � s G
�zMaskedArray.sortc C s |t ju ri nd|i}| j}t||fi |��}|du r>t| �}|du r�| �|�jf ||d�|���t| ��}|j r�|�
|� |j r�t j ||j |d� n|r�t
}|S | �|�jf ||d�|��}t|t�r�t|�} | tu r�t|j� } |_|| _n,|jjdv �r
d}
t|
��t j |t j|d� |S )a4
Return the minimum along a given axis.
Parameters
----------
axis : None or int or tuple of ints, optional
Axis along which to operate. By default, ``axis`` is None and the
flattened input is used.
.. versionadded:: 1.7.0
If this is a tuple of ints, the minimum is selected over multiple
axes, instead of a single axis or all the axes as before.
out : array_like, optional
Alternative output array in which to place the result. Must be of
the same shape and buffer length as the expected output.
fill_value : scalar or None, optional
Value used to fill in the masked values.
If None, use the output of `minimum_fill_value`.
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 array.
Returns
-------
amin : array_like
New array holding the result.
If ``out`` was specified, ``out`` is returned.
See Also
--------
ma.minimum_fill_value
Returns the minimum filling value for a given datatype.
r� Nr ro r� r� )r� r rB r� r� rL r� r> r2 r� r� rp r' ru r r rW r� rs r� r� r r r re � rJ r� r� r' r� rs rB r� r- r� rt r� r� r� r� I s> # ���
zMaskedArray.minc C s t jdtdd� t�| |�S )a=
Return the array minimum along the specified axis.
.. deprecated:: 1.13.0
This function is identical to both:
* ``self.min(keepdims=True, axis=axis).squeeze(axis=axis)``
* ``np.ma.minimum.reduce(self, axis=axis)``
Typically though, ``self.min(axis=axis)`` is sufficient.
Parameters
----------
axis : int, optional
The axis along which to find the minima. Default is None, in which case
the minimum value in the whole array is returned.
Returns
-------
min : scalar or MaskedArray
If `axis` is None, the result is a scalar. Otherwise, if `axis` is
given and the array is at least 2-D, the result is a masked array with
dimension one smaller than the array on which `mini` is called.
Examples
--------
>>> x = np.ma.array(np.arange(6), mask=[0 ,1, 0, 0, 0 ,1]).reshape(3, 2)
>>> x
masked_array(
data=[[0, --],
[2, 3],
[4, --]],
mask=[[False, True],
[False, False],
[False, True]],
fill_value=999999)
>>> x.mini()
masked_array(data=0,
mask=False,
fill_value=999999)
>>> x.mini(axis=0)
masked_array(data=[0, 3],
mask=[False, False],
fill_value=999999)
>>> x.mini(axis=1)
masked_array(data=[0, 2, 4],
mask=[False, False, False],
fill_value=999999)
There is a small difference between `mini` and `min`:
>>> x[:,1].mini(axis=0)
masked_array(data=3,
mask=False,
fill_value=999999)
>>> x[:,1].min(axis=0)
3
zL`mini` is deprecated; use the `min` method or `np.ma.minimum.reduce instead.r
r� )r� r� r r� r )rJ r� r� r� r� �mini� s
=�zMaskedArray.minic C s |t ju ri nd|i}| j}t||fi |��}|du r>t| �}|du r�| �|�jf ||d�|���t| ��}|j r�|�
|� |j r�t j ||j |d� n|r�t
}|S | �|�jf ||d�|��}t|t�r�t|�} | tu r�t|j� } |_|| _n,|jjdv �r
d}
t|
��t j |t j|d� |S )a4
Return the maximum along a given axis.
Parameters
----------
axis : None or int or tuple of ints, optional
Axis along which to operate. By default, ``axis`` is None and the
flattened input is used.
.. versionadded:: 1.7.0
If this is a tuple of ints, the maximum is selected over multiple
axes, instead of a single axis or all the axes as before.
out : array_like, optional
Alternative output array in which to place the result. Must
be of the same shape and buffer length as the expected output.
fill_value : scalar or None, optional
Value used to fill in the masked values.
If None, use the output of maximum_fill_value().
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 array.
Returns
-------
amax : array_like
New array holding the result.
If ``out`` was specified, ``out`` is returned.
See Also
--------
ma.maximum_fill_value
Returns the maximum filling value for a given datatype.
r� Nr ro r� r� )r� r rB r� r� rL r� r> r2 r� r� rp r' ru r r rW r� rs r� r� r r r re r� r� r� r� r� � s> # ���
zMaskedArray.maxc C sj |du r0| j |||d�}|| j|||d�8 }|S | j ||||d�|_| j|||d�}tj|||dd� |S )a�
Return (maximum - minimum) along the given dimension
(i.e. peak-to-peak value).
.. warning::
`ptp` preserves the data type of the array. This means the
return value for an input of signed integers with n bits
(e.g. `np.int8`, `np.int16`, etc) is also a signed integer
with n bits. In that case, peak-to-peak values greater than
``2**(n-1)-1`` will be returned as negative values. An example
with a work-around is shown below.
Parameters
----------
axis : {None, int}, optional
Axis along which to find the peaks. If None (default) the
flattened array is used.
out : {None, array_like}, 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.
fill_value : scalar or None, optional
Value used to fill in the masked values.
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 array.
Returns
-------
ptp : ndarray.
A new array holding the result, unless ``out`` was
specified, in which case a reference to ``out`` is returned.
Examples
--------
>>> x = np.ma.MaskedArray([[4, 9, 2, 10],
... [6, 9, 7, 12]])
>>> x.ptp(axis=1)
masked_array(data=[8, 6],
mask=False,
fill_value=999999)
>>> x.ptp(axis=0)
masked_array(data=[2, 0, 5, 2],
mask=False,
fill_value=999999)
>>> x.ptp()
10
This example shows that a negative value can be returned when
the input is an array of signed integers.
>>> y = np.ma.MaskedArray([[1, 127],
... [0, 127],
... [-1, 127],
... [-2, 127]], dtype=np.int8)
>>> y.ptp(axis=1)
masked_array(data=[ 126, 127, -128, -127],
mask=False,
fill_value=999999,
dtype=int8)
A work-around is to use the `view()` method to view the result as
unsigned integers with the same bit width:
>>> y.ptp(axis=1).view(np.uint8)
masked_array(data=[126, 127, 128, 129],
mask=False,
fill_value=999999,
dtype=uint8)
N)r� r' r� )r� r� r' r� r{ r� )r� r� r� r� r� )rJ r� r� r' r� r- Z min_valuer� r� r� r� s K�
�
��zMaskedArray.ptpc s, t jd| jj� d�dd� t� j|i |��S )Nz3Warning: 'partition' will ignore the 'mask' of the r r
r� )r� r� rl r� rf � partition�rJ rr rs rk r� r� r� p s ��zMaskedArray.partitionc s, t jd| jj� d�dd� t� j|i |��S )Nz6Warning: 'argpartition' will ignore the 'mask' of the r r
r� )r� r� rl r� rf � argpartitionr� rk r� r� r� v s ��zMaskedArray.argpartitionc
C s� | j | j }}t| �}t|�}|tur0|�d�}|du rT|j|||d�d �|�}ntj|||||d� t |t
�r�|tu r�|} n|j|||d�} | |O } |� | � |d S )z
r N)r� rw .)r� rw r� r� ) r< rB r2 rW r� rL r� r> r� r r r� )
rJ r_ r� r� rw r< rB r8 Z maskindicesr� r� r� r� r� | s
zMaskedArray.taker; rD �flattenr� r� r� c C s | � � S r� )r� rc r� r� r� �<lambda>� r� zMaskedArray.<lambda>r� c C s� | j }|tu r| j�� S |dur.| �|��� S | jj}|rr| j�dd� |D ��}|D ]}d|| || < qT|�� S |tu r�dgS | j}t j
| j� � t d�}d||� � < ||_|�� S )aP
Return the data portion of the masked array as a hierarchical Python list.
Data items are converted to the nearest compatible Python type.
Masked values are converted to `fill_value`. If `fill_value` is None,
the corresponding entries in the output list will be ``None``.
Parameters
----------
fill_value : scalar, optional
The value to use for invalid entries. Default is None.
Returns
-------
result : list
The Python list representation of the masked array.
Examples
--------
>>> x = np.ma.array([[1,2,3], [4,5,6], [7,8,9]], mask=[0] + [1,0]*4)
>>> x.tolist()
[[1, None, 3], [None, 5, None], [7, None, 9]]
>>> x.tolist(-999)
[[1, -999, 3], [-999, 5, -999], [7, -999, 9]]
Nc S s g | ] }|t f�qS r� )r$ r� r� r� r� r� � r� z&MaskedArray.tolist.<locals>.<listcomp>r )
rB r� r< �tolistrL r r r r� r� r r� r$ )rJ r' rB r r- r r� r� r� r� r� � s$
zMaskedArray.tolistc C s t jdtdd� | j||d�S )z�
A compatibility alias for `tobytes`, with exactly the same behavior.
Despite its name, it returns `bytes` not `str`\ s.
.. deprecated:: 1.19.0
z0tostring() is deprecated. Use tobytes() instead.r
r� rr )r� r� r �tobytes�rJ r' r� r� r� r� �tostring� s
�zMaskedArray.tostringc C s | � |�j|d�S )a�
Return the array data as a string containing the raw bytes in the array.
The array is filled with a fill value before the string conversion.
.. versionadded:: 1.9.0
Parameters
----------
fill_value : scalar, optional
Value used to fill in the masked values. Default is None, in which
case `MaskedArray.fill_value` is used.
order : {'C','F','A'}, optional
Order of the data item in the copy. Default is 'C'.
- 'C' -- C order (row major).
- 'F' -- Fortran order (column major).
- 'A' -- Any, current order of array.
- None -- Same as 'A'.
See Also
--------
numpy.ndarray.tobytes
tolist, tofile
Notes
-----
As for `ndarray.tobytes`, information about the shape, dtype, etc.,
but also about `fill_value`, will be lost.
Examples
--------
>>> x = np.ma.array(np.array([[1, 2], [3, 4]]), mask=[[0, 1], [1, 0]])
>>> x.tobytes()
b'\x01\x00\x00\x00\x00\x00\x00\x00?B\x0f\x00\x00\x00\x00\x00?B\x0f\x00\x00\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00'
rr )rL r� r� r� r� r� r� � s &zMaskedArray.tobytesr� �%sc C s t d��dS )z�
Save a masked array to a file in binary format.
.. warning::
This function is not implemented yet.
Raises
------
NotImplementedError
When `tofile` is called.
z)MaskedArray.tofile() not implemented yet.Nr )rJ Zfid�sepr1 r� r� r� �tofile
s
zMaskedArray.tofilec C s\ | j }| j}|du r t| j|�}| jj }tj| jd|fd|fgd�}| j|d< | j|d< |S )a�
Transforms a masked array into a flexible-type array.
The flexible type array that is returned will have two fields:
* the ``_data`` field stores the ``_data`` part of the array.
* the ``_mask`` field stores the ``_mask`` part of the array.
Parameters
----------
None
Returns
-------
record : ndarray
A new flexible-type `ndarray` with two fields: the first element
containing a value, the second element containing the corresponding
mask boolean. The returned record shape matches self.shape.
Notes
-----
A side-effect of transforming a masked array into a flexible `ndarray` is
that meta information (``fill_value``, ...) will be lost.
Examples
--------
>>> x = np.ma.array([[1,2,3],[4,5,6],[7,8,9]], mask=[0] + [1,0]*4)
>>> x
masked_array(
data=[[1, --, 3],
[--, 5, --],
[7, --, 9]],
mask=[[False, True, False],
[ True, False, True],
[False, True, False]],
fill_value=999999)
>>> x.toflex()
array([[(1, False), (2, True), (3, False)],
[(4, True), (5, False), (6, True)],
[(7, False), (8, True), (9, False)]],
dtype=[('_data', '<i8'), ('_mask', '?')])
Nr< rB )r� r )r rB rs r� r� r r< )rJ ZddtyperB r� �recordr� r� r� �toflex s - �
zMaskedArray.toflexc s2 d| j j }t� �� d }|t| ��|�| jf S )zWReturn the internal state of the masked array, for pickling
purposes.
ZCFr
)r� Zfncrf �
__reduce__rX r� r� )rJ �cfZ
data_staterk r� r� � __getstate__V s zMaskedArray.__getstate__c sH |\}}}}}}}t � �||||f� | j�|t|�||f� || _dS )ak Restore the internal state of the masked array, for
pickling purposes. ``state`` is typically the output of the
``__getstate__`` output, and is a 5-tuple:
- class name
- a tuple giving the shape of the data
- a typecode for the data
- a binary string for the data
- a binary string for the mask.
N)rf � __setstate__rB rr r' ) rJ �stater� Zshp�typZisf�rawZmskZflvrk r� r� r� _ s zMaskedArray.__setstate__c C s t | j| jddf| �� fS )z6Return a 3-tuple for pickling a MaskedArray.
)r r� )�_mareconstructrl r� r� rc r� r� r� r� p s �zMaskedArray.__reduce__c C s` ddl m} tjt| �| dd�}|d u r,i }||t| �< | j�� D ]\}}|||�|j|< qB|S )Nr )�deepcopyTr� )r; r� r r� r2 ry r� rp )rJ �memor� Zcopiedr� �vr� r� r� � __deepcopy__x s zMaskedArray.__deepcopy__)N)NNN)F)N)N)NN)r� )TF)ru )r r r� NN)NF)NNN)NNN)NN)r N)NNN)NNN)r� NNTN)N)NNNF)NNru )N)Nr� )Nr� )r� r� )N)�r� r� r� r� r; r� Z _defaultmaskZ_defaulthardmaskr r� r! r" r� rq r r r> r� r� �propertyr �setterr� r� Z _set_maskr@ r r[ r� r� r r r� r r r< r? r� r' r r. �fsetr� rL r7 r6 r& rd r� r= rA rE rG rI rJ rK rL rM rN rP rQ rS rT rU rV rW rX rZ r[ r\ ra rb rc rf rg rh Zget_imagrj Zget_realr� r r? r� r� r� r� r^ rz r r r� r� r� r� rA r� r� r@ r� r r� r� r� r+ r* r) r� r� r� r� r� r� r� r� r� r; rD r� r� r� r� �Tr� r� r� r� r� r� Z torecordsr� r� r� r� rw r� r� rk r� r �
sD d�
]
8
Z~F
E
+
(
P
H T@
c
6B
U( b
'>
)(
/
%�>
�
�
P� /� ' �
SF
CF
X
3
(
: r c C s2 t �|||�}t �t |t|��}| j| |||d�S )zbInternal function that builds a new MaskedArray from the
information stored in a pickle.
)r@ r )r r� rr )r r Z baseshape�basetyper< rB r� r� r� r� � s r� c s| e Zd ZdZedddddfdd�Ze� fdd��Zd d
� Zd d � Z � fd
d�Z
e
Z dd� Z dd� Z
ddd�Zdd� Z� ZS )r� zN
Fake a 'void' object to use for masked array with structured dtypes.
NFTc
C s� t j||||d�}|�| �}||_|tur~t|t j�r>||_n@zt �|�|_W n. ty| t |�} t j|| d�d |_Y n0 |d ur�||_
|S )N)r; r; r r r� ) r� r r> r� r� r r" rB r� rr r' )
rJ r? r@ r r' r� r; r; r< r� r� r� r� r� � s
z
mvoid.__new__c s t � jd S )Nr� )rf r< rc rk r� r� r< � s z mvoid._datac C sT | j }t|| t�r6t| j| || | j| | jd�S |turJ|| rJtS | j| S )z!
Get the index.
)r? r@ r' r� ) rB r r rv r< r� r� r� ru )rJ r� r� r� r� r� r� � s �zmvoid.__getitem__c C sB || j |< | jr,| j| t|dd�O < nt|dd�| j|< d S )NrB F)r< r� rB r� )rJ r� r� r� r� r� r� � s
zmvoid.__setitem__c sN | j }|tu rt| j�S t| jjd�}t� j}|�|�}t|| j t � t|�S )Nr� )
rB r� r r< r� r rf r r� r� )rJ r� r% Zdata_arrr$ rk r� r� rd � s
z
mvoid.__str__c c sL | j | j }}|tu r"|E dH n&t||�D ]\}}|r@tV q,|V q,dS )z Defines an iterator for mvoidN)r< rB r� r ru )rJ r< rB rt r� r� r� r� r� � s zmvoid.__iter__c C s
| j �� S r� )r< �__len__rc r� r� r� r� � s z
mvoid.__len__c C s t | ��|�d S )aA
Return a copy with masked fields filled with a given value.
Parameters
----------
fill_value : array_like, optional
The value to use for invalid entries. Can be scalar or
non-scalar. If latter is the case, the filled array should
be broadcastable over input array. Default is None, in
which case the `fill_value` attribute is used instead.
Returns
-------
filled_void
A `np.void` object
See Also
--------
MaskedArray.filled
r� )r. rL )rJ r' r� r� r� rL � s z mvoid.filledc C sZ | j }|tu r| j�� S g }t| j| j �D ]&\}}|rB|�d� q*|�|�� � q*t|�S )z�
Transforms the mvoid object into a tuple.
Masked fields are replaced by None.
Returns
-------
returned_tuple
Tuple of fields
N)rB r� r< r� r r r r )rJ rB r- rt r� r� r� r� r� � s
z mvoid.tolist)N)r� r� r� r� r� r� r� r< r� r� rd r� r� r� rL r� rw r� r� rk r� r� � s �
r� c C s
t | t�S )a�
Test whether input is an instance of MaskedArray.
This function returns True if `x` is an instance of MaskedArray
and returns False otherwise. Any object is accepted as input.
Parameters
----------
x : object
Object to test.
Returns
-------
result : bool
True if `x` is a MaskedArray.
See Also
--------
isMA : Alias to isMaskedArray.
isarray : Alias to isMaskedArray.
Examples
--------
>>> import numpy.ma as ma
>>> a = np.eye(3, 3)
>>> a
array([[ 1., 0., 0.],
[ 0., 1., 0.],
[ 0., 0., 1.]])
>>> m = ma.masked_values(a, 0)
>>> m
masked_array(
data=[[1.0, --, --],
[--, 1.0, --],
[--, --, 1.0]],
mask=[[False, True, True],
[ True, False, True],
[ True, True, False]],
fill_value=0.0)
>>> ma.isMaskedArray(a)
False
>>> ma.isMaskedArray(m)
True
>>> ma.isMaskedArray([0, 1, 2])
False
)r r �rR r� r� r� rc s 0rc c s� e Zd ZdZedd� �Zdd� Z� fdd�Zd dd �Zd d
d �Z d d
� Z
dd� Z dd� Z dd� Z
dd� Ze Z Z Z Z ZZ[dd� Zdd� Zdd� Z� fd d �Z� ZS ) r4 Nc C s | j d uot| j �| u S r� )�_MaskedConstant__singletonr2 )r8 r� r� r� Z__has_singletonT s z MaskedConstant.__has_singletonc C sF | � � s@t�d�}t�d�}d|j_d|j_t||d��| �| _| jS )Nr� TFr� )� _MaskedConstant__has_singletonr� r r� Z writeabler r> r� )r8 r? r@ r� r� r� r� Z s
zMaskedConstant.__new__c s6 | � � st� �|�S | | ju r nt| _t�| |� d S r� )r� rf r r� r rl )rJ r� rk r� r� r l s
z!MaskedConstant.__array_finalize__c C s | � t��||�S r� )r> r �__array_prepare__�rJ r� r r� r� r� r� z s z MaskedConstant.__array_prepare__c C s | � t��||�S r� )r> r r r� r� r� r� r } s z MaskedConstant.__array_wrap__c C s
t tj�S r� )r r� r� rc r� r� r� rd � s zMaskedConstant.__str__c C s | t ju rdS t�| �S d S )Nru )r4 r� r$ r� rc r� r� r� r� � s
zMaskedConstant.__repr__c C sB zt �| |�W S ty< tjdtdd� t �| d� Y S 0 d S )NzjFormat strings passed to MaskedConstant are ignored, but in future may error or produce different behaviorr
r� r� )r$ �
__format__r� r� r� �
FutureWarning)rJ � format_specr� r� r� r� � s �zMaskedConstant.__format__c C s
| j dfS )z.Override of MaskedArray's __reduce__.
r� rk rc r� r� r� r� � s zMaskedConstant.__reduce__c C s | S r� r� rD r� r� r� �__iop__� s zMaskedConstant.__iop__c O s | S )z: Copy is a no-op on the maskedconstant, as it is a scalar r� r� r� r� r� r; � s zMaskedConstant.copyc C s | S r� r� rc r� r� r� �__copy__� s zMaskedConstant.__copy__c C s | S r� r� )rJ r� r� r� r� r� � s zMaskedConstant.__deepcopy__c sD | � � st� �||�S | | ju r2td| �d���nt� �||�S d S )Nzattributes of z are not writeable)r� rf � __setattr__r� r= )rJ �attrr� rk r� r� r� � s
�zMaskedConstant.__setattr__)N)N)r� r� r� r� � classmethodr� r� r r� r rd r� r� r� r� rX rZ r[ ra rb rc r; r� r� r� rw r� r� rk r� r4 P s6
����r4 c
C s t | |||| ||||
||d� S )z~
Shortcut to MaskedArray.
The options are in a different order for convenience and backwards
compatibility.
)
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 � s
�r c C s$ t | �}|tu rdS |�� r dS dS )a
Determine whether input has masked values.
Accepts any object as input, but always returns False unless the
input is a MaskedArray containing masked values.
Parameters
----------
x : array_like
Array to check for masked values.
Returns
-------
result : bool
True if `x` is a MaskedArray with masked values, False otherwise.
Examples
--------
>>> import numpy.ma as ma
>>> x = ma.masked_equal([0, 1, 0, 2, 3], 0)
>>> x
masked_array(data=[--, 1, --, 2, 3],
mask=[ True, False, True, False, False],
fill_value=0)
>>> ma.is_masked(x)
True
>>> x = ma.masked_equal([0, 1, 0, 2, 3], 42)
>>> x
masked_array(data=[0, 1, 0, 2, 3],
mask=False,
fill_value=42)
>>> ma.is_masked(x)
False
Always returns False if `x` isn't a MaskedArray.
>>> x = [False, True, False]
>>> ma.is_masked(x)
False
>>> x = 'a string'
>>> ma.is_masked(x)
False
FT)rW r� r )rR r� r� r� r� re � s -re c s@ e Zd ZdZ� fdd�Zd dd�Zejfdd�Zd d
� Z � Z
S ) �_extrema_operationz�
Generic class for maximum/minimum functions.
.. note::
This is the base class for `_maximum_operation` and
`_minimum_operation`.
c s t � �|� || _|| _d S r� )rf rK r? �fill_value_func)rJ rb r? r' rk r� r� rK s z_extrema_operation.__init__Nc C sH |du r4t jd| j� d| j� d�tdd� | �|�S t| �||�||�S )rX Nz Single-argument form of np.ma.z is deprecated. Use np.ma.z.reduce instead.r
r� )r� r� r� r r r� r? rI r� r� r� rS ! s
��
z_extrema_operation.__call__c C s� t |ddd�}t|�}|tju rP|jdkrPtjd| j� d| j� d�tdd � d
}|tjurft |d �}nt � }|t
u r�| j j |fi |��}n\|�
| �|���t|��}| j j |fi |��}tjj |fi |��}t|d �r�||_n|r�t}|S )
z#Reduce target along the given axis.FTr: r� z!In the future the default for ma.z:.reduce will be axis=0, not the current None, to match np.z;.reduce. Explicitly pass 0 or None to silence this warning.r
r� Nr rB )r rW r� r r� r� r� r� r� r1 r� r� r rL r� r> r2 rP rm r rB ru )rJ r� r� r� rs r� r� r� r� r , s6
��
��
z_extrema_operation.reducec C sv t |�}t |�}|tu r&|tu r&t}n t|�}t|�}t�||�}| j�t|�t|��}t|t�sl|� t�}||_
|S )z<Return the function applied to the outer product of a and b.) rW r� rX ro r� r� rL r r r> rB )rJ r, r� r� r� r� r- r� r� r� r� L s
z_extrema_operation.outer)N) r� r� r� r� rK rS r� r r r� rw r� r� rk r� r� s
r� c C sh |t ju ri nd|i}z| jf |||d�|��W S ttfyb t| �jf |||d�|�� Y S 0 d S �Nr� �r� r' r� )r� r r� r= r� r- �r� r� r� r' r� rs r� r� r� r� \ s ��r� c C sh |t ju ri nd|i}z| jf |||d�|��W S ttfyb t| �jf |||d�|�� Y S 0 d S r� )r� r r� r= r� r- r� r� r� r� r� h s ��r� c C sh |t ju ri nd|i}z| j|f||d�|��W S ttfyb t| �jf |||d�|�� Y S 0 d S )Nr� )r� r' r� )r� r r� r= r� r- r� r� r� r� r� u s ��r� c @ s* e Zd ZdZd
dd�Zdd� Zdd� Zd S ) � _frommethodz�
Define functions from existing MaskedArray methods.
Parameters
----------
methodname : str
Name of the method to transform.
Fc C s || _ | �� | _|| _d S r� )r� �getdocr� �reversed)rJ Z
methodnamer� r� r� r� rK � s
z_frommethod.__init__c C sN t t| jd�pt t| jd�}| jt|� }|durJd|t |dd�f }|S dS )�<Return the doc of the function (from the doc of the method).Nz %s
%sr� )r� r r� r� r� )rJ �methZ signature�docr� r� r� r� � s � �z_frommethod.getdocc O sf | j r t|�}|d | }|d< t|�}| j}tt|�|d �}|d u rPtt|�}||g|�R i |��S rk )r� rD r- r� r� r2 r� )rJ r, rr r� ZmarrZ method_name�methodr� r� r� rS � s
z_frommethod.__call__N)F)r� r� r� r� rK r� rS r� r� r� r� r� � s
r� r r r r6 )r� r@ rA r; rD r[ r^ r� r� r� r� r� r� r� r� r� r� r� r� r? ru c C s t | �} | j||||d�S )z
)r� r� rw )rv r� )r, r_ r� r� rw r� r� r� r� � s r� c C s |durt d��t| �}t|�}t||�}t| �}t|�}t| t�rNt| �}nt}tjddd��, t� ||t
� ||��� |�} W d � n1 s�0 Y | �
| � t�t�| � t���}
|tur�| js�tS t�||
�| _|
�� �r| js�tS | jtu �r|
| _| j| j|
< | S )a>
Returns element-wise base array raised to power from second array.
This is the masked array version of `numpy.power`. For details see
`numpy.power`.
See Also
--------
numpy.power
Notes
-----
The *out* argument to `numpy.power` is not supported, `third` has to be
None.
Nz 3-argument power not supported.rM rn )r rW rt rV r r r2 r� rO r� rP r� r> rq rn rA r r� r� ru ro rB r r' r< ) r, r� �thirdr� r� r� �fa�fbr� r- rC r� r� r� r� � s2
:
r� r* r) c C sN t �| �} |t ju r t| �}t| t�r:| j|||||d�S | j|||d�S dS )z)Function version of the eponymous method.�r� r r� r� r' r� N)r� r- r r� r r r+ �r, r� r r� r� r' r� r� r� r+ s
�r+ r� c C sX t j| ddd�} |du r$| �� } d}t| t�rD| j|||||d� n| j|||d� | S )a
Return a sorted copy of the masked array.
Equivalent to creating a copy of the array
and applying the MaskedArray ``sort()`` method.
Refer to ``MaskedArray.sort`` for the full documentation
See Also
--------
MaskedArray.sort : equivalent method
Tr: Nr r� r� )r� r r� r r r� r� r� r� r� r� s
�r� c C s t | ��� S )a
Return all the non-masked data as a 1-D array.
This function is equivalent to calling the "compressed" method of a
`ma.MaskedArray`, see `ma.MaskedArray.compressed` for details.
See Also
--------
ma.MaskedArray.compressed : Equivalent method.
)r- r7 r� r� r� r� r7 2 s r7 c C sv t �dd� | D �|�}t| � }|�|�}| D ]}t|�tur, qFq,|S t �dd� | D �|�}|�|j�}t|�|_ |S )aI
Concatenate a sequence of arrays along the given axis.
Parameters
----------
arrays : sequence of array_like
The arrays must have the same shape, except in the dimension
corresponding to `axis` (the first, by default).
axis : int, optional
The axis along which the arrays will be joined. Default is 0.
Returns
-------
result : MaskedArray
The concatenated array with any masked entries preserved.
See Also
--------
numpy.concatenate : Equivalent function in the top-level NumPy module.
Examples
--------
>>> import numpy.ma as ma
>>> a = ma.arange(3)
>>> a[1] = ma.masked
>>> b = ma.arange(2, 5)
>>> a
masked_array(data=[0, --, 2],
mask=[False, True, False],
fill_value=999999)
>>> b
masked_array(data=[2, 3, 4],
mask=False,
fill_value=999999)
>>> ma.concatenate([a, b])
masked_array(data=[0, --, 2, 2, 3, 4],
mask=[False, True, False, False, False, False],
fill_value=999999)
c S s g | ] }t |��qS r� )rV r3 r� r� r� r� j r� z concatenate.<locals>.<listcomp>c S s g | ] }t |��qS r� r r3 r� r� r� r� t r� )
r� r8 r9 r> rW r� r� r� r� rB )r6 r� rt r7 r? rR �dmr� r� r� r8 A s )
r8 c C s2 t �| |��t�}t| �tur.t �| j|�|_|S )a
Extract a diagonal or construct a diagonal array.
This function is the equivalent of `numpy.diag` that takes masked
values into account, see `numpy.diag` for details.
See Also
--------
numpy.diag : Equivalent function for ndarrays.
)r� rC r> r rW r� rB )r� r� r� r� r� r� rC } s rC c C sJ t | �}|tu r(t�t| �|�}t|�S t�t| d�|�}t||d�S dS )z�
Shift the bits of an integer to the left.
This is the masked array version of `numpy.left_shift`, for details
see that function.
See Also
--------
numpy.left_shift
r r� N)rW r� rP rg rL rv �r, r r� rt r� r� r� rg � s rg c C sJ t | �}|tu r(t�t| �|�}t|�S t�t| d�|�}t||d�S dS )z�
Shift the bits of an integer to the right.
This is the masked array version of `numpy.right_shift`, for details
see that function.
See Also
--------
numpy.right_shift
r r� N)rW r� rP r� rL rv r� r� r� r� r� � s r� c C sB z| j |||d�W S ty< t| dd�j |||d� Y S 0 dS )z�
Set storage-indexed locations to corresponding values.
This function is equivalent to `MaskedArray.put`, see that method
for details.
See Also
--------
MaskedArray.put
rv Fr� N)r� r= r )r, r_ rx rw r� r� r� r� � s
r� c C s� t | t�s| �t�} t|�t|� }}t| �tu rd|tur�d| _t| j| j �| _
t j | j
||d� nZ| j
r�|tur�| j
�� }t j |||d� | j|O _n"|tu r�t|�}t j | j
||d� t j | j||d� dS )aQ
Changes elements of an array based on conditional and input values.
This is the masked array version of `numpy.putmask`, for details see
`numpy.putmask`.
See Also
--------
numpy.putmask
Notes
-----
Using a masked array as `values` will **not** transform a `ndarray` into
a `MaskedArray`.
Tro N)r r r> rV rW r� r� rs r� r rB r� rp r� r; r@ rX r< )r, r@ rx ZvaldataZvalmaskr� r� r� r� r� � s$
r� c C s< z | � |�W S ty6 t| dd�� |��t� Y S 0 dS )a�
Permute the dimensions of an array.
This function is exactly equivalent to `numpy.transpose`.
See Also
--------
numpy.transpose : Equivalent function in top-level NumPy module.
Examples
--------
>>> import numpy.ma as ma
>>> x = ma.arange(4).reshape((2,2))
>>> x[1, 1] = ma.masked
>>> x
masked_array(
data=[[0, 1],
[2, --]],
mask=[[False, False],
[False, True]],
fill_value=999999)
>>> ma.transpose(x)
masked_array(
data=[[0, 2],
[1, --]],
mask=[[False, False],
[False, True]],
fill_value=999999)
Fr� N)r� r= r r> r )r, rm r� r� r� r� � s r� r� c C sH z| j ||d�W S tyB t| dd�j ||d�}|�t� Y S 0 dS )z�
Returns an array containing the same data with a new shape.
Refer to `MaskedArray.reshape` for full documentation.
See Also
--------
MaskedArray.reshape : equivalent function
rr Fr� N)r� r= r r> r )r, � new_shaper� Z_tmpr� r� r� r� s
r� c C sB t | �}|tur t�||�}t�| |��t| ��}|jr>||_|S )a
Return a new masked array with the specified size and shape.
This is the masked equivalent of the `numpy.resize` function. The new
array is filled with repeated copies of `x` (in the order that the
data are stored in memory). If `x` is masked, the new array will be
masked, and the new mask will be a repetition of the old one.
See Also
--------
numpy.resize : Equivalent function in the top level NumPy module.
Examples
--------
>>> import numpy.ma as ma
>>> a = ma.array([[1, 2] ,[3, 4]])
>>> a[0, 1] = ma.masked
>>> a
masked_array(
data=[[1, --],
[3, 4]],
mask=[[False, True],
[False, False]],
fill_value=999999)
>>> np.resize(a, (3, 3))
masked_array(
data=[[1, 2, 3],
[4, 1, 2],
[3, 4, 1]],
mask=False,
fill_value=999999)
>>> ma.resize(a, (3, 3))
masked_array(
data=[[1, --, 3],
[4, 1, --],
[3, 4, 1]],
mask=[[False, True, False],
[False, False, True],
[False, False, False]],
fill_value=999999)
A MaskedArray is always returned, regardless of the input type.
>>> a = np.array([[1, 2] ,[3, 4]])
>>> ma.resize(a, (3, 3))
masked_array(
data=[[1, 2, 3],
[4, 1, 2],
[3, 4, 1]],
mask=False,
fill_value=999999)
)rW r� r� r� r> r9 r� rB )rR r� r� r- r� r� r� r� , s 7 r� c C s t �t| ��S )z5
maskedarray version of the numpy function.
)r� r� rV r
r� r� r� r� l s r� c C s t �t| ��S ��*maskedarray version of the numpy function.)r� r� rV r
r� r� r� r� v s r� c C s t �t| �|�S r� )r� r� rV )r� r� r� r� r� r� | s r� c C s |t u |t u f�d�}|dkr&td��|dkr6t| �S t| d�}t|�}t|�}t| �}t|�}t|�} |tu r�|tur�tj d|j
d�}tj d| j
d�}n0|tu r�|tur�tj d|j
d�}tj d|j
d�} t� |||�}
t� ||| �} t� |tj d| j
d�| �} t
| �} t|
| d�S ) a�
Return a masked array with elements from `x` or `y`, depending on condition.
.. note::
When only `condition` is provided, this function is identical to
`nonzero`. The rest of this documentation covers only the case where
all three arguments are provided.
Parameters
----------
condition : array_like, bool
Where True, yield `x`, otherwise yield `y`.
x, y : array_like, optional
Values from which to choose. `x`, `y` and `condition` need to be
broadcastable to some shape.
Returns
-------
out : MaskedArray
An masked array with `masked` elements where the condition is masked,
elements from `x` where `condition` is True, and elements from `y`
elsewhere.
See Also
--------
numpy.where : Equivalent function in the top-level NumPy module.
nonzero : The function that is called when x and y are omitted
Examples
--------
>>> x = np.ma.array(np.arange(9.).reshape(3, 3), mask=[[0, 1, 0],
... [1, 0, 1],
... [0, 1, 0]])
>>> x
masked_array(
data=[[0.0, --, 2.0],
[--, 4.0, --],
[6.0, --, 8.0]],
mask=[[False, True, False],
[ True, False, True],
[False, True, False]],
fill_value=1e+20)
>>> np.ma.where(x > 5, x, -3.1416)
masked_array(
data=[[-3.1416, --, -3.1416],
[--, -3.1416, --],
[6.0, --, 8.0]],
mask=[[False, True, False],
[ True, False, True],
[False, True, False]],
fill_value=1e+20)
Tr� z)Must provide both 'x' and 'y' or neither.r
Fr� r r� )r r? r# r� rL rV rX ru r� r� r r� r� r� rv ) r� rR r �missingr� ZxdZyd�cmZxmZymr? r@ r� r� r� r� � s, 8
r� c s� dd� � dd� �t | d�}�fdd�|D �}� fdd�|D �}tj|||d �}tt|t| ��d
d d �}tj||||d
��t�}|dur�t|t�r�|� |� |S |� |� |S )aH
Use an index array to construct a new array from a list of choices.
Given an array of integers and a list of n choice arrays, this method
will create a new array that merges each of the choice arrays. Where a
value in `index` is i, the new array will have the value that choices[i]
contains in the same place.
Parameters
----------
indices : ndarray of ints
This array must contain integers in ``[0, n-1]``, where n is the
number of choices.
choices : sequence of arrays
Choice arrays. The index array and all of the choices should be
broadcastable to the same shape.
out : array, optional
If provided, the result will be inserted into this array. It should
be of the appropriate shape and `dtype`.
mode : {'raise', 'wrap', 'clip'}, optional
Specifies how out-of-bounds indices will behave.
* 'raise' : raise an error
* 'wrap' : wrap around
* 'clip' : clip to the range
Returns
-------
merged_array : array
See Also
--------
choose : equivalent function
Examples
--------
>>> choice = np.array([[1,1,1], [2,2,2], [3,3,3]])
>>> a = np.array([2, 1, 0])
>>> np.ma.choose(a, choice)
masked_array(data=[3, 2, 1],
mask=False,
fill_value=999999)
c S s | t u r dS t| �S )z,Returns the filled array, or True if masked.T)ru rL r� r� r� r� �fmask s zchoose.<locals>.fmaskc S s | t u r dS t| �S )z:Returns the mask, True if ``masked``, False if ``nomask``.T)ru rW r� r� r� r� �nmask s zchoose.<locals>.nmaskr c s g | ] }� |��qS r� r� �r� rR )r� r� r� r� r� zchoose.<locals>.<listcomp>c s g | ] }� |��qS r� r� r� )r� r� r� r� r� rv FTr� )rw r� N)
rL r� r3 rq rt rW r> r r r� ) r_ �choicesr� rw r� Zmasksr? Z
outputmaskrt r� )r� r� r� r3 � s -
�
r3 c C sD |du rt �| ||�S t �t| �||� t|d�r<t| �|_|S dS )a�
Return a copy of a, rounded to 'decimals' places.
When 'decimals' is negative, it specifies the number of positions
to the left of the decimal point. The real and imaginary parts of
complex numbers are rounded separately. Nothing is done if the
array is not of float type and 'decimals' is greater than or equal
to 0.
Parameters
----------
decimals : int
Number of decimals to round to. May be negative.
out : array_like
Existing array to use for output.
If not given, returns a default copy of a.
Notes
-----
If out is given and does not have a mask attribute, the mask of a
is lost!
NrB )r� r� rV r rW rB )r, r� r� r� r� r� r� - s
r� c C s� t | dd�} | jdkr td��t| �}|tu s6|�� s:| S |�� }| j�� | _|sdt | t
� |d �< |dv r�t | dd�t
� |d �f< | S ) a�
Mask rows and/or columns of a 2D array that contain masked values.
Mask whole rows and/or columns of a 2D array that contain
masked values. The masking behavior is selected using the
`axis` parameter.
- If `axis` is None, rows *and* columns are masked.
- If `axis` is 0, only rows are masked.
- If `axis` is 1 or -1, only columns are masked.
Parameters
----------
a : array_like, MaskedArray
The array to mask. If not a MaskedArray instance (or if no array
elements are masked). The result is a MaskedArray with `mask` set
to `nomask` (False). Must be a 2D array.
axis : int, optional
Axis along which to perform the operation. If None, applies to a
flattened version of the array.
Returns
-------
a : MaskedArray
A modified version of the input array, masked depending on the value
of the `axis` parameter.
Raises
------
NotImplementedError
If input array `a` is not 2D.
See Also
--------
mask_rows : Mask rows of a 2D array that contain masked values.
mask_cols : Mask cols of a 2D array that contain masked values.
masked_where : Mask where a condition is met.
Notes
-----
The input array's mask is modified by this function.
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_rowcols(a)
masked_array(
data=[[0, --, 0],
[--, --, --],
[0, --, 0]],
mask=[[False, True, False],
[ True, True, True],
[False, True, False]],
fill_value=1)
Fr> r
z&mask_rowcols works for 2D arrays only.r )Nr� r� Nr� ) r r� r rW r� r r� rB r; ru r� �unique)r, r� r� Z maskedvalr� r� r� � mask_rowcolsQ s I
r� c C s |r,| j dkr,|j dkr,t| d�} t|d�}t| � }t|� }|du r�t�t| d�t|d��}t�||� }|j dkr�t�|�}|�t| |��}|� |� |S t�t| d�t|d�|j
�}|j j |j kr�t�
|j t�|_t�|||j� t�|j|j� |S dS )a�
Return the dot product of two arrays.
This function is the equivalent of `numpy.dot` that takes masked values
into account. Note that `strict` and `out` are in different position
than in the method version. In order to maintain compatibility with the
corresponding method, it is recommended that the optional arguments be
treated as keyword only. At some point that may be mandatory.
.. note::
Works only with 2-D arrays at the moment.
Parameters
----------
a, b : masked_array_like
Inputs arrays.
strict : bool, optional
Whether masked data are propagated (True) or set to 0 (False) for
the computation. Default is False. Propagating the mask means that
if a masked value appears in a row or column, the whole row or
column is considered masked.
out : masked_array, optional
Output argument. This must have the exact kind that would be returned
if it was not used. In particular, it must have the right type, must be
C-contiguous, and its dtype must be the dtype that would be returned
for `dot(a,b)`. This is a performance feature. Therefore, if these
conditions are not met, an exception is raised, instead of attempting
to be flexible.
.. versionadded:: 1.10.2
See Also
--------
numpy.dot : Equivalent function for ndarrays.
Examples
--------
>>> a = np.ma.array([[1, 2, 3], [4, 5, 6]], mask=[[1, 0, 0], [0, 0, 0]])
>>> b = np.ma.array([[1, 2], [3, 4], [5, 6]], mask=[[1, 0], [0, 0], [0, 0]])
>>> np.ma.dot(a, b)
masked_array(
data=[[21, 26],
[45, 64]],
mask=[[False, False],
[False, False]],
fill_value=999999)
>>> np.ma.dot(a, b, strict=True)
masked_array(
data=[[--, --],
[--, 64]],
mask=[[ True, True],
[ True, False]],
fill_value=999999)
r
r r� N)r� r� rX r� r� rL r. r> r9 r� r< r@ r� rG r rB rn ) r, r� r r� �amZbmrt r� rs r� r� r� r� � s& ;
r� c C sF t | d�}t |d�}|jdkr$d|_|jdkr4d|_t�||��t�S )z�
Returns the inner product of a and b for arrays of floating point types.
Like the generic NumPy equivalent the product sum is over the last dimension
of a and b. The first argument is not conjugated.
r r� )rL r� r� r� r` r> r )r, r� r� r� r� r� r� r` � s
r` z Masked values are replaced by 0.c C s� t | d��� }t |d��� }t�||�}t| �}t|�}|tu rP|tu rPt|�S t| �}t|�}tdt�d| d| � dd�}t||d�S )r� r r� Fr� r� ) rL r� r� r� rW r� rv rX rq )r, r� r� r� rt r� r� r� r� r� r� r� s r� c C s� |r`| t |�tjt�|�td�|d�| tjt�|�td�t |�|d�B }| t|�t|�|d�}n2| t |� t |� � }| t|d�t|d�|d�}t||d�S )z:
Helper function for ma.correlate and ma.convolve
r rv r r� )rX r� r� r� r� rV rL rv )r� r, r� rw �propagate_maskr@ r? r� r� r� �_convolve_or_correlate% s ��r� �validc C s t tj| |||�S )a�
Cross-correlation of two 1-dimensional sequences.
Parameters
----------
a, v : array_like
Input sequences.
mode : {'valid', 'same', 'full'}, optional
Refer to the `np.convolve` docstring. Note that the default
is 'valid', unlike `convolve`, which uses 'full'.
propagate_mask : bool
If True, then a result element is masked if any masked element contributes towards it.
If False, then a result element is only masked if no non-masked element
contribute towards it
Returns
-------
out : MaskedArray
Discrete cross-correlation of `a` and `v`.
See Also
--------
numpy.correlate : Equivalent function in the top-level NumPy module.
)r� r� r< �r, r� rw r� r� r� r� r< 8 s r< r c C s t tj| |||�S )a�
Returns the discrete, linear convolution of two one-dimensional sequences.
Parameters
----------
a, v : array_like
Input sequences.
mode : {'valid', 'same', 'full'}, optional
Refer to the `np.convolve` docstring.
propagate_mask : bool
If True, then if any masked element is included in the sum for a result
element, then the result is masked.
If False, then the result element is only masked if no non-masked cells
contribute towards it
Returns
-------
out : MaskedArray
Discrete, linear convolution of `a` and `v`.
See Also
--------
numpy.convolve : Equivalent function in the top-level NumPy module.
)r� r� r: r� r� r� r� r: T s r: c C s� t t| �t|��}|tu r>t| �}t|�}t�||�}|�� S |r|t| �}t|�}t�||�}t||dd�}|�d��d�S dS dS )a
Return True if all entries of a and b are equal, using
fill_value as a truth value where either or both are masked.
Parameters
----------
a, b : array_like
Input arrays to compare.
fill_value : bool, optional
Whether masked values in a or b are considered equal (True) or not
(False).
Returns
-------
y : bool
Returns True if the two arrays are equal within the given
tolerance, False otherwise. If either array contains NaN,
then False is returned.
See Also
--------
all, any
numpy.ma.allclose
Examples
--------
>>> a = np.ma.array([1e10, 1e-7, 42.0], mask=[0, 0, 1])
>>> a
masked_array(data=[10000000000.0, 1e-07, --],
mask=[False, False, True],
fill_value=1e+20)
>>> b = np.array([1e10, 1e-7, -42.0])
>>> b
array([ 1.00000000e+10, 1.00000000e-07, -4.20000000e+01])
>>> np.ma.allequal(a, b, fill_value=False)
False
>>> np.ma.allequal(a, b)
True
F)r@ r; TN) rt rW r� rV rP rI r r rL )r, r� r' r� rR r rt r� r� r� r� r p s * r c C s, t | dd�}t |dd�}|jjdkrHt�|d�}|j|krHt ||dd�}tt|�t|��}t�t |d|d���d�} t� | tt�|�d�k�s�dS t�
| �s�tt t || �||t |� �|�}
t� |
�S t� t|| || k|��s�dS || }|| }tt t || �||t |� �|�}
t� |
�S )aL
Returns True if two arrays are element-wise equal within a tolerance.
This function is equivalent to `allclose` except that masked values
are treated as equal (default) or unequal, depending on the `masked_equal`
argument.
Parameters
----------
a, b : array_like
Input arrays to compare.
masked_equal : bool, optional
Whether masked values in `a` and `b` are considered equal (True) or not
(False). They are considered equal by default.
rtol : float, optional
Relative tolerance. The relative difference is equal to ``rtol * b``.
Default is 1e-5.
atol : float, optional
Absolute tolerance. The absolute difference is equal to `atol`.
Default is 1e-8.
Returns
-------
y : bool
Returns True if the two arrays are equal within the given
tolerance, False otherwise. If either array contains NaN, then
False is returned.
See Also
--------
all, any
numpy.allclose : the non-masked `allclose`.
Notes
-----
If the following equation is element-wise True, then `allclose` returns
True::
absolute(`a` - `b`) <= (`atol` + `rtol` * absolute(`b`))
Return True if all elements of `a` and `b` are equal subject to
given tolerances.
Examples
--------
>>> a = np.ma.array([1e10, 1e-7, 42.0], mask=[0, 0, 1])
>>> a
masked_array(data=[10000000000.0, 1e-07, --],
mask=[False, False, True],
fill_value=1e+20)
>>> b = np.ma.array([1e10, 1e-8, -42.0], mask=[0, 0, 1])
>>> np.ma.allclose(a, b)
False
>>> a = np.ma.array([1e10, 1e-8, 42.0], mask=[0, 0, 1])
>>> b = np.ma.array([1.00001e10, 1e-9, -42.0], mask=[0, 0, 1])
>>> np.ma.allclose(a, b)
True
>>> np.ma.allclose(a, b, masked_equal=False)
False
Masked values are not compared directly.
>>> a = np.ma.array([1e10, 1e-8, 42.0], mask=[0, 0, 1])
>>> b = np.ma.array([1.00001e10, 1e-9, 42.0], mask=[0, 0, 1])
>>> np.ma.allclose(a, b)
True
>>> np.ma.allclose(a, b, masked_equal=False)
False
Fr� r� r� )r r; )r; r@ )
rv r r r� Z result_typert rW ZisinfrL r r ri r ) r, r� rw r� r� rR r r r� Zxinfrt r� r� r� r � s. H
�
�r c C s |pd}t | |ddd|d�S )a�
Convert the input to a masked array of the given data-type.
No copy is performed if the input is already an `ndarray`. If `a` is
a subclass of `MaskedArray`, a base class `MaskedArray` is returned.
Parameters
----------
a : array_like
Input data, in any form that can be converted to a masked array. This
includes lists, lists of tuples, tuples, tuples of tuples, tuples
of lists, ndarrays and masked arrays.
dtype : dtype, optional
By default, the data-type is inferred from the input data.
order : {'C', 'F'}, optional
Whether to use row-major ('C') or column-major ('FORTRAN') memory
representation. Default is 'C'.
Returns
-------
out : MaskedArray
Masked array interpretation of `a`.
See Also
--------
asanyarray : Similar to `asarray`, but conserves subclasses.
Examples
--------
>>> x = np.arange(10.).reshape(2, 5)
>>> x
array([[0., 1., 2., 3., 4.],
[5., 6., 7., 8., 9.]])
>>> np.ma.asarray(x)
masked_array(
data=[[0., 1., 2., 3., 4.],
[5., 6., 7., 8., 9.]],
mask=False,
fill_value=1e+20)
>>> type(np.ma.asarray(x))
<class 'numpy.ma.core.MaskedArray'>
r� FT)r r; r� r; r� �rv )r, r r� r� r� r� r. s ,
�r. c C s2 t | t�r |du s || jkr | S t| |dddd�S )ae
Convert the input to a masked array, conserving subclasses.
If `a` is a subclass of `MaskedArray`, its class is conserved.
No copy is performed if the input is already an `ndarray`.
Parameters
----------
a : array_like
Input data, in any form that can be converted to an array.
dtype : dtype, optional
By default, the data-type is inferred from the input data.
order : {'C', 'F'}, optional
Whether to use row-major ('C') or column-major ('FORTRAN') memory
representation. Default is 'C'.
Returns
-------
out : MaskedArray
MaskedArray interpretation of `a`.
See Also
--------
asarray : Similar to `asanyarray`, but does not conserve subclass.
Examples
--------
>>> x = np.arange(10.).reshape(2, 5)
>>> x
array([[0., 1., 2., 3., 4.],
[5., 6., 7., 8., 9.]])
>>> np.ma.asanyarray(x)
masked_array(
data=[[0., 1., 2., 3., 4.],
[5., 6., 7., 8., 9.]],
mask=False,
fill_value=1e+20)
>>> type(np.ma.asanyarray(x))
<class 'numpy.ma.core.MaskedArray'>
NFT)r r; r� r; )r r r rv )r, r r� r� r� r- G s , r- c C s" t jd| � d| � d�tdd� d S )Nznp.ma.z is deprecated, use pickle.z insteadr� r� )r� r� r )r� r� r� r� � _pickle_warn| s �r� r� c C s t d��d S )Nz1fromfile() not yet implemented for a MaskedArray.r )�filer r? r� r� r� r� �fromfile� s �r� c C s t | d | d d�S )a�
Build a masked array from a suitable flexible-type array.
The input array has to have a data-type with ``_data`` and ``_mask``
fields. This type of array is output by `MaskedArray.toflex`.
Parameters
----------
fxarray : ndarray
The structured input array, containing ``_data`` and ``_mask``
fields. If present, other fields are discarded.
Returns
-------
result : MaskedArray
The constructed masked array.
See Also
--------
MaskedArray.toflex : Build a flexible-type array from a masked array.
Examples
--------
>>> x = np.ma.array(np.arange(9).reshape(3, 3), mask=[0] + [1, 0] * 4)
>>> rec = x.toflex()
>>> rec
array([[(0, False), (1, True), (2, False)],
[(3, True), (4, False), (5, True)],
[(6, False), (7, True), (8, False)]],
dtype=[('_data', '<i8'), ('_mask', '?')])
>>> x2 = np.ma.fromflex(rec)
>>> x2
masked_array(
data=[[0, --, 2],
[--, 4, --],
[6, --, 8]],
mask=[[False, True, False],
[ True, False, True],
[False, True, False]],
fill_value=999999)
Extra fields can be present in the structured array but are discarded:
>>> dt = [('_data', '<i4'), ('_mask', '|b1'), ('field3', '<f4')]
>>> rec2 = np.zeros((2, 2), dtype=dt)
>>> rec2
array([[(0, False, 0.), (0, False, 0.)],
[(0, False, 0.), (0, False, 0.)]],
dtype=[('_data', '<i4'), ('_mask', '?'), ('field3', '<f4')])
>>> y = np.ma.fromflex(rec2)
>>> y
masked_array(
data=[[0, 0],
[0, 0]],
mask=[[False, False],
[False, False]],
fill_value=999999,
dtype=int32)
r< rB r� r� )Zfxarrayr� r� r� rT � s =rT c @ s6 e Zd ZdZdZd dd�Zdd� Zdd� Zd d
� ZdS ) � _convert2maz�
Convert functions from numpy to numpy.ma.
Parameters
----------
_methodname : string
Name of the method to transform.
Nc C s( t t|�| _| �||�| _|p i | _d S r� )r� r� �_funcr� r� �_extras)rJ r� �np_ret� np_ma_retr� r� r� r� rK � s z_convert2ma.__init__c C sJ t | jdd�}t| j�}|rF| �|||�}|r>d| jj|f }|| }|S )r� r� Nz%s%s
)r� r� r� �_replace_return_typer� )rJ r� r� r� r� r� r� r� r� � s
z_convert2ma.getdocc C sD ||vr8t d|� d|� d|� d| jj� d| jj� d� ��|�||�S )a
Replace documentation of ``np`` function's return type.
Replaces it with the proper type for the ``np.ma`` function.
Parameters
----------
doc : str
The documentation of the ``np`` method.
np_ret : str
The return type string of the ``np`` method that we want to
replace. (e.g. "out : ndarray")
np_ma_ret : str
The return type string of the ``np.ma`` method.
(e.g. "out : MaskedArray")
zFailed to replace `z` with `z-`. The documentation string for return type, z(, is not found in the docstring for `np.z `. Fix the docstring for `np.z0` or update the expected string for return type.)r r� r� �replace)rJ r� r� r� r� r� r� r� � s ����z _convert2ma._replace_return_typec O sx | j }t|��|�}|D ]}|�|�||< q| jj|i |���t�}d|v rZ|�dd �|_ d|v rtt
|�dd��|_ |S )Nr' r� r� F) r� �set� intersection�popr� rS r> r r r' r� r� )rJ rr r� r� Z
common_params�pr- r� r� r� rS s z_convert2ma.__call__)N)r� r� r� r� rK r� r� rS r� r� r� r� r� � s
r� r! )r' r� zarange : ndarrayzarange : MaskedArray)r� r� r� r4 zclipped_array : ndarrayzclipped_array : MaskedArrayrE zdiff : ndarrayzdiff : MaskedArrayrG z
out : ndarrayzout : MaskedArrayrH )r� r� rS zout: MaskedArrayrU zfromfunction : anyzfromfunction: MaskedArrayr] r_ z'grid : one ndarray or tuple of ndarraysz/grid : one MaskedArray or tuple of MaskedArraysr� r� r� zsqueezed : ndarrayzsqueezed : MaskedArrayr� r� c C s t | |g|�S )a Append values to the end of an array.
.. versionadded:: 1.9.0
Parameters
----------
a : array_like
Values are appended to a copy of this array.
b : array_like
These values are appended to a copy of `a`. It must be of the
correct shape (the same shape as `a`, excluding `axis`). If `axis`
is not specified, `b` can be any shape and will be flattened
before use.
axis : int, optional
The axis along which `v` are appended. If `axis` is not given,
both `a` and `b` are flattened before use.
Returns
-------
append : MaskedArray
A copy of `a` with `b` appended to `axis`. Note that `append`
does not occur in-place: a new array is allocated and filled. If
`axis` is None, the result is a flattened array.
See Also
--------
numpy.append : Equivalent function in the top-level NumPy module.
Examples
--------
>>> import numpy.ma as ma
>>> a = ma.masked_values([1, 2, 3], 2)
>>> b = ma.masked_values([[4, 5, 6], [7, 8, 9]], 7)
>>> ma.append(a, b)
masked_array(data=[1, --, 3, 4, 5, 6, --, 8, 9],
mask=[False, True, False, False, False, False, True, False,
False],
fill_value=999999)
)r8 )r, r� r� r� r� r� r c s (r )N)T)N)FT)T)T)T)T)T)T)T)T)T)TT)r� r� TT)T)T)NNru )N)r� NNTN)r )r )ru )N)r� )N)Nru )r N)N)FN)r� T)r T)T)Tr� r� )NN)N)N( r� rE r� rB r� �textwrapr� � functoolsr Znumpyr� Znumpy.core.umathr5 rP Znumpy.core.numerictypesZ numerictypesZntypesr r r r r r r r Znumpy.lib.function_baser
Z numpy.compatr r r
r r r Znumpy.core.numericr �__all__r r� r� r� r� r� r� r~ r r r
r� Z
datetime64Z timedelta64ZhalfZsingleZdoubleZ
longdoubleZcsingleZcdoubleZ clongdoubleZfloat_types_listZ_minvalsr r� Z_maxvalsr r� r rB r r� r� r r* r� r. r5 rL r9 rV �get_datarM rG ri rj rH rU rY r\ r` ra re rx r� rJ r9 r� r= r& r% r� r> r� r r rK r� rP r2 r� r, rn r� rj rl rk r� r$ r" r# r( r r� r� r' rI r� ri rZ rh rY rm r ro r� rp r/ r0 r1 r\ rF r� rQ r� rR r� r� r� rr rW Zget_maskrX rd r� rq rs r� rt rN r� r� rx ry r| r} r~ rw rz r� r r� r{ r� r� r� r1 �dedentr6 r� rO r� r� r r� r� rc rf rb r4 ru r� rv re r� r� r� r� r� r r r r r6 r@ rA r; rD r[ r^ r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r? r� r� r* r) r+ r� r7 r8 rC rg r� r� r� r� r� r� r� r� r� r� r3 r� r� r� r` ra r� r� r� r< r: r r r. r- r� r[ r� rT r� r! r4 rE rG rH rS rU r] r_ r� r� r� r� r� r r� r� r� r� �<module> s* $ � �
733 ,A
9 3:
J L
���������
��� !;5D
Y 2
88 z ( ( D P /0�"7 -l
3t
�
:I
) 3
< ' & @
[K \R �
� :l15@J �
�
�
�
�
�
�
�
�
�
�
�
�
�
Mini Shell