fips.operator#

Functions

convolve(forward_operator, state[, ...])

Convolve a forward_operator with a state field to get modeled observations.

Classes

ForwardOperator(data)

Forward operator class for modeling observations.
fips.operator.convolve(forward_operator, state, coord_decimals=6)[source]#

Convolve a forward_operator with a state field to get modeled observations.

Parameters:

  • forward_operator (pd.DataFrame) – DataFrame with columns corresponding to the state index and rows corresponding to the observation index.

  • state (pd.Series) – Series with rows corresponding to the state index.

  • coord_decimals (int, optional) – Number of decimal places to round coordinates to when matching indices, by default 6.

Returns:

Series with the same index as the forward_operator, containing the modeled observations.

Return type:

pd.Series

class fips.operator.ForwardOperator(data)[source]#

Forward operator class for modeling observations.

Parameters:

data (pd.DataFrame) – Forward operator matrix.

data#

Underlying forward operator matrix.

Type:

pd.DataFrame

obs_index#

Observation index (row index).

Type:

pd.Index

state_index#

State index (column index).

Type:

pd.Index

obs_dims#

Observation dimension names.

Type:

tuple

state_dims#

State dimension names.

Type:

tuple

convolve(state: pd.Series, coord_decimals: int = 6) → pd.Series[source]#

Convolve the forward operator with a state vector.

to_xarray() → xr.DataArray[source]#

Convert the forward operator to an xarray DataArray.

__init__(data)[source]#

Initialize the ForwardOperator.

Parameters:

data (pd.DataFrame) – Forward operator matrix.

property data: DataFrame#

Get the underlying data of the forward operator.

Returns:

Forward operator matrix.

Return type:

pd.DataFrame

property obs_index: Index#

Get the observation index (row index) of the forward operator.

Returns:

Observation index.

Return type:

pd.Index

property state_index: Index#

Get the state index (column index) of the forward operator.

Returns:

State index.

Return type:

pd.Index

property obs_dims: tuple#

Get the observation dimensions (names of the row index).

Returns:

Observation dimension names.

Return type:

tuple

property state_dims: tuple#

Get the state dimensions (names of the column index).

Returns:

State dimension names.

Return type:

tuple

convolve(state, coord_decimals=6)[source]#

Convolve the forward operator with a state vector.

Parameters:

  • state (pd.Series) – State vector.

  • coord_decimals (int, optional) – Number of decimal places to round coordinates to when matching indices, by default 6.

Returns:

Result of convolution.

Return type:

pd.Series

to_xarray()[source]#

Convert the forward operator to an xarray DataArray.

Returns:

Xarray representation of the forward operator.

Return type:

xr.DataArray