Public API reference

The package root is the supported import surface:

import mftt

The generated reference below is built directly from the public classes and functions in mftt. Their NumPy-style docstrings are the source for signatures, parameters, defaults, return values, and exceptions.

• Map classes
  • TriangularMap
  • HierarchicalTriangularMap
  • NonHierarchicalTriangularMap
• Configuration and references
  • MapParams
  • HierarchicalMapParams
  • NonHierarchicalMapParams
  • OptimizationParams
  • Reference
  • BasisSpec
  • MapComponentParams
  • QuadratureRule
  • StandardizationParams
• Inversion types
  • InverseOptions
  • InverseFailure
  • InverseDiagnostics
  • InverseResult
• Diagnostics functions
  • first_moment_error()
  • second_moment_error()
  • forstner_distance()
  • squared_mmd_gaussian_kernel()
  • multiscale_squared_mmd_gaussian_kernel()
  • gaussian_diagnostics()
  • map_gaussian_diagnostics()
  • median_heuristic_bandwidth()
  • sample_mean()
  • sample_covariance()

The stable package version is available as mftt.__version__. The public map contract is summarized in shared operations, including the target/reference direction, raw-coordinate behavior, density helpers, and conditional sampling.