finam.data.GridBase#

class finam.data.GridBase[source]#

Bases: ABC

Abstract grid base.

Attributes:
data_shape

tuple: Shape of the associated data.

dim

int: Dimension of the grid or data.

name

Grid name.

Methods

copy([deep])

Copy of this grid.

from_canonical(data)

Convert canonical data to grid specific form.

get_transform_to(other)

Transformation between compatible grids.

to_canonical(data)

Convert grid specific data to canonical form.
property name#

Grid name.

abstract property dim#

Dimension of the grid or data.

Type:

int

abstract property data_shape#

Shape of the associated data.

Type:

tuple

copy(deep=False)[source]#

Copy of this grid.

Parameters:

deep (bool, optional) – If false, only a shallow copy is returned to save memory, by default False

Returns:

The grid copy.

Return type:

Grid

to_canonical(data)[source]#

Convert grid specific data to canonical form.

from_canonical(data)[source]#

Convert canonical data to grid specific form.

get_transform_to(other)[source]#

Transformation between compatible grids.