finam.data.masks_equal#

finam.data.masks_equal(this, other, this_grid=None, other_grid=None)[source]#

Check two masks for equality.

Parameters:

  • this (Mask value or valid boolean mask for Masked arrays or None) – first mask

  • other (Mask value or valid boolean mask for Masked arrays or None) – second mask

  • this_grid (Grid or NoGrid or None, optional) – grid for first mask (to check shape and value equality)

  • other_grid (Grid or NoGrid or None, optional) – grid for second mask (to check shape and value equality)

Returns:

mask equality

Return type:

bool