finam.data.check_data_covers_domain#

finam.data.check_data_covers_domain(data, mask=None)[source]#

Check if the given data covers a domain defined by a mask on the same grid.

Parameters:

  • data (Any) – The given data array for a single time-step.

  • mask (None or bool or array of bool, optional) – Mask defining the target domain on the same grid as the data, by default None

Returns:

Whether the data covers the desired domain.

Return type:

bool

Raises:

ValueError – When mask is given and mask and data don’t share the same shape.