finam.Info#

class finam.Info(time, grid, meta=None, **meta_kwargs)[source]#

Bases: object

Data info containing grid specification and metadata

Parameters:
  • grid (Grid or NoGrid or None) – grid specification

  • meta (dict) – dictionary of metadata

  • **meta_kwargs – additional metadata by name, will overwrite entries in meta

Variables:
  • grid (Grid or NoGrid or None) – grid specification

  • meta (dict) – dictionary of metadata

Attributes:
is_masked

bool: whether info indicates masked data (“_FillValue” or “missing_value” in meta).

Methods

accepts(incoming, fail_info[, ignore_none])

Tests whether this info can accept/is compatible with an incoming info

as_dict()

Returns a dict containing all metadata in this Info.

copy()

Copies the info object

copy_with([use_none])

Copies the info object and sets variables and meta values according to the kwargs

property is_masked#

whether info indicates masked data (“_FillValue” or “missing_value” in meta).

Type:

bool

copy()[source]#

Copies the info object

copy_with(use_none=True, **kwargs)[source]#

Copies the info object and sets variables and meta values according to the kwargs

Parameters:
  • use_none (bool) – whether properties with None value should also be transferred

  • **kwargs – key values pairs for properties to change

accepts(incoming, fail_info, ignore_none=False)[source]#

Tests whether this info can accept/is compatible with an incoming info

Parameters:
  • incoming (Info) – Incoming/source info to check. This is the info from upstream.

  • fail_info (dict) – Dictionary that will be filled with failed properties; name: (source, target).

  • ignore_none (bool) – Ignores None values in the incoming info.

Returns:

Whether the incoming info is accepted

Return type:

bool

as_dict()[source]#

Returns a dict containing all metadata in this Info.