fips.operators.convolve

fips.operators.convolve(state, forward_operator, round_index=None, verify_overlap=True)

Convolve a state vector with a forward operator matrix.

Parameters:

• state (Vector, pd.Series, or np.ndarray) – State vector to convolve. Can be a Vector, Series, or 1D array.

• forward_operator (ForwardOperator or pd.DataFrame) – Forward operator matrix to convolve with. Can be a ForwardOperator or a DataFrame.

• round_index (int, optional) – Number of decimal places to round indices for alignment. If None, no rounding is done.

• verify_overlap (bool, optional) – Whether to verify that the state index overlaps with the operator’s state index. Defaults to True.

Returns:

The convolved observation vector.

Return type:

pd.Series