fips.Block#

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

Bases: SingleBlockMixin, Structure1D

Single data block with a named Series and consistent index.

A Block wraps a pandas Series and can be initialized from an existing Series or from raw values.

Blocks are the fundamental building units of fips. Inverse problems can be customized by creating Blocks with specific indices and names to represent different state or observation components relevant to the application.

Parameters:
  • data (pd.Series, Block, or array-like) – Data for the block. If Block, creates a copy.

  • name (str, optional) – Name for the block. If None, uses data.name.

  • index (pd.Index, optional) – Index for the block. If None, uses data.index.

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

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

Methods

to_series([add_block_level])

Return the underlying Series data.

to_xarray()

Convert the Block to an xarray DataArray.

Inherited

From Structure1D: data, name

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

From Pickleable: from_file, to_file