Skip to main content
Ctrl+K
fips 0.1.0b2 documentation - Home fips 0.1.0b2 documentation - Home
  • Installation
  • Getting Started
  • User Guide
  • Terminology & Notation
  • Examples
    • API Reference
  • GitHub
  • Installation
  • Getting Started
  • User Guide
  • Terminology & Notation
  • Examples
  • API Reference
  • GitHub

Section Navigation

  • Block Structures
    • fips.Block
    • fips.Block.name
    • fips.Block.data
    • fips.Block.index
    • fips.Block.copy
    • fips.Block.to_series
    • fips.Block.to_numpy
    • fips.Block.to_xarray
    • fips.Block.xs
    • fips.Block.reindex
    • fips.Block.round_index
    • fips.Block.from_file
    • fips.Block.to_file
    • fips.MatrixBlock
    • fips.MatrixBlock.name
    • fips.MatrixBlock.data
    • fips.MatrixBlock.row_block
    • fips.MatrixBlock.col_block
    • fips.MatrixBlock.index
    • fips.MatrixBlock.columns
    • fips.MatrixBlock.shape
    • fips.MatrixBlock.values
    • fips.MatrixBlock.copy
    • fips.MatrixBlock.to_frame
    • fips.MatrixBlock.to_numpy
    • fips.MatrixBlock.xs
    • fips.MatrixBlock.reindex
    • fips.MatrixBlock.round_index
    • fips.MatrixBlock.from_file
    • fips.MatrixBlock.to_file
    • fips.MatrixBlock.is_sparse
    • fips.MatrixBlock.to_sparse
    • fips.MatrixBlock.to_dense
  • Multi-Block Structures
    • fips.Vector
    • fips.Vector.name
    • fips.Vector.data
    • fips.Vector.index
    • fips.Vector.shape
    • fips.Vector.values
    • fips.Vector.blocks
    • fips.Vector.copy
    • fips.Vector.to_series
    • fips.Vector.to_numpy
    • fips.Vector.to_xarray
    • fips.Vector.__getitem__
    • fips.Vector.xs
    • fips.Vector.reindex
    • fips.Vector.round_index
    • fips.Vector.from_file
    • fips.Vector.to_file
    • fips.Matrix
    • fips.Matrix.name
    • fips.Matrix.data
    • fips.Matrix.index
    • fips.Matrix.columns
    • fips.Matrix.shape
    • fips.Matrix.values
    • fips.Matrix.copy
    • fips.Matrix.to_frame
    • fips.Matrix.to_numpy
    • fips.Matrix.__getitem__
    • fips.Matrix.xs
    • fips.Matrix.reindex
    • fips.Matrix.round_index
    • fips.Matrix.scale
    • fips.Matrix.__add__
    • fips.Matrix.from_file
    • fips.Matrix.to_file
    • fips.Matrix.is_sparse
    • fips.Matrix.to_sparse
    • fips.Matrix.to_dense
  • Operators
    • fips.ForwardOperator
    • fips.ForwardOperator.name
    • fips.ForwardOperator.data
    • fips.ForwardOperator.index
    • fips.ForwardOperator.obs_index
    • fips.ForwardOperator.columns
    • fips.ForwardOperator.state_index
    • fips.ForwardOperator.shape
    • fips.ForwardOperator.values
    • fips.ForwardOperator.blocks
    • fips.ForwardOperator.copy
    • fips.ForwardOperator.to_frame
    • fips.ForwardOperator.to_numpy
    • fips.ForwardOperator.xs
    • fips.ForwardOperator.reindex
    • fips.ForwardOperator.round_index
    • fips.ForwardOperator.from_file
    • fips.ForwardOperator.to_file
    • fips.ForwardOperator.is_sparse
    • fips.ForwardOperator.to_sparse
    • fips.ForwardOperator.to_dense
    • fips.ForwardOperator.convolve
    • fips.operators.convolve
  • Covariance Matrices
    • fips.CovarianceMatrix
    • fips.CovarianceMatrix.name
    • fips.CovarianceMatrix.data
    • fips.CovarianceMatrix.index
    • fips.CovarianceMatrix.columns
    • fips.CovarianceMatrix.shape
    • fips.CovarianceMatrix.values
    • fips.CovarianceMatrix.variances
    • fips.CovarianceMatrix.blocks
    • fips.CovarianceMatrix.copy
    • fips.CovarianceMatrix.to_frame
    • fips.CovarianceMatrix.to_numpy
    • fips.CovarianceMatrix.xs
    • fips.CovarianceMatrix.reindex
    • fips.CovarianceMatrix.round_index
    • fips.CovarianceMatrix.from_file
    • fips.CovarianceMatrix.to_file
    • fips.CovarianceMatrix.is_sparse
    • fips.CovarianceMatrix.to_sparse
    • fips.CovarianceMatrix.to_dense
    • fips.CovarianceMatrix.force_symmetry
    • fips.covariance.ErrorComponent
    • fips.covariance.DiagonalError
    • fips.covariance.BlockDecayError
    • fips.covariance.KroneckerError
    • fips.covariance.ErrorComponent.build
    • fips.covariance.ErrorComponent.__add__
    • fips.covariance.CovarianceBuilder
    • fips.covariance.CovarianceBuilder.build
    • fips.covariance.CovarianceBuilder.__add__
    • fips.covariance.CovarianceBuilder.__radd__
  • Inverse Problem
    • fips.InverseProblem
    • fips.InverseProblem.obs
    • fips.InverseProblem.prior
    • fips.InverseProblem.forward_operator
    • fips.InverseProblem.prior_error
    • fips.InverseProblem.modeldata_mismatch
    • fips.InverseProblem.constant
    • fips.InverseProblem.estimator
    • fips.InverseProblem.solve
    • fips.InverseProblem.posterior
    • fips.InverseProblem.posterior_error
    • fips.InverseProblem.prior_obs
    • fips.InverseProblem.posterior_obs
    • fips.InverseProblem.kalman_gain
    • fips.InverseProblem.averaging_kernel
    • fips.InverseProblem.get_block
    • fips.InverseProblem.from_file
    • fips.InverseProblem.to_file
  • Estimators
    • fips.Estimator.n_z
    • fips.Estimator.n_x
    • fips.Estimator.z
    • fips.Estimator.x_0
    • fips.Estimator.H
    • fips.Estimator.S_0
    • fips.Estimator.S_z
    • fips.Estimator.c
    • fips.Estimator.cost
    • fips.Estimator.forward
    • fips.Estimator.residual
    • fips.Estimator.leverage
    • fips.Estimator.x_hat
    • fips.Estimator.S_hat
    • fips.Estimator.y_hat
    • fips.Estimator.y_0
    • fips.Estimator.K
    • fips.Estimator.A
    • fips.Estimator.reduced_chi2
    • fips.Estimator.R2
    • fips.Estimator.RMSE
    • fips.Estimator.uncertainty_reduction
    • fips.Estimator.U_red
    • fips.estimators.BayesianSolver
    • fips.estimators.BayesianSolver.cost
    • fips.estimators.BayesianSolver.x_hat
    • fips.estimators.BayesianSolver.S_hat
  • Pipeline
    • fips.InversionPipeline
    • fips.InversionPipeline.get_obs
    • fips.InversionPipeline.get_prior
    • fips.InversionPipeline.get_forward_operator
    • fips.InversionPipeline.get_prior_error
    • fips.InversionPipeline.get_modeldata_mismatch
    • fips.InversionPipeline.get_constant
    • fips.InversionPipeline.filter_state_space
    • fips.InversionPipeline.aggregate_obs_space
    • fips.InversionPipeline.get_inputs
    • fips.InversionPipeline.run
  • Utilities
    • Aggregators
      • fips.aggregators.integrate_over_time_bins
      • fips.aggregators.ObsAggregator
      • fips.aggregators.ObsAggregator.apply
    • Filters
      • fips.filters.enough_obs_per_interval
      • fips.filters.select_intervals_with_min_obs
    • Index utilities
      • fips.indexes.apply_to_index
      • fips.indexes.assign_block
      • fips.indexes.outer_align_levels
      • fips.indexes.overlaps
      • fips.indexes.resolve_axes
      • fips.indexes.round_index
      • fips.indexes.to_numeric
    • Kernels
      • fips.kernels.ConstantCorrelation
      • fips.kernels.RaggedTimeDecay
      • fips.kernels.GridTimeDecay
      • fips.kernels.GridSpatialDecay
    • Metrics
      • fips.metrics.haversine_matrix
      • fips.metrics.time_diff_matrix
    • Visualization
      • fips.visualization.plot_error_norm
      • fips.visualization.plot_comparison
      • fips.visualization.compute_credible_interval
  • Problems
    • Flux Inversion
      • fips.problems.flux.FluxProblem
      • fips.problems.flux.FluxProblem.prior
      • fips.problems.flux.FluxProblem.obs
      • fips.problems.flux.FluxProblem.estimator
      • fips.problems.flux.FluxProblem.solve
      • fips.problems.flux.FluxProblem.get_block
      • fips.problems.flux.pipeline.FluxInversionPipeline
      • fips.problems.flux.pipeline.FluxInversionPipeline.problem
      • fips.problems.flux.pipeline.FluxInversionPipeline.estimator
      • fips.problems.flux.pipeline.FluxInversionPipeline.filter_state_space
      • fips.problems.flux.pipeline.FluxInversionPipeline.run
      • fips.problems.flux.pipeline.FluxInversionPipeline.summarize
      • fips.problems.flux.visualization.FluxPlotter
      • fips.problems.flux.visualization.FluxPlotter.fluxes
      • fips.problems.flux.visualization.FluxPlotter.concentrations
  • API Reference

API Reference#

This reference provides detailed documentation for all public classes, functions, and modules in FIPS.

  • Block Structures
    • Block
    • MatrixBlock
  • Multi-Block Structures
    • Vector
    • Matrix
  • Operators
    • ForwardOperator
    • Convolution
  • Covariance Matrices
    • CovarianceMatrix
    • ErrorComponents
    • CovarianceBuilder
  • Inverse Problem
    • Constructor
    • Inputs
    • Solving the Inverse Problem
    • Results
    • Selection and indexing
    • Serialization
  • Estimators
    • Estimator (Base Class)
    • BayesianSolver
  • Pipeline
    • InversionPipeline
  • Utilities
    • Aggregators
    • Filters
    • Index utilities
    • Kernels
    • Metrics
    • Visualization
  • Problems
    • Flux Inversion

previous

2D Gravity Inversion

next

Block Structures

This Page

  • Show Source

© Copyright 2025, James Mineau.

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.