fips.Vector#

class fips.Vector(data, name=None, index=None, dtype=None, copy=False)[source]#

Bases: MultiBlockMixin, Structure1D

State or observation vector composed of one or more Block objects.

A Vector organizes one or more Blocks (prior, posterior, observations, etc.) into a single hierarchical structure.

Vectors are used to represent the full state or observation space and are the 1D matrix components in the inversion framework.

Parameters:
  • data (pd.Series, Vector, Block, Sequence[Block | pd.Series], or array-like) – Data for the vector.

  • name (str, optional) – Name for the Vector.

  • index (pd.Index, optional) – Index for the Vector. If None, uses data.index. Index must have a ‘block’ level if data is a Series.

  • dtype (dtype, optional) – Data type to force.

  • copy (bool, default False) – Whether to copy the underlying data.

Attributes

blocks

Accessor for retrieving Block instances from the Vector.

data

The underlying data, which must be numeric and non-NaN.

Methods

to_xarray()

Convert the Vector to xarray.

Inherited

From Structure1D: name, to_series

From Structure: copy, reindex, round_index, shape, to_numpy, values, xs

From Pickleable: from_file, to_file