argopy.utilities.is_indexbox#

is_indexbox(box: list, errors='raise')[source]#

Check if this array matches a 2d or 3d index box definition

Argopy expects one of the following 2 format to define an index box:

  • box = [lon_min, lon_max, lat_min, lat_max]

  • box = [lon_min, lon_max, lat_min, lat_max, datim_min, datim_max]

This function check for this format compliance.

Parameters:
  • box (list) –

  • errors (str, default='raise') –

Return type:

bool