numpy.ma.core.MaskedIterator

class documentation

class MaskedIterator:

View In Hierarchy

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)
Method __getitem__ Undocumented
Method __init__ Undocumented
Method __iter__ Undocumented
Method __next__ Return the next value, or raise StopIteration.
Method __setitem__ Undocumented
Instance Variable dataiter Undocumented
Instance Variable ma Undocumented
Instance Variable maskiter Undocumented
def __getitem__(self, indx):

Undocumented

def __init__(self, ma):

Undocumented

def __iter__(self):

Undocumented

def __next__(self):

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
def __setitem__(self, index, value):

Undocumented

dataiter =

Undocumented

ma =

Undocumented

maskiter =

Undocumented