API reference

Generated from the package. Everything documented here is importable directly from the top level (from minisim import ...).

• Spec and steps
  • Spec
  • Acquisition and physical models
  • Output
  • Steps
  • Warnings
• Simulation
  • simulate
  • simulate_cached
  • simulate_video
  • sweep
• Recording and ground truth
  • Recording
  • GroundTruth
  • finalize
• Scene construction
  • Scene
  • Cell
  • GroundTruthBuilder
• Recovery metrics
  • Spatial matching
  • Temporal scores
  • Field and motion
• Caching
  • simulate_cached
  • cache_dir
  • cache_path

At a glance

Symbol	Role
Spec	The typed, validated recording specification (the input you build).
simulate()	Run the forward pipeline; returns a Recording.
simulate_cached()	As simulate, memoized to disk by spec.cache_key().
simulate_video()	Simulate straight to a grayscale video, streamed to disk.
sweep()	Cartesian-product generator over spec overrides.
Recording	The result: observed movie, ground_truth, per-stage snapshots.
GroundTruth	The exact generators (footprints, traces, spikes, optical fields).
metrics	Score recovered cells, traces, spikes, and motion against truth.