ftmwpipeline

Getting Started

  • Overview
  • Installation
  • Quickstart

Concepts

  • Settings and presets
  • Inside the .ftmw file
  • Input Formats
  • Fit Curation

Pipeline Stages

  • Stage 0: Data Import
  • Stage 1: Fourier Transform
  • Stage 2: Noise Estimation
  • Stage 2b: Decay-Time Calibration
  • Stage 3: Peak Detection
  • Stage 4: Window Assignment
  • Stage 5: Peak Fitting
  • Stage 6: Review, Reports, and Finalization

Advanced

  • Declaring Instrument Clocks
  • Scope-Record Import
  • Performance

Methods & Validation

  • Noise estimation at high signal-to-noise
  • Matched filter as a peak detector
  • Complex-edge coherence statistic
  • Stage 5 fitting: gates, blends, and SNR-aware acceptance
  • Timebase self-calibration

Reference

  • Command-Line Reference
  • Python API Reference
  • Changelog
ftmwpipeline
  • Overview: module code

All modules for which code is available

  • ftmwpipeline.api
  • ftmwpipeline.core.data_structures
  • ftmwpipeline.core.noise_settings
  • ftmwpipeline.core.peak_detection_settings
  • ftmwpipeline.core.stage_fit_settings
  • ftmwpipeline.core.start_detection_settings
  • ftmwpipeline.core.tau_calibration_settings
  • ftmwpipeline.core.window_planning_settings
  • ftmwpipeline.file_manager
  • ftmwpipeline.fitting.tau_calibration
  • ftmwpipeline.fitting.timebase_calibration
  • ftmwpipeline.pipeline
  • ftmwpipeline.preprocessing.noise_estimation
  • ftmwpipeline.preprocessing.start_detection

© Copyright 2026, Kyle N. Crabtree.

Built with Sphinx using a theme provided by Read the Docs.