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
Index
Index
Symbols
|
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
Symbols
.ftmw file
_
__init__() (ftmwpipeline.core.data_structures.ComplexFT method)
(ftmwpipeline.core.data_structures.FID method)
(ftmwpipeline.core.data_structures.FinalPeak method)
(ftmwpipeline.core.data_structures.FinalProducts method)
(ftmwpipeline.core.data_structures.FittedPeak method)
(ftmwpipeline.core.data_structures.FittingResult method)
(ftmwpipeline.core.data_structures.FrequencyCalibration method)
(ftmwpipeline.core.data_structures.LedgerCandidate method)
(ftmwpipeline.core.data_structures.Peak method)
(ftmwpipeline.core.data_structures.SpectralWindow method)
(ftmwpipeline.core.data_structures.SpectrumFit method)
(ftmwpipeline.core.data_structures.Stage6Review method)
(ftmwpipeline.core.data_structures.WindowPlan method)
(ftmwpipeline.core.noise_settings.NoiseSettings method)
(ftmwpipeline.core.peak_detection_settings.PeakDetectionSettings method)
(ftmwpipeline.core.stage_fit_settings.ClockSource method)
(ftmwpipeline.core.stage_fit_settings.StageFitSettings method)
(ftmwpipeline.core.start_detection_settings.StartDetectionSettings method)
(ftmwpipeline.core.tau_calibration_settings.TauCalibrationSettings method)
(ftmwpipeline.core.window_planning_settings.WindowPlanningSettings method)
(ftmwpipeline.file_manager.PipelineCorruptionError method)
(ftmwpipeline.file_manager.PipelineExistsError method)
(ftmwpipeline.file_manager.StageDependencyError method)
(ftmwpipeline.fitting.tau_calibration.ShapeRecommendation method)
(ftmwpipeline.fitting.tau_calibration.TauCalibrationResult method)
(ftmwpipeline.fitting.timebase_calibration.TimebaseCalibrationResult method)
(ftmwpipeline.pipeline.Pipeline method)
(ftmwpipeline.preprocessing.noise_estimation.NoiseResult method)
(ftmwpipeline.preprocessing.start_detection.StartDetectionResult method)
__lt__() (ftmwpipeline.core.data_structures.Peak method)
__repr__() (ftmwpipeline.pipeline.Pipeline method)
A
acquisition layout
active region
active-FT frame
add_fitted_peak() (ftmwpipeline.core.data_structures.FittingResult method)
add_peak() (ftmwpipeline.core.data_structures.SpectralWindow method)
aggregation (ftmwpipeline.core.tau_calibration_settings.TauCalibrationSettings attribute)
amplitude (ftmwpipeline.core.data_structures.FinalPeak attribute)
(ftmwpipeline.core.data_structures.FittedPeak attribute)
amplitude_error (ftmwpipeline.core.data_structures.FinalPeak attribute)
(ftmwpipeline.core.data_structures.FittedPeak attribute)
amplitudes (ftmwpipeline.core.data_structures.FittingResult property)
analysis windows
API reference
apodized FFT
apply_molecular_frequency() (ftmwpipeline.core.data_structures.FID method)
assign_windows() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
attention routing
audit_trail (ftmwpipeline.core.data_structures.FittingResult attribute)
B
band (ftmwpipeline.core.tau_calibration_settings.TauCalibrationSettings attribute)
band_majorities (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
band_max_mhz (ftmwpipeline.core.start_detection_settings.StartDetectionSettings attribute)
band_mhz (ftmwpipeline.preprocessing.start_detection.StartDetectionResult attribute)
band_min_mhz (ftmwpipeline.core.start_detection_settings.StartDetectionSettings attribute)
bandwidth (ftmwpipeline.core.data_structures.SpectralWindow property)
baseline (ftmwpipeline.core.stage_fit_settings.StageFitSettings attribute)
batch editing
best_evidence (ftmwpipeline.core.data_structures.LedgerCandidate attribute)
bimodality (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
bin_info (ftmwpipeline.preprocessing.noise_estimation.NoiseResult attribute)
blend recovery
bring your own data
build() (ftmwpipeline.pipeline.Pipeline class method)
C
calibrate_tau() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
calibrate_timebase() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
calibration_state (ftmwpipeline.core.data_structures.FinalProducts attribute)
candidate ledger
candidate_ledger() (ftmwpipeline.pipeline.Pipeline method)
canonical FT
catalog cross-reference
center_frequency (ftmwpipeline.core.data_structures.SpectralWindow property)
changelog
chi_squared (ftmwpipeline.core.data_structures.FittedPeak attribute)
chirp
start detection
chirp-response spur lane
chirp_detected (ftmwpipeline.preprocessing.start_detection.StartDetectionResult attribute)
chirp_end_declared_us (ftmwpipeline.preprocessing.start_detection.StartDetectionResult attribute)
chirp_end_us (ftmwpipeline.preprocessing.start_detection.StartDetectionResult attribute)
classification (ftmwpipeline.core.data_structures.Peak attribute)
clear_clock_sources() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
CLI
clock declaration
input
clock lattice
clock source
clock spur
catalog
clock_lattice (ftmwpipeline.core.data_structures.FinalPeak attribute)
(ftmwpipeline.core.data_structures.FittedPeak attribute)
ClockSource (class in ftmwpipeline.core.stage_fit_settings)
clustering (ftmwpipeline.core.window_planning_settings.WindowPlanningSettings attribute)
coerce() (ftmwpipeline.core.data_structures.Sideband class method)
coherence (ftmwpipeline.core.window_planning_settings.WindowPlanningSettings attribute)
command-line interface
ComplexFT (class in ftmwpipeline.core.data_structures)
compute_ft() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
conda environment
conservative (ftmwpipeline.core.stage_fit_settings.StageFitSettings attribute)
context-invariant gate
contributor (ftmwpipeline.core.window_planning_settings.WindowPlanningSettings attribute)
contributor_bin_indices (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
contributor_freqs_mhz (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
contributor_snrs (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
contributor_taus_us (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
convolve_mhz (ftmwpipeline.core.noise_settings.NoiseSettings attribute)
covariance (ftmwpipeline.core.data_structures.FittingResult attribute)
covariance_param_labels (ftmwpipeline.core.data_structures.FittingResult attribute)
Cramer-Rao bound
frequency
create() (ftmwpipeline.pipeline.Pipeline class method)
CSV input
curation
curation cart
curation file
,
[1]
custom loader
D
data import
data loaders
,
[1]
decay time
,
[1]
decay_rate (ftmwpipeline.core.data_structures.FittedPeak attribute)
decay_rate_error (ftmwpipeline.core.data_structures.FittedPeak attribute)
decision log
decision_log (ftmwpipeline.core.data_structures.Stage6Review attribute)
decision_sites (ftmwpipeline.core.data_structures.LedgerCandidate attribute)
declaration_used (ftmwpipeline.preprocessing.start_detection.StartDetectionResult attribute)
dependencies
pipeline stages
dependency_edges (ftmwpipeline.core.data_structures.WindowPlan attribute)
design philosophy
detect_peaks() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
detect_start_time() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
diagnostics (ftmwpipeline.core.data_structures.SpectrumFit attribute)
(ftmwpipeline.core.data_structures.WindowPlan attribute)
digitizer clock
scale error
doublet_alternative (ftmwpipeline.core.stage_fit_settings.StageFitSettings attribute)
doublet_alternatives (ftmwpipeline.core.data_structures.FittingResult attribute)
duration (ftmwpipeline.core.data_structures.FID property)
duration_us (ftmwpipeline.core.data_structures.FID property)
E
edge coherence
edge-coherence statistic
effective sample size
end_us (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
(ftmwpipeline.fitting.timebase_calibration.TimebaseCalibrationResult attribute)
epsilon (ftmwpipeline.core.data_structures.FinalProducts attribute)
(ftmwpipeline.fitting.timebase_calibration.TimebaseCalibrationResult attribute)
estimate_noise() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
evidence_kind (ftmwpipeline.core.data_structures.LedgerCandidate attribute)
example data
extra_errors (ftmwpipeline.core.data_structures.FittedPeak attribute)
extra_parameters (ftmwpipeline.core.data_structures.FittedPeak attribute)
extract_window() (ftmwpipeline.core.data_structures.ComplexFT method)
F
F-test
denominator bias
f_baseband_mhz (ftmwpipeline.core.data_structures.FinalPeak attribute)
FID (class in ftmwpipeline.core.data_structures)
file format
final products
final_plan_revision (ftmwpipeline.core.data_structures.SpectrumFit attribute)
final_products (ftmwpipeline.core.data_structures.Stage6Review attribute)
final_products() (ftmwpipeline.pipeline.Pipeline method)
finalization
FinalPeak (class in ftmwpipeline.core.data_structures)
FinalProducts (class in ftmwpipeline.core.data_structures)
finite-acquisition response
fit
cost
fit acceptance
fit dependency order
fit_peaks() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
fitted_peaks (ftmwpipeline.core.data_structures.FittingResult attribute)
(ftmwpipeline.core.data_structures.SpectrumFit attribute)
FittedPeak (class in ftmwpipeline.core.data_structures)
FittingResult (class in ftmwpipeline.core.data_structures)
fixed contributors
fixed_parameters (ftmwpipeline.core.data_structures.FittingResult attribute)
flat_decay (ftmwpipeline.core.data_structures.FittedPeak attribute)
floor (ftmwpipeline.preprocessing.start_detection.StartDetectionResult attribute)
floor_factor (ftmwpipeline.core.start_detection_settings.StartDetectionSettings attribute)
floor_tail_us (ftmwpipeline.core.start_detection_settings.StartDetectionSettings attribute)
format detection
Fourier transform
free-induction decay
freq_mhz (ftmwpipeline.core.stage_fit_settings.ClockSource attribute)
freq_range (ftmwpipeline.core.data_structures.ComplexFT property)
freq_step (ftmwpipeline.core.data_structures.ComplexFT property)
frequencies_mhz (ftmwpipeline.core.data_structures.FittingResult property)
frequency calibration
epsilon
frequency trim
frequency_error (ftmwpipeline.core.data_structures.FittedPeak attribute)
frequency_mhz (ftmwpipeline.core.data_structures.FinalPeak attribute)
(ftmwpipeline.core.data_structures.FittedPeak attribute)
(ftmwpipeline.core.data_structures.LedgerCandidate attribute)
frequency_raw_mhz (ftmwpipeline.core.data_structures.FinalPeak attribute)
frequency_thirds (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
FrequencyCalibration (class in ftmwpipeline.core.data_structures)
from_spectrum() (ftmwpipeline.core.data_structures.ComplexFT class method)
ftmw-hdf5 format
FTMW_MAX_WORKERS
ftmwpipeline command
ftmwpipeline.api
module
functional API
G
gap pass
,
[1]
gap_pass (ftmwpipeline.core.peak_detection_settings.PeakDetectionSettings attribute)
gaussian (ftmwpipeline.core.tau_calibration_settings.TauCalibrationSettings attribute)
get_candidate_ledger() (in module ftmwpipeline.api)
get_clock_sources() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
get_final_products() (in module ftmwpipeline.api)
get_peaks_by_classification() (ftmwpipeline.core.data_structures.SpectralWindow method)
get_pipeline_info() (in module ftmwpipeline.api)
get_review_status() (in module ftmwpipeline.api)
guard_margin_us (ftmwpipeline.core.start_detection_settings.StartDetectionSettings attribute)
H
HDF5
HTML report
I
imag_spectrum (ftmwpipeline.core.data_structures.ComplexFT property)
(ftmwpipeline.core.data_structures.SpectralWindow property)
import_data() (in module ftmwpipeline.api)
info() (ftmwpipeline.pipeline.Pipeline method)
input formats
installation
interfaces
command-line, Pipeline, functional
interleave cleanup
is_classified (ftmwpipeline.core.data_structures.Peak property)
is_empty() (ftmwpipeline.core.noise_settings.NoiseSettings method)
(ftmwpipeline.core.peak_detection_settings.PeakDetectionSettings method)
(ftmwpipeline.core.stage_fit_settings.StageFitSettings method)
(ftmwpipeline.core.tau_calibration_settings.TauCalibrationSettings method)
(ftmwpipeline.core.window_planning_settings.WindowPlanningSettings method)
is_medium (ftmwpipeline.core.data_structures.Peak property)
is_strong (ftmwpipeline.core.data_structures.Peak property)
is_weak (ftmwpipeline.core.data_structures.Peak property)
J
jobs
worker count
K
kappa_sys (ftmwpipeline.fitting.timebase_calibration.TimebaseCalibrationResult attribute)
keysight-mat
knockout (ftmwpipeline.core.data_structures.FittedPeak attribute)
L
label (ftmwpipeline.core.stage_fit_settings.ClockSource attribute)
lattice_g_mhz (ftmwpipeline.fitting.timebase_calibration.TimebaseCalibrationResult attribute)
leakage (ftmwpipeline.core.window_planning_settings.WindowPlanningSettings attribute)
leakage pedestal
,
[1]
leakage skirt
leakage-aware detection floor
leakage-touched region
leakage-wing baseline
LedgerCandidate (class in ftmwpipeline.core.data_structures)
line shape
recommendation
line_k (ftmwpipeline.core.noise_settings.NoiseSettings attribute)
list_available_stages() (in module ftmwpipeline.api)
load_data() (ftmwpipeline.pipeline.Pipeline method)
load_fid() (in module ftmwpipeline.api)
load_fit() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
load_peaks() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
load_tau_calibration() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
load_timebase_calibration() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
load_windows() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
locked (ftmwpipeline.core.stage_fit_settings.ClockSource attribute)
LOWER (ftmwpipeline.core.data_structures.Sideband attribute)
LSB (ftmwpipeline.core.data_structures.Sideband attribute)
M
magnitude_spectrum (ftmwpipeline.core.data_structures.ComplexFT property)
(ftmwpipeline.core.data_structures.SpectralWindow property)
matched filter
,
[1]
median_d_aicc (ftmwpipeline.fitting.tau_calibration.ShapeRecommendation attribute)
min_chirp_drop_ratio (ftmwpipeline.core.start_detection_settings.StartDetectionSettings attribute)
module
ftmwpipeline.api
molecular frequency
N
n_batches (ftmwpipeline.core.data_structures.WindowPlan property)
n_contributors (ftmwpipeline.fitting.tau_calibration.ShapeRecommendation attribute)
(ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
n_detected (ftmwpipeline.fitting.timebase_calibration.TimebaseCalibrationResult attribute)
n_fitted_peaks (ftmwpipeline.core.data_structures.SpectrumFit property)
n_iter (ftmwpipeline.core.noise_settings.NoiseSettings attribute)
n_peaks (ftmwpipeline.core.data_structures.SpectralWindow property)
n_peaks_fitted (ftmwpipeline.core.data_structures.FittingResult property)
n_points (ftmwpipeline.core.data_structures.ComplexFT property)
(ftmwpipeline.core.data_structures.FID property)
(ftmwpipeline.core.data_structures.SpectralWindow property)
n_seg (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
n_spur_bins (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
n_used (ftmwpipeline.fitting.timebase_calibration.TimebaseCalibrationResult attribute)
n_windows (ftmwpipeline.core.data_structures.SpectrumFit property)
(ftmwpipeline.core.data_structures.WindowPlan property)
Neyman-Pearson detector
noise estimation
high signal-to-noise
noise_mask (ftmwpipeline.preprocessing.noise_estimation.NoiseResult attribute)
NoiseResult (class in ftmwpipeline.preprocessing.noise_estimation)
NoiseSettings (class in ftmwpipeline.core.noise_settings)
nonlinear least squares
notes (ftmwpipeline.fitting.tau_calibration.ShapeRecommendation attribute)
O
object-verb grammar
open() (ftmwpipeline.pipeline.Pipeline class method)
origin (ftmwpipeline.core.data_structures.FinalPeak attribute)
(ftmwpipeline.core.data_structures.FittedPeak attribute)
overview
P
parallel batches
parallelism
parameter resolution
parameters (ftmwpipeline.core.data_structures.SpectrumFit attribute)
(ftmwpipeline.core.data_structures.WindowPlan attribute)
Peak (class in ftmwpipeline.core.data_structures)
peak detection
matched filter
peak fitting
acceptance gate
peak_id (ftmwpipeline.core.data_structures.FittedPeak attribute)
peak_survival (ftmwpipeline.core.stage_fit_settings.StageFitSettings attribute)
PeakDetectionSettings (class in ftmwpipeline.core.peak_detection_settings)
peaks (ftmwpipeline.core.data_structures.FinalProducts attribute)
pearson_r_freq_vs_tau (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
pearson_r_log_snr_vs_tau (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
pedestal_mhz (ftmwpipeline.core.noise_settings.NoiseSettings attribute)
penalized chi-squared
penalties (ftmwpipeline.core.stage_fit_settings.StageFitSettings attribute)
per-band decay time
per-bin noise
performance
persistence
settings
phase (ftmwpipeline.core.data_structures.FinalPeak attribute)
(ftmwpipeline.core.data_structures.FittedPeak attribute)
phase coherence
phase-ramp estimator
phase_error (ftmwpipeline.core.data_structures.FinalPeak attribute)
(ftmwpipeline.core.data_structures.FittedPeak attribute)
Pipeline (class in ftmwpipeline.pipeline)
Pipeline class
pipeline stages
PipelineCorruptionError
PipelineExistsError
PipelineFileError
plan_revision (ftmwpipeline.core.data_structures.WindowPlan attribute)
plateau (ftmwpipeline.preprocessing.start_detection.StartDetectionResult attribute)
polish (ftmwpipeline.core.tau_calibration_settings.TauCalibrationSettings attribute)
pre-record
preconditions_notes (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
(ftmwpipeline.fitting.timebase_calibration.TimebaseCalibrationResult attribute)
preconditions_passed (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
(ftmwpipeline.fitting.timebase_calibration.TimebaseCalibrationResult attribute)
preprocess() (ftmwpipeline.core.data_structures.FID method)
presets
primary_pass (ftmwpipeline.core.peak_detection_settings.PeakDetectionSettings attribute)
probe_freq_mhz (ftmwpipeline.core.data_structures.FinalProducts attribute)
(ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
promotion (ftmwpipeline.core.peak_detection_settings.PeakDetectionSettings attribute)
promotion cutoff
provenance
Python API
Q
quality_metrics (ftmwpipeline.core.data_structures.FittingResult attribute)
quickstart
R
rank_windows() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
raw scope import
real_spectrum (ftmwpipeline.core.data_structures.ComplexFT property)
(ftmwpipeline.core.data_structures.SpectralWindow property)
reasons (ftmwpipeline.core.data_structures.LedgerCandidate attribute)
recommend_shape() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
recommendation (ftmwpipeline.core.tau_calibration_settings.TauCalibrationSettings attribute)
recommended_shape (ftmwpipeline.fitting.tau_calibration.ShapeRecommendation attribute)
region_aware (ftmwpipeline.core.noise_settings.NoiseSettings attribute)
remove_clock_sources() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
replan_history (ftmwpipeline.core.data_structures.SpectrumFit attribute)
report
cost
report_diff() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
report_run() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
report_table() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
reports
reproducibility
rescue (ftmwpipeline.core.stage_fit_settings.StageFitSettings attribute)
rescue_events (ftmwpipeline.core.data_structures.FittingResult attribute)
rescue_history (ftmwpipeline.core.data_structures.SpectrumFit attribute)
residual rescue
,
[1]
residuals (ftmwpipeline.core.data_structures.FittingResult attribute)
review
review apply
review_accept() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
review_apply() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
review_edit() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
review_log() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
review_merge() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
review_run() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
review_split() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
review_status() (ftmwpipeline.pipeline.Pipeline method)
review_undo() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
Rician correction
ring-down
rms_noise (ftmwpipeline.preprocessing.noise_estimation.NoiseResult attribute)
rss_gate_factor (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
run command
run_pipeline() (in module ftmwpipeline.api)
S
sample_dt_us (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
(ftmwpipeline.fitting.timebase_calibration.TimebaseCalibrationResult attribute)
save_ft_parameters() (in module ftmwpipeline.api)
save_peak_parameters() (in module ftmwpipeline.api)
save_window_parameters() (in module ftmwpipeline.api)
savgol (ftmwpipeline.core.peak_detection_settings.PeakDetectionSettings attribute)
scan_all() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
scan_list() (ftmwpipeline.pipeline.Pipeline static method)
(in module ftmwpipeline.api)
scan_run() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
scatter estimator
scope record
seed_amplitude (ftmwpipeline.core.data_structures.LedgerCandidate attribute)
seed_offset_mhz (ftmwpipeline.core.data_structures.LedgerCandidate attribute)
seeder (ftmwpipeline.core.stage_fit_settings.StageFitSettings attribute)
set_clock_sources() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
set_fixed_parameter() (ftmwpipeline.core.data_structures.FittingResult method)
set_shared_parameter() (ftmwpipeline.core.data_structures.FittingResult method)
set_sigma_floor() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
settings
settings_export() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
settings_set() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
settings_show() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
shape (ftmwpipeline.core.stage_fit_settings.StageFitSettings attribute)
shape-error fraction
ShapeRecommendation (class in ftmwpipeline.fitting.tau_calibration)
shared_parameters (ftmwpipeline.core.data_structures.FittingResult attribute)
short-time Fourier transform
shot-count scaling
show_fit() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
sideband
Sideband (class in ftmwpipeline.core.data_structures)
sideband (ftmwpipeline.core.data_structures.FinalProducts attribute)
(ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
sidecar metadata
sigma_eps_khz (ftmwpipeline.core.data_structures.FinalPeak attribute)
sigma_epsilon (ftmwpipeline.core.data_structures.FinalProducts attribute)
(ftmwpipeline.fitting.timebase_calibration.TimebaseCalibrationResult attribute)
sigma_f_khz (ftmwpipeline.core.data_structures.FinalPeak attribute)
sigma_floor_khz (ftmwpipeline.core.data_structures.FinalPeak attribute)
(ftmwpipeline.core.data_structures.FinalProducts attribute)
(ftmwpipeline.core.data_structures.FrequencyCalibration attribute)
sigma_frame (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
sigma_stat_khz (ftmwpipeline.core.data_structures.FinalPeak attribute)
sigma_tau_us (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
sigma_x_full (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
sign (ftmwpipeline.core.data_structures.Sideband property)
signal-to-noise ratio
smoothing_mhz (ftmwpipeline.core.noise_settings.NoiseSettings attribute)
smoothing_percentile (ftmwpipeline.core.noise_settings.NoiseSettings attribute)
snr (ftmwpipeline.core.data_structures.FinalPeak attribute)
(ftmwpipeline.core.data_structures.FittedPeak attribute)
SNR classification
SNR-aware acceptance
snr_error (ftmwpipeline.core.data_structures.FinalPeak attribute)
snr_min (ftmwpipeline.fitting.timebase_calibration.TimebaseCalibrationResult attribute)
snr_weighted (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
source provenance
span_us (ftmwpipeline.fitting.timebase_calibration.TimebaseCalibrationResult attribute)
SpectralWindow (class in ftmwpipeline.core.data_structures)
SpectrumFit (class in ftmwpipeline.core.data_structures)
spur
lattice prior
spur (ftmwpipeline.core.stage_fit_settings.StageFitSettings attribute)
spur masking
spur_clusters (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
stage tracking
Stage6Review (class in ftmwpipeline.core.data_structures)
StageDependencyError
StageFitSettings (class in ftmwpipeline.core.stage_fit_settings)
start-time detection
start_us (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
(ftmwpipeline.fitting.timebase_calibration.TimebaseCalibrationResult attribute)
(ftmwpipeline.preprocessing.start_detection.StartDetectionResult attribute)
StartDetectionResult (class in ftmwpipeline.preprocessing.start_detection)
StartDetectionSettings (class in ftmwpipeline.core.start_detection_settings)
starts_us (ftmwpipeline.preprocessing.start_detection.StartDetectionResult attribute)
step_us (ftmwpipeline.core.start_detection_settings.StartDetectionSettings attribute)
stft (ftmwpipeline.core.tau_calibration_settings.TauCalibrationSettings attribute)
sub-bin position
sum_magnitude (ftmwpipeline.preprocessing.start_detection.StartDetectionResult attribute)
sweep_max_us (ftmwpipeline.core.start_detection_settings.StartDetectionSettings attribute)
T
t_sigma (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
tau (ftmwpipeline.core.stage_fit_settings.StageFitSettings attribute)
tau calibration
tau_maj_us (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
tau_max_us (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
TauCalibrationResult (class in ftmwpipeline.fitting.tau_calibration)
TauCalibrationSettings (class in ftmwpipeline.core.tau_calibration_settings)
thaw (ftmwpipeline.core.stage_fit_settings.StageFitSettings attribute)
thaw_events (ftmwpipeline.core.data_structures.FittingResult attribute)
thaw_history (ftmwpipeline.core.data_structures.SpectrumFit attribute)
time_array() (ftmwpipeline.core.data_structures.FID method)
time_array_us() (ftmwpipeline.core.data_structures.FID method)
timebase calibration
,
[1]
TimebaseCalibrationResult (class in ftmwpipeline.fitting.timebase_calibration)
to_dict() (ftmwpipeline.core.stage_fit_settings.ClockSource method)
tone_reads (ftmwpipeline.fitting.timebase_calibration.TimebaseCalibrationResult attribute)
topological_order (ftmwpipeline.core.data_structures.WindowPlan attribute)
trim_hi_mhz (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
trim_lo_mhz (ftmwpipeline.fitting.tau_calibration.TauCalibrationResult attribute)
trim_to_range() (ftmwpipeline.core.data_structures.ComplexFT method)
U
uncertainty budget
UPPER (ftmwpipeline.core.data_structures.Sideband attribute)
USB (ftmwpipeline.core.data_structures.Sideband attribute)
V
validate() (ftmwpipeline.pipeline.Pipeline method)
validate_pipeline() (in module ftmwpipeline.api)
validate_stage5_shape_error() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
version history
visualize_fit() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
visualize_ft() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
visualize_noise() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
visualize_peaks() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
visualize_start_detection() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
visualize_tau_distribution() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
visualize_tau_heatmap() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
visualize_windows() (ftmwpipeline.pipeline.Pipeline method)
(in module ftmwpipeline.api)
vote_rates (ftmwpipeline.fitting.tau_calibration.ShapeRecommendation attribute)
W
window assignment
edge test
window() (ftmwpipeline.core.data_structures.WindowPlan method)
window_fit() (ftmwpipeline.core.data_structures.SpectrumFit method)
window_fits (ftmwpipeline.core.data_structures.SpectrumFit attribute)
window_id (ftmwpipeline.core.data_structures.FinalPeak attribute)
(ftmwpipeline.core.data_structures.FittedPeak attribute)
(ftmwpipeline.core.data_structures.LedgerCandidate attribute)
window_mhz (ftmwpipeline.core.noise_settings.NoiseSettings attribute)
window_statuses (ftmwpipeline.core.data_structures.Stage6Review attribute)
WindowPlan (class in ftmwpipeline.core.data_structures)
WindowPlanningSettings (class in ftmwpipeline.core.window_planning_settings)
windows (ftmwpipeline.core.data_structures.WindowPlan attribute)
workflow_summary() (in module ftmwpipeline.api)