numpy.ma.core.mvoid

class documentation

class mvoid(MaskedArray):

Fake a 'void' object to use for masked array with structured dtypes.

Method	`__getitem__`	Get the index.
Method	`__iter__`	Defines an iterator for mvoid
Method	`__len__`	Undocumented
Method	`__new__`	Create a new masked array from scratch.
Method	`__setitem__`	x.__setitem__(i, y) <==> x[i]=y
Method	`__str__`	Undocumented
Method	`filled`	Return a copy with masked fields filled with a given value.
Method	`tolist`	Transforms the mvoid object into a tuple.
Property	`_data`	Undocumented

Inherited from MaskedArray:

Constant	`T`	Undocumented
Method	`__add__`	Add self to other, and return a new masked array.
Method	`__array_finalize__`	Finalizes the masked array.
Method	`__array_wrap__`	Special hook for ufuncs.
Method	`__deepcopy__`	Undocumented
Method	`__div__`	Divide other into self, and return a new masked array.
Method	`__eq__`	Check whether other equals self elementwise.
Method	`__float__`	Convert to float.
Method	`__floordiv__`	Divide other into self, and return a new masked array.
Method	`__getstate__`	Return the internal state of the masked array, for pickling purposes.
Method	`__iadd__`	Add other to self in-place.
Method	`__idiv__`	Divide self by other in-place.
Method	`__ifloordiv__`	Floor divide self by other in-place.
Method	`__imul__`	Multiply self by other in-place.
Method	`__int__`	Convert to int.
Method	`__ipow__`	Raise self to the power other, in place.
Method	`__isub__`	Subtract other from self in-place.
Method	`__itruediv__`	True divide self by other in-place.
Method	`__mul__`	Multiply self by other, and return a new masked array.
Method	`__ne__`	Check whether other does not equal self elementwise.
Method	`__pow__`	Raise self to the power other, masking the potential NaNs/Infs
Method	`__radd__`	Add other to self, and return a new masked array.
Method	`__reduce__`	Return a 3-tuple for pickling a MaskedArray.
Method	`__repr__`	Literal string representation.
Method	`__rfloordiv__`	Divide self into other, and return a new masked array.
Method	`__rmul__`	Multiply other by self, and return a new masked array.
Method	`__rpow__`	Raise other to the power self, masking the potential NaNs/Infs
Method	`__rsub__`	Subtract self from other, and return a new masked array.
Method	`__rtruediv__`	Divide self into other, and return a new masked array.
Method	`__setmask__`	Set the mask.
Method	`__setstate__`	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:
Method	`__sub__`	Subtract other from self, and return a new masked array.
Method	`__truediv__`	Divide other into self, and return a new masked array.
Method	`_comparison`	Compare self with other using operator.eq or operator.ne.
Method	`_delegate_binop`	Undocumented
Method	`_get_data`	Returns the underlying data, as a view of the masked array.
Method	`_insert_masked_print`	Replace masked values with masked_print_option, casting all innermost dtypes to object.
Method	`_update_from`	Copies some attributes of obj to self.
Method	`all`	Returns True if all elements evaluate to True.
Method	`anom`	Compute the anomalies (deviations from the arithmetic mean) along the given axis.
Method	`any`	Returns True if any of the elements of `a` evaluate to True.
Method	`argmax`	Returns array of indices of the maximum values along the given axis. Masked values are treated as if they had the value fill_value.
Method	`argmin`	Return array of indices to the minimum values along the given axis.
Method	`argpartition`	Undocumented
Method	`argsort`	Return an ndarray of indices that sort the array along the specified axis. Masked values are filled beforehand to `fill_value`.
Method	`compress`	Return `a` where condition is `True`.
Method	`compressed`	Return all the non-masked data as a 1-D array.
Method	`count`	Count the non-masked elements of the array along the given axis.
Method	`cumprod`	Return the cumulative product of the array elements over the given axis.
Method	`cumsum`	Return the cumulative sum of the array elements over the given axis.
Method	`dot`	a.dot(b, out=None)
Method	`dtype.setter`	Undocumented
Method	`fill_value.setter`	Undocumented
Method	`flat.setter`	Undocumented
Method	`harden_mask`	Force the mask to hard.
Method	`ids`	Return the addresses of the data and mask areas.
Method	`iscontiguous`	Return a boolean indicating whether the data is contiguous.
Method	`mask.setter`	Undocumented
Method	`max`	Return the maximum along a given axis.
Method	`mean`	Returns the average of the array elements along given axis.
Method	`min`	Return the minimum along a given axis.
Method	`mini`	Return the array minimum along the specified axis.
Method	`nonzero`	Return the indices of unmasked elements that are not zero.
Method	`partition`	Undocumented
Method	`prod`	Return the product of the array elements over the given axis.
Method	`ptp`	Return (maximum - minimum) along the given dimension (i.e. peak-to-peak value).
Method	`put`	Set storage-indexed locations to corresponding values.
Method	`ravel`	Returns a 1D version of self, as a view.
Method	`recordmask.setter`	Undocumented
Method	`reshape`	Give a new shape to the array without changing its data.
Method	`resize`
Method	`round`	Return each element rounded to the given number of decimals.
Method	`shape.setter`	Undocumented
Method	`shrink_mask`	Reduce a mask to nomask when possible.
Method	`soften_mask`	Force the mask to soft.
Method	`sort`	Sort the array, in-place
Method	`std`	Returns the standard deviation of the array elements along given axis.
Method	`sum`	Return the sum of the array elements over the given axis.
Method	`take`
Method	`tobytes`	Return the array data as a string containing the raw bytes in the array.
Method	`tofile`	Save a masked array to a file in binary format.
Method	`toflex`	Transforms a masked array into a flexible-type array.
Method	`tostring`	A compatibility alias for `tobytes`, with exactly the same behavior.
Method	`trace`	(this docstring should be overwritten)
Method	`unshare_mask`	Copy the mask and set the sharedmask flag to False.
Method	`var`	Returns the variance of the array elements along given axis.
Method	`view`	Return a view of the MaskedArray data.
Class Variable	`__array_priority__`	Undocumented
Class Variable	`_defaulthardmask`	Undocumented
Class Variable	`_print_width`	Undocumented
Class Variable	`_print_width_1d`	Undocumented
Class Variable	`copy`	Undocumented
Class Variable	`data`	Undocumented
Class Variable	`diagonal`	Undocumented
Class Variable	`flatten`	Undocumented
Class Variable	`repeat`	Undocumented
Class Variable	`squeeze`	Undocumented
Class Variable	`swapaxes`	Undocumented
Class Variable	`transpose`	Undocumented
Instance Variable	`_fill_value`	Undocumented
Instance Variable	`_hardmask`	Undocumented
Instance Variable	`_mask`	Undocumented
Instance Variable	`_sharedmask`	Undocumented
Instance Variable	`fill_value`	The filling value of the masked array is a scalar. When setting, None will set to a default based on the data type.
Property	`baseclass`	Class of the underlying data (read-only).
Property	`dtype`	Undocumented
Property	`flat`	Return a flat iterator, or set a flattened version of self to value.
Property	`hardmask`	Hardness of the mask
Property	`imag`	The imaginary part of the masked array.
Property	`mask`	Current mask.
Property	`real`	The real part of the masked array.
Property	`recordmask`	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:
Property	`shape`	Undocumented
Property	`sharedmask`	Share status of the mask (read-only).

def __getitem__(self, indx):

overrides numpy.ma.core.MaskedArray.__getitem__

Get the index.

def __iter__(self):

Defines an iterator for mvoid

def __len__(self):

Undocumented

def __new__(self, data, mask=nomask, dtype=None, fill_value=None, hardmask=False, copy=False, subok=True):

overrides numpy.ma.core.MaskedArray.__new__

Create a new masked array from scratch.

Notes

A masked array can also be created by taking a .view(MaskedArray).

def __setitem__(self, indx, value):

overrides numpy.ma.core.MaskedArray.__setitem__

x.__setitem__(i, y) <==> x[i]=y

Set item described by index. If value is masked, masks those locations.

def __str__(self):

overrides numpy.ma.core.MaskedArray.__str__

Undocumented

def filled(self, fill_value=None):

overrides numpy.ma.core.MaskedArray.filled

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

Returns

returned_tuple: Tuple of fields

@property
_data =

overrides numpy.ma.core.MaskedArray._data

Undocumented

`numpy.ma.core.mvoid`

Notes

Parameters

Returns

See Also

Returns