A-Z index¶

Every public class, function and constant, alphabetically. Each row links its domain, its API entry, and the guides, gallery pages and examples that use it.

A¶

Name	Kind	API	Guide	Gallery	Example	Design
`AccCf64`	class	AccCf64	Checkpoint & Resume			API taxonomy: the DSP building-block hierarchy and its naming axis State Serialization — the standard bytes interface
`AccF32`	class	AccF32	Checkpoint & Resume			API taxonomy: the DSP building-block hierarchy and its naming axis State Serialization — the standard bytes interface
`AccQ15`	class	AccQ15	Getting Started with Fixed-Point Arithmetic			API taxonomy: the DSP building-block hierarchy and its naming axis
`AccQ8`	class	AccQ8	Getting Started with Fixed-Point Arithmetic			API taxonomy: the DSP building-block hierarchy and its naming axis
`AccTrace`	class	AccTrace	Streaming Spectrograms	Four WCDMA Carriers — `PSD`, `band_power`, `AccTrace`	wcdma_carriers_demo	API taxonomy: the DSP building-block hierarchy and its naming axis The Exponential Moving Average The Spectrogram — chunks in, rows out +1 more
`Acquisition`	class	Acquisition	Acquiring a Repeated Preamble Checkpoint & Resume DSSS Burst Acquisition	CarrierAcquisition: RRC Pulse Shaping Correlation and Detection DsssBurstReceiver — the Composed Burst Chain +1 more	acq_surface_demo	Design — pure-functional acquisition kernel (elastic fleet) One Python class: the step-4 design One correlator: the step-3 design +6 more
`ADC`	class	ADC	Getting Started with Fixed-Point Arithmetic Power Spectra & Measurements	ADC Quantisation — 3–8 Bits Measurement Suite — two-tone IMD/TOI & notched-noise NPR	adc_demo measure_demo measure_imd_npr_demo	API taxonomy: the DSP building-block hierarchy and its naming axis Spectral & Measurement API Map
`add_q15`	function	add_q15	Getting Started with Fixed-Point Arithmetic
`add_q8`	function	add_q8
`AGC`	class	AGC		AGC Settling — a design chart AGC — Step Response	agc_demo agc_settling_design_demo telemetry_fanin_demo	API taxonomy: the DSP building-block hierarchy and its naming axis MPSK Receiver
`asm_bits`	function	asm_bits			ccsds_link_demo	A Frame as a Description A Frame as a Description — the measurement record
`ASYNC_DSSS_RX_STATE`	constant
`AsyncDsssPool`	class	AsyncDsssPool		AsyncDsssPool: emitters that come and go AsyncDsssPool: ten emitters through six receivers	async_dsss_pool_demo async_dsss_pool_scene	AsyncDsssReceiver and AsyncDsssPool — continuous DSSS, from spec to object AsyncDsssReceiver and AsyncDsssPool — the measurement record One correlator: the step-3 design +1 more
`AsyncDsssReceiver`	class	AsyncDsssReceiver		AsyncDsssReceiver: a signal's lifecycle AsyncDsssReceiver: the specification link DsssReceiver — the Composed Continuous DSSS Receiver +1 more	async_dsss_receiver_lifecycle async_dsss_receiver_spec_demo	AsyncDsssReceiver and AsyncDsssPool — continuous DSSS, from spec to object AsyncDsssReceiver and AsyncDsssPool — the measurement record API taxonomy: the DSP building-block hierarchy and its naming axis +4 more
`AWGN`	class	AWGN		AWGN Generator AsyncDsssPool: emitters that come and go AsyncDsssPool: ten emitters through six receivers +4 more	async_despread_demo async_dsss_pool_demo async_dsss_pool_scene +6 more	API taxonomy: the DSP building-block hierarchy and its naming axis Corr2D hypothesis bank: operation order Spectral & Measurement API Map

B¶

Name	Kind	API	Guide	Gallery	Example	Design
`ber_esn0_db_for_ser`	function	ber_esn0_db_for_ser			async_dsss_receiver_spec_demo ber_awgn_demo dsss_burst_ber_demo	Receiver Test Harness The FEC Receive Half
`ber_evm_db`	function	ber_evm_db		Arbitrary-Rate Symbol Recovery AsyncDsssReceiver: the specification link M-PSK Receiver — Pull-in, Lock, and BER	async_dsss_receiver_spec_demo mpsk_receiver_performance_demo ratesync_demo	Receiver Test Harness
`ber_evm_ideal_db`	function			Arbitrary-Rate Symbol Recovery	ratesync_demo
`ber_evm_scatter_floor_db`	function	ber_evm_scatter_floor_db				Receiver Test Harness
`ber_lock_symbol`	function	ber_lock_symbol		AsyncDsssReceiver: the specification link	async_dsss_receiver_spec_demo mpsk_receiver_performance_demo	Receiver Test Harness
`ber_settle_from`	function	ber_settle_from				Receiver Test Harness
`ber_settle_syms`	function	ber_settle_syms		Arbitrary-Rate Symbol Recovery	mpsk_receiver_demo mpsk_receiver_performance_demo ratesync_demo	Receiver Test Harness
`ber_theory_ber`	function	ber_theory_ber			dsss_burst_ber_demo mpsk_constellation_demo
`ber_theory_ser`	function	ber_theory_ser		Measuring an Error Rate, Defensibly	ber_awgn_demo mpsk_receiver_demo mpsk_receiver_performance_demo	Receiver Test Harness
`BerInterval`	class	BerInterval		Measuring an Error Rate, Defensibly
`BerMeter`	class	BerMeter		Measuring an Error Rate, Defensibly AsyncDsssReceiver: the specification link M-PSK Receiver — Performance Characterisation	async_dsss_receiver_spec_demo ber_awgn_demo dsss_burst_ber_demo +1 more	Detection Sizing — the four laws behind one prefix Receiver Test Harness
`bin_to_hex`	function	bin_to_hex
`bin_to_int`	function	bin_to_int
`bin_to_nrz`	function	bin_to_nrz	DSSS Burst Acquisition	DSSS Acquisition — Pd / Pfa vs Es/N0	burst_capture_demo dsss_realtime_file_demod	The acquisition surface: the DSSS search engine `BurstCapture`: acquisition's output, turned into bursts
`bin_to_signed`	function	bin_to_signed	Acquiring a Repeated Preamble		dsss_realtime_file_demod	BurstBank — the coarse-Doppler bank as one C object CoarseChannel — is a channel an object, or a slice of the bank? One Python class: the step-4 design
`bits`	function		Field reference Waveforms — what you can generate Power Spectra & Measurements	ADC Quantisation — 3–8 Bits M-PSK Receiver — Pull-in, Lock, and BER	adc_demo carrier_acq_rrc_demo carrier_nda_seeding_demo +15 more	A Frame as a Description A Frame as a Description — the measurement record A Receiver Built from a Frame Description +10 more
`blackman_harris_window`	function	blackman_harris_window			adc_demo cic_demo cvt_quantization_demo +4 more
`bpsk`	function		Field reference Scenes — composing in time Waveforms — what you can generate	type="symbols" — Bring Your Own Constellation	wfmgen_demo	Waveform amplitude & composition API taxonomy: the DSP building-block hierarchy and its naming axis Receiver Test Harness
`bpsk_map`	function	bpsk_map			dsss_burst_demo dsss_receiver_demo
`BpskReceiver`	class			Capturing All Receiver Telemetry	mpsk_telemetry_capture_demo	MPSK Receiver API taxonomy: the DSP building-block hierarchy and its naming axis
`BurstAcquisition`	class	BurstAcquisition	Acquiring a Repeated Preamble Checkpoint & Resume DSSS Burst Acquisition +1 more	DSSS Acquisition — Pd / Pfa vs Es/N0 DsssBurstReceiver — the Composed Burst Chain	dsss_burst_demo dsss_realtime_file_demod	One Python class: the step-4 design One correlator: the step-3 design The acquisition surface: the DSSS search engine +6 more
`BurstCapture`	class	BurstCapture	Acquiring a Repeated Preamble Checkpoint & Resume DSSS Burst Acquisition +1 more		burst_capture_demo	BurstBank — the coarse-Doppler bank as one C object CoarseChannel — is a channel an object, or a slice of the bank? One Python class: the step-4 design +6 more
`BurstDemod`	class	BurstDemod	Waveforms — what you can generate	DsssBurstReceiver — the Composed Burst Chain	dsss_realtime_file_demod	AsyncDsssReceiver and AsyncDsssPool — continuous DSSS, from spec to object The Polynomial-Phase Estimator — the reasoning `DsssBurstReceiver`: the burst chain, composed in C +4 more
`BurstDespreader`	class	BurstDespreader	DSSS Burst Acquisition Lock Detection Across `doppler.track` Waveforms — what you can generate			The Polynomial-Phase Estimator — the reasoning `DsssBurstReceiver`: the burst chain, composed in C API taxonomy: the DSP building-block hierarchy and its naming axis +3 more
`bytes_to_bin`	function	bytes_to_bin	Waveforms — what you can generate		data_source_link_demo wfmgen_data_source_demo	A Frame as a Description A Frame as a Description — the measurement record The Payload as a Data Source

C¶

Name	Kind	API	Guide	Gallery	Example	Design
`Capture`	class			Capturing All Receiver Telemetry		Telemetry — zero-cost scalar taps for running pipelines Capture files — one reader, one writer, four containers Ending a wait — one contract for network, memory and disk +3 more
`CarrierAcquisition`	class	CarrierAcquisition		CarrierAcquisition: RRC Pulse Shaping	carrier_acq_rrc_demo	One Python class: the step-4 design One correlator: the step-3 design API taxonomy: the DSP building-block hierarchy and its naming axis +2 more
`CarrierMpsk`	class	CarrierMpsk		M-PSK Carrier Loop — Theory Validation NDA Carrier Loop — Theory Validation M-PSK constellation (Gray-coded map / demap)	mpsk_carrier_theory_demo	MPSK Receiver API taxonomy: the DSP building-block hierarchy and its naming axis The NCO
`CarrierNda`	class	CarrierNda	Lock Detection Across `doppler.track`	NDA Carrier Loop — Theory Validation	carrier_nda_seeding_demo mpsk_nda_theory_demo	MPSK Receiver API taxonomy: the DSP building-block hierarchy and its naming axis Lock Detection — the reasoning +1 more
`CF32`	constant				work_queue_shutdown_demo	Streaming — one envelope, six roles, two planes
`CF64`	constant				pipeline_recv pipeline_send receiver +3 more	Streaming — one envelope, six roles, two planes
`chirp`	function		Field reference Scenes — composing in time Waveforms — what you can generate	A Streaming Spectrogram	spectrogram_demo
`CI16`	constant					Streaming — one envelope, six roles, two planes
`CI32`	constant				pipeline_recv	Streaming — one envelope, six roles, two planes
`CI8`	constant					Streaming — one envelope, six roles, two planes
`CIC`	class	CIC		CIC Decimation Filter Arbitrary-Rate Symbol Recovery	cic_demo	API taxonomy: the DSP building-block hierarchy and its naming axis Design — pure-functional acquisition kernel (elastic fleet) Quantization Design +2 more
`ciccompmf`	function	ciccompmf		RateConverter — Automatic Cascade Selection
`complement_power`	function	complement_power				API taxonomy: the DSP building-block hierarchy and its naming axis
`Composer`	class	Composer	Reading captures Scenes — composing in time Waveforms — what you can generate +2 more	A Crowded Band — Many Signals, One Parallel `prepare` One Cache Slot for a Whole Background Field Waveform I/O — One Capture, Four File Types +2 more	acq_surface_demo burst_capture_demo costas_demo +22 more	Waveform amplitude & composition wfmgen — the waveform generator API taxonomy: the DSP building-block hierarchy and its naming axis +2 more
`ConvEncoder`	class	ConvEncoder		Name Your Own Code — and What Happens Past the Radius	coding_demo
`Corr`	class	Corr		Correlation and Detection CarrierAcquisition: RRC Pulse Shaping	corr_demo dsss_burst_demo	API taxonomy: the DSP building-block hierarchy and its naming axis One Python class: the step-4 design One correlator: the step-3 design +1 more
`Corr2D`	class	Corr2D	Delay-Doppler Search DSSS Burst Acquisition	2-D Acquisition Grid Correlation and Detection	corr_demo detection2d_demo detector2d_acq_demo	Corr2D batches: many maps in one call Corr2D hypothesis bank: operation order Corr2D: decoupled (interpolated) inverse length +3 more
`CorrDetector`	class	CorrDetector		Correlation and Detection CarrierAcquisition: RRC Pulse Shaping	corr_demo	API taxonomy: the DSP building-block hierarchy and its naming axis One Python class: the step-4 design One correlator: the step-3 design
`CorrDetector2D`	class	CorrDetector2D	DSSS Burst Acquisition	2-D Acquisition Grid Correlation and Detection	corr_demo detection2d_demo detector2d_acq_demo	API taxonomy: the DSP building-block hierarchy and its naming axis One Python class: the step-4 design One correlator: the step-3 design +1 more
`Costas`	class	Costas	Lock Detection Across `doppler.track`	Carrier Loop Stress Code Loop Tracking Costas Loop — Theory Validation +3 more	costas_demo costas_theory_demo receiver_lock_demo	API taxonomy: the DSP building-block hierarchy and its naming axis AsyncDsssReceiver and AsyncDsssPool — continuous DSSS, from spec to object Lock Detection — the reasoning +1 more
`crc16`	function	crc16	Waveforms — what you can generate	A Message Over DSSS, Received and Deframed		A Frame as a Description A Receiver Built from a Frame Description The Payload as a Data Source — the measurement record +1 more

D¶

Name	Kind	API	Guide	Gallery	Example	Design
`DDC`	class	DDC	Checkpoint & Resume Power Spectra & Measurements	Ddcr — Real Passband to Baseband	dsss_realtime_file_demod	API taxonomy: the DSP building-block hierarchy and its naming axis AsyncDsssReceiver and AsyncDsssPool — the measurement record BurstBank — the coarse-Doppler bank as one C object +6 more
`Ddcr`	class	Ddcr		Ddcr — Real Passband to Baseband	ddc_fn_demo ddc_fn_scaling	API taxonomy: the DSP building-block hierarchy and its naming axis Design — pure-functional acquisition kernel (elastic fleet) State Serialization — the standard bytes interface +2 more
`Deinterleaver`	class	Deinterleaver			interleave_burst_demo	Interleaving — spreading a burst across codewords
`DelayCf64`	class	DelayCf64				API taxonomy: the DSP building-block hierarchy and its naming axis
`DelayDoppler`	class	DelayDoppler	Delay-Doppler Search	Delay-Doppler Search	delay_doppler_bank_demo delay_doppler_batch_demo	Corr2D batches: many maps in one call Corr2D hypothesis bank: operation order Corr2D: decoupled (interpolated) inverse length +5 more
`design_lowpass`	function	design_lowpass
`Despreader`	class	Despreader	Checkpoint & Resume Lock Detection Across `doppler.track`	Full-Chain Lock-Up		AsyncDsssReceiver and AsyncDsssPool — continuous DSSS, from spec to object API taxonomy: the DSP building-block hierarchy and its naming axis
`det_cn0_to_snr`	function	det_cn0_to_snr			async_despread_demo
`det_dwell`	function	det_dwell	DSSS Burst Acquisition	Detection Theory Curves Monte Carlo vs Marcum Q Theory	detection2d_demo detection_curves	Detection Sizing — the four laws behind one prefix
`det_dwell_gauss`	function	det_dwell_gauss				Detection Sizing — the four laws behind one prefix SymbolSync Timing Lock Detector
`det_dwell_power`	function	det_dwell_power				Detection Sizing — the four laws behind one prefix
`det_ema_alpha`	function	det_ema_alpha		Lock Detection: Verify Counts + Hysteresis M-PSK Receiver — Pull-in, Lock, and BER		The Exponential Moving Average
`det_n_noncoh`	function	det_n_noncoh		CarrierAcquisition: RRC Pulse Shaping Streaming Async Despreader	async_despread_demo	Detection Sizing — the four laws behind one prefix AsyncDsssReceiver and AsyncDsssPool — continuous DSSS, from spec to object AsyncDsssReceiver and AsyncDsssPool — the measurement record +1 more
`det_pd`	function	det_pd	DSSS Burst Acquisition	Detection Theory Curves Monte Carlo vs Marcum Q Theory	detection2d_demo detection_curves detection_sim +1 more	The acquisition surface: the DSSS search engine
`det_pd_cfar`	function	det_pd_cfar
`det_pd_noncoherent`	function	det_pd_noncoherent				The acquisition surface: the DSSS search engine
`det_pd_power`	function	det_pd_power			detection_sim
`det_pfa_cell`	function	det_pfa_cell		2-D Acquisition Grid	detection2d_demo detector2d_acq_demo
`det_q_inv`	function	det_q_inv				Detection Sizing — the four laws behind one prefix SymbolSync Timing Lock Detector
`det_snr`	function	det_snr				Detection Sizing — the four laws behind one prefix
`det_snr_power`	function	det_snr_power				Detection Sizing — the four laws behind one prefix
`det_snr_to_cn0`	function	det_snr_to_cn0
`det_threshold`	function	det_threshold	DSSS Burst Acquisition	Detection Theory Curves Monte Carlo vs Marcum Q Theory	detection2d_demo detection_curves detection_sim +2 more	Detection Sizing — the four laws behind one prefix MPSK Receiver The acquisition surface: the DSSS search engine
`det_threshold_f`	function	det_threshold_f	Lock Detection Across `doppler.track`	Detection Theory Curves	detection_curves	Detection Sizing — the four laws behind one prefix
`det_threshold_gauss`	function	det_threshold_gauss				Detection Sizing — the four laws behind one prefix SymbolSync Timing Lock Detector
`det_threshold_noncoherent`	function	det_threshold_noncoherent	Lock Detection Across `doppler.track`	CarrierAcquisition: RRC Pulse Shaping Measuring an Error Rate, Defensibly	async_despread_demo detection_curves telemetry_fanin_demo	Detection Sizing — the four laws behind one prefix AsyncDsssReceiver and AsyncDsssPool — continuous DSSS, from spec to object The acquisition surface: the DSSS search engine
`det_threshold_power`	function	det_threshold_power			detection_sim	Detection Sizing — the four laws behind one prefix
`det_verify_count`	function	det_verify_count		Lock Detection: Verify Counts + Hysteresis Streaming Async Despreader	async_despread_demo lockdet_demo	Detection Sizing — the four laws behind one prefix AsyncDsssReceiver and AsyncDsssPool — continuous DSSS, from spec to object AsyncDsssReceiver and AsyncDsssPool — the measurement record +1 more
`det_verify_delay`	function	det_verify_delay		Lock Detection: Verify Counts + Hysteresis	lockdet_demo	Detection Sizing — the four laws behind one prefix MPSK Receiver
`Dll`	class	Dll	Lock Detection Across `doppler.track` DSSS Burst Acquisition	Code Loop Tracking DLL Code Loop — Theory Validation Full-Chain Lock-Up +4 more	async_despread_demo dll_demo dll_theory_demo +2 more	MPSK Receiver SymbolSync Timing Lock Detector API taxonomy: the DSP building-block hierarchy and its naming axis +5 more
`DopplerChannel`	class	DopplerChannel		Doppler Channel — Clock Doppler as a Propagation Impairment Doppler Channel — a Doppler Profile Driven by a Cosine AsyncDsssPool: ten emitters through six receivers +2 more	async_despread_demo async_dsss_pool_scene async_dsss_receiver_spec_demo +2 more
`dot_q15`	function	dot_q15	Getting Started with Fixed-Point Arithmetic
`dot_q8`	function	dot_q8	Getting Started with Fixed-Point Arithmetic
`dp_coherent_freq`	function	dp_coherent_freq				Measurement Suite — single-tone ADC / spectral metrics
`draws`	function	draws			async_dsss_receiver_spec_demo dsss_burst_ber_demo	wfmgen — the waveform generator
`dsss_spread`	function	dsss_spread		wfmgen — One Engine, Every Waveform DSSS Acquisition — Pd / Pfa vs Es/N0
`DsssBurstReceiver`	class	DsssBurstReceiver	DSSS Burst Acquisition Waveforms — what you can generate	A Message Over DSSS, Received and Deframed DsssBurstReceiver — the Composed Burst Chain A Frame You Built, Generated	data_source_link_demo dsss_burst_ber_demo dsss_burst_receiver_demo	AsyncDsssReceiver and AsyncDsssPool — continuous DSSS, from spec to object The Polynomial-Phase Estimator — the reasoning `DsssBurstReceiver`: the burst chain, composed in C +7 more
`DsssReceiver`	class	DsssReceiver	Waveforms — what you can generate	DsssBurstReceiver — the Composed Burst Chain DsssReceiver — the Composed Continuous DSSS Receiver	dsss_receiver_demo	AsyncDsssReceiver and AsyncDsssPool — continuous DSSS, from spec to object `DsssBurstReceiver`: the burst chain, composed in C API taxonomy: the DSP building-block hierarchy and its naming axis +5 more

E¶

Name	Kind	API	Example	Design
`ema_alpha_decim`	function	ema_alpha_decim	ema_demo	API taxonomy: the DSP building-block hierarchy and its naming axis The Exponential Moving Average
`ema_step`	function	ema_step	ema_demo	API taxonomy: the DSP building-block hierarchy and its naming axis The Exponential Moving Average
`ENDIAN`	constant
`EventLog`	class

F¶

Name	Kind	API	Guide	Gallery	Example	Design
`F32Buffer`	class	F32Buffer	Real-Time Pacing & Timestamping		buffers_demo ring_chunking_demo ring_interrupt_demo +3 more	The ring buffer — one contiguous view of a stream Spectrum Analyzer
`F32ToI16`	class	F32ToI16	Waveforms — what you can generate	Q15 vs UQ15 Quantization cvt Quantization Noise	q15_uq15_demo	Quantization Design
`F32ToI16U32`	class	F32ToI16U32		cvt Quantization Noise		Quantization Design API taxonomy: the DSP building-block hierarchy and its naming axis
`F32ToI16U64`	class	F32ToI16U64		cvt Quantization Noise		Quantization Design
`F32ToI32`	class
`F32ToI8`	class
`F32ToUQ15`	class	F32ToUQ15			q15_uq15_demo	Quantization Design
`F64Buffer`	class	F64Buffer	Real-Time Pacing & Timestamping		buffers_demo	The ring buffer — one contiguous view of a stream
`Farrow`	class	Farrow		Farrow Interpolator Arbitrary-Rate Symbol Recovery Symbol Timing Recovery	farrow_demo	Continuously Variable Resampler API taxonomy: the DSP building-block hierarchy and its naming axis
`FC_SOURCE`	constant
`FFT`	class	FFT	DSSS Burst Acquisition		carrier_nda_seeding_demo fft_demo measure_imd_npr_demo +2 more	Spectral & Measurement API Map The Spectrogram — chunks in, rows out API taxonomy: the DSP building-block hierarchy and its naming axis +1 more
`FFT2D`	class	FFT2D			fft_demo	API taxonomy: the DSP building-block hierarchy and its naming axis
`field_bits`	function	field_bits	Fields — bits, written as text	DsssBurstReceiver — the Composed Burst Chain	ccsds_link_demo data_source_link_demo dsss_burst_ber_demo +5 more	A Frame as a Description A Frame as a Description — the measurement record A Receiver Built from a Frame Description +2 more
`find_peaks_f32`	function	find_peaks_f32	Power Spectra & Measurements
`FIR`	class	FIR	Checkpoint & Resume		fir_demo	API taxonomy: the DSP building-block hierarchy and its naming axis Design — pure-functional acquisition kernel (elastic fleet) State Serialization — the standard bytes interface
`FOLLOW_END`	constant
`format_name`	function	format_name			receiver
`Frame`	class	Frame	Waveforms — what you can generate	A CCSDS CADU, as a Frame Description DsssBurstReceiver — the Composed Burst Chain		A Frame as a Description A Frame as a Description — the measurement record A Receiver Built from a Frame Description +4 more
`FrameCheck`	class	FrameCheck
`FrameDesc`	class	FrameDesc	Waveforms — what you can generate	A Framed Link, Checked by Its Description A CCSDS CADU, as a Frame Description A Message Over DSSS, Received and Deframed +2 more	burst_capture_demo ccsds_link_demo data_source_link_demo +8 more	A Frame as a Description A Receiver Built from a Frame Description `DsssBurstReceiver`: the burst chain, composed in C
`FrameMeter`	class	FrameMeter				Receiver Test Harness
`fromto`	function	fromto				API taxonomy: the DSP building-block hierarchy and its naming axis
`FS_SOURCE`	constant
`FTYPE`	constant

G¶

Name	Kind	API	Example	Design
`gauss_hermite`	function	gauss_hermite		API taxonomy: the DSP building-block hierarchy and its naming axis
`get_timestamp_ns`	function	get_timestamp_ns	pipeline_send receiver transmitter	Streaming — one envelope, six roles, two planes
`Gold`	class	Gold	acq_surface_demo async_despread_demo async_dsss_pool_demo +4 more

H¶

Name	Kind	API	Guide	Gallery	Example	Design
`HalfbandDecimator`	class	HalfbandDecimator			hbdecim_q15_demo	Continuously Variable Resampler API taxonomy: the DSP building-block hierarchy and its naming axis
`HalfbandDecimatorDp`	constant	HalfbandDecimatorDp
`HalfbandDecimatorQ15`	class	HalfbandDecimatorQ15	Getting Started with Fixed-Point Arithmetic	HalfbandDecimatorQ15 — Fixed-Point Halfband Decimator	hbdecim_q15_demo	API taxonomy: the DSP building-block hierarchy and its naming axis
`HalfbandDecimatorR2C`	constant	HalfbandDecimatorR2C
`hann_window`	function	hann_window
`hex_to_bin`	function	hex_to_bin				A Frame as a Description A Frame as a Description — the measurement record

I¶

Name	Kind	API	Guide	Gallery	Example	Design
`I16Buffer`	class	I16Buffer			buffers_demo ring_iq16_demo	The ring buffer — one contiguous view of a stream
`I16ToF32`	class	I16ToF32		Q15 vs UQ15 Quantization cvt Quantization Noise	q15_uq15_demo ring_iq16_demo	Capture files — one reader, one writer, four containers
`I16U32ToF32`	class	I16U32ToF32		cvt Quantization Noise
`I16U64ToF32`	class	I16U64ToF32		cvt Quantization Noise
`I32ToF32`	class	I32ToF32
`I8ToF32`	class	I8ToF32
`IMDMeasure`	class	IMDMeasure	Power Spectra & Measurements	Measurement Suite — two-tone IMD/TOI & notched-noise NPR	measure_imd_npr_demo	Measurement Suite — single-tone ADC / spectral metrics API taxonomy: the DSP building-block hierarchy and its naming axis Spectral & Measurement API Map
`IMDMetrics`	class	IMDMetrics
`int_to_bin`	function	int_to_bin
`Interleaver`	class	Interleaver			interleave_burst_demo	Interleaving — spreading a burst across codewords
`InterpolatedTable`	class	InterpolatedTable
`Interrupt`	class	Interrupt			graceful_shutdown_demo receiver ring_interrupt_demo	Ending a wait — one contract for network, memory and disk Ending a capture — spooling an endless stream to disk while reading it back Streaming — one envelope, six roles, two planes

K¶

Name	Kind	API	Example	Design
`kaiser_beta`	function	kaiser_beta		Measurement Suite — single-tone ADC / spectral metrics
`kaiser_beta_for_sidelobe`	function	kaiser_beta_for_sidelobe		Measurement Suite — single-tone ADC / spectral metrics
`kaiser_enbw`	function	kaiser_enbw
`kaiser_num_taps`	function	kaiser_num_taps
`kaiser_window`	function	kaiser_window	wcdma_carriers_demo	API taxonomy: the DSP building-block hierarchy and its naming axis

L¶

Name	Kind	API	Guide	Gallery	Example	Design
`LO`	class	LO	Field reference Scenes — composing in time Waveforms — what you can generate	AWGN Generator Carrier Loop Stress	async_despread_demo awgn_demo ddc_fn_scaling +3 more	The NCO API taxonomy: the DSP building-block hierarchy and its naming axis AsyncDsssReceiver and AsyncDsssPool — the measurement record +3 more
`LockDet`	class	LockDet		Lock Detection: Verify Counts + Hysteresis	lockdet_demo	Detection Sizing — the four laws behind one prefix API taxonomy: the DSP building-block hierarchy and its naming axis
`LoopFilter`	class	LoopFilter		Carrier Loop Stress Code Loop Tracking M-PSK Carrier Loop — Theory Validation	loop_filter_bandwidth_demo mpsk_nda_theory_demo	The Loop Filter API taxonomy: the DSP building-block hierarchy and its naming axis

M¶

Name	Kind	API	Guide	Gallery	Example	Design
`magnitude_db_cf32`	function	magnitude_db_cf32
`magnitude_db_cf64`	function	magnitude_db_cf64
`marcum_q`	function	marcum_q			detection_sim	Detection Sizing — the four laws behind one prefix AsyncDsssReceiver and AsyncDsssPool — continuous DSSS, from spec to object The acquisition surface: the DSSS search engine
`MatchedDDC`	class	MatchedDDC		M-PSK Receiver — Pull-in, Lock, and BER		MPSK Receiver One correlator: the step-3 design `BurstCapture`: acquisition's output, turned into bursts
`MatchedDdcr`	class	MatchedDdcr		M-PSK Receiver — Pull-in, Lock, and BER		API taxonomy: the DSP building-block hierarchy and its naming axis MPSK Receiver
`MatchedRateConverter`	class			Arbitrary-Rate Symbol Recovery	ratesync_demo	Waveform amplitude & composition
`mean_power`	function	mean_power			receiver
`mean_sinc`	function	mean_sinc				API taxonomy: the DSP building-block hierarchy and its naming axis
`measure_min_samples`	function	measure_min_samples				Measurement Suite — single-tone ADC / spectral metrics
`measure_proc_gain`	function	measure_proc_gain
`measure_rec_nfft`	function	measure_rec_nfft
`MemoryCapture`	class			Capturing All Receiver Telemetry AsyncDsssReceiver: a signal's lifecycle M-PSK Receiver — Sizing the Carrier Loop, and Riding a Doppler Profile	async_dsss_receiver_lifecycle mpsk_doppler_profile_demo mpsk_telemetry_capture_demo	Telemetry — zero-cost scalar taps for running pipelines `DsssBurstReceiver`: the burst chain, composed in C
`midpoint_nodes`	function	midpoint_nodes				API taxonomy: the DSP building-block hierarchy and its naming axis
`mls_poly`	function	mls_poly		wfmgen — One Engine, Every Waveform	detector2d_acq_demo dll_theory_demo
`MovingAverage`	class	MovingAverage				API taxonomy: the DSP building-block hierarchy and its naming axis
`mpsk_bits_per_symbol`	function	mpsk_bits_per_symbol			mpsk_constellation_demo
`mpsk_demap`	function	mpsk_demap		M-PSK constellation (Gray-coded map / demap)	framed_link_demo mpsk_constellation_demo	MPSK Receiver The Viterbi Decoder
`mpsk_diff_demap`	function	mpsk_diff_demap		M-PSK Carrier Loop — Theory Validation		MPSK Receiver
`mpsk_diff_map`	function	mpsk_diff_map				MPSK Receiver
`mpsk_map`	function	mpsk_map		M-PSK constellation (Gray-coded map / demap)	carrier_nda_seeding_demo mpsk_carrier_theory_demo mpsk_constellation_demo +1 more	MPSK Receiver
`mpsk_soft_demap`	function	mpsk_soft_demap		DsssBurstReceiver — the Composed Burst Chain		MPSK Receiver The FEC Receive Half The Viterbi Decoder
`MpskReceiver`	class		Lock Detection Across `doppler.track` Waveforms — what you can generate	Arbitrary-Rate Symbol Recovery M-PSK Receiver — Performance Characterisation M-PSK Receiver — Pull-in, Lock, and BER +3 more	framed_link_demo mpsk_doppler_profile_demo mpsk_receiver_demo +2 more	MPSK Receiver Receiver Test Harness Symbol Timing on a Rate Cascade +7 more
`MpskReceiverR`	class			M-PSK Receiver — Performance Characterisation M-PSK Receiver — Pull-in, Lock, and BER	mpsk_receiver_performance_demo	MPSK Receiver API taxonomy: the DSP building-block hierarchy and its naming axis Lock Detection — the reasoning +1 more
`mul_q15`	function	mul_q15	Getting Started with Fixed-Point Arithmetic
`mul_q8`	function	mul_q8

N¶

Name	Kind	API	Guide	Gallery	Example	Design
`NCO`	class	NCO			nco_demo	The NCO API taxonomy: the DSP building-block hierarchy and its naming axis Automatic Gain Control +3 more
`next_pow_two`	function		Power Spectra & Measurements			API taxonomy: the DSP building-block hierarchy and its naming axis Spectrum Analyzer The Polynomial-Phase Estimator — the reasoning +1 more
`noise`	function		Field reference Scenes — composing in time Waveforms — what you can generate	Composing a Scene — `.sum()`, `.add()`, and Headroom A Streaming Spectrogram AsyncDsssReceiver: a signal's lifecycle +1 more	async_despread_demo async_dsss_receiver_lifecycle awgn_demo +13 more	Waveform amplitude & composition Detection Sizing — the four laws behind one prefix One correlator: the step-3 design +1 more
`noise_floor_db`	function	noise_floor_db
`NPRMeasure`	class	NPRMeasure	Power Spectra & Measurements	Measurement Suite — two-tone IMD/TOI & notched-noise NPR	measure_imd_npr_demo	Measurement Suite — single-tone ADC / spectral metrics API taxonomy: the DSP building-block hierarchy and its naming axis Spectral & Measurement API Map
`NPRMetrics`	class	NPRMetrics
`nrz_to_bin`	function	nrz_to_bin

O¶

Name	Kind	API	Guide	Gallery	Example	Design
`obw_from_power`	function	obw_from_power

P¶

Name	Kind	API	Guide	Gallery	Example	Design
`PersistentBurstCapture`	class	PersistentBurstCapture	Acquiring a Repeated Preamble			BurstBank — the coarse-Doppler bank as one C object One Python class: the step-4 design `BurstCapture`: acquisition's output, turned into bursts +1 more
`Plan`	class	Plan	Scenes — composing in time Waveforms — what you can generate	A Crowded Band — Many Signals, One Parallel `prepare` One Cache Slot for a Whole Background Field DsssBurstReceiver — the Composed Burst Chain		wfmgen — the waveform generator API taxonomy: the DSP building-block hierarchy and its naming axis BurstBank — the coarse-Doppler bank as one C object +1 more
`PlanFromBlob`	function	PlanFromBlob	Scenes — composing in time
`PlanFromFile`	function	PlanFromFile	Scenes — composing in time
`PN`	class	PN		AsyncDsssReceiver: the specification link	async_dsss_receiver_spec_demo burst_capture_demo carrier_nda_seeding_demo +8 more	A Frame as a Description A Frame as a Description — the measurement record API taxonomy: the DSP building-block hierarchy and its naming axis
`pn`	function		Field reference Fields — bits, written as text Scenes — composing in time +1 more	wfmgen — One Engine, Every Waveform DSSS Acquisition — Pd / Pfa vs Es/N0 DsssBurstReceiver — the Composed Burst Chain		A Frame as a Description A Frame as a Description — the measurement record A Receiver Built from a Frame Description +4 more
`PolynomialPhaseEstimate`	class
`PolynomialPhaseEstimator`	class	PolynomialPhaseEstimator				The Polynomial-Phase Estimator — the reasoning API taxonomy: the DSP building-block hierarchy and its naming axis One correlator: the step-3 design
`PoolReceiverStatus`	class	PoolReceiverStatus
`power_to_db_f32`	function	power_to_db_f32			spectrogram_demo
`prepare`	function	prepare	Scenes — composing in time Waveforms — what you can generate	A Crowded Band — Many Signals, One Parallel `prepare` One Cache Slot for a Whole Background Field	crowded_band_demo dsss_burst_ber_demo plan_background_demo	wfmgen — the waveform generator BurstBank — the coarse-Doppler bank as one C object The Doppler channel — one parameter, both clocks and the carrier
`PSD`	class	PSD	Power Spectra & Measurements Streaming Spectrograms	Four WCDMA Carriers — `PSD`, `band_power`, `AccTrace` CarrierAcquisition: RRC Pulse Shaping	carrier_acq_rrc_demo dsss_burst_demo plan_background_demo +3 more	Spectral & Measurement API Map The Spectrogram — chunks in, rows out The Spectrogram — the measurement record +1 more
`PSD_WINDOW`	constant
`Publisher`	class	Publisher			transmitter	Streaming — one envelope, six roles, two planes Telemetry — zero-cost scalar taps for running pipelines
`Pull`	class	Pull			pipeline_recv work_queue_shutdown_demo	Streaming — one envelope, six roles, two planes Spectrum Analyzer The Spectrogram — the measurement record
`Push`	class	Push			pipeline_send work_queue_shutdown_demo	Streaming — one envelope, six roles, two planes

Q¶

Name	Kind	API	Guide	Gallery	Example	Design
`qpsk`	function		Field reference Scenes — composing in time Waveforms — what you can generate	A Crowded Band — Many Signals, One Parallel `prepare` type="symbols" — Bring Your Own Constellation Four WCDMA Carriers — `PSD`, `band_power`, `AccTrace`	crowded_band_demo plan_background_demo symbols_demo +4 more	One home for the waveform enum tables Waveform amplitude & composition wfmgen — the waveform generator
`qpsk_map`	function	qpsk_map

R¶

Name	Kind	API	Guide	Gallery	Example	Design
`RateConverter`	class	RateConverter		RateConverter — Automatic Cascade Selection DsssReceiver — the Composed Continuous DSSS Receiver	rate_converter_demo	CIC Decimator — the fixed-point input budget Continuously Variable Resampler API taxonomy: the DSP building-block hierarchy and its naming axis +8 more
`RateSync`	class	RateSync		Arbitrary-Rate Symbol Recovery M-PSK Receiver — Pull-in, Lock, and BER	ratesync_demo	MPSK Receiver Symbol Timing on a Rate Cascade The Loop Filter +2 more
`rc_h`	function	rc_h			symsync_demo
`Reader`	class	Reader	Reading captures Waveforms — what you can generate Writing captures — output & file types	Waveform I/O — One Capture, Four File Types	wfm_io_demo	Capture files — one reader, one writer, four containers wfmgen — the waveform generator Telemetry — zero-cost scalar taps for running pipelines +1 more
`ReceiverStatus`	class	ReceiverStatus
`ReedSolomon`	class	ReedSolomon		Name Your Own Code — and What Happens Past the Radius DsssBurstReceiver — the Composed Burst Chain	coding_demo interleave_burst_demo
`Replier`	class	Replier			replier	Streaming — one envelope, six roles, two planes
`Requester`	class	Requester			requester	Streaming — one envelope, six roles, two planes
`Resampler`	class	Resampler		RateConverter — Automatic Cascade Selection Arbitrary-Rate Symbol Recovery Doppler Channel — Clock Doppler as a Propagation Impairment		CIC Decimator — the fixed-point input budget Continuously Variable Resampler API taxonomy: the DSP building-block hierarchy and its naming axis +3 more
`rotate`	function
`rrc_h`	function	rrc_h			ratesync_demo
`rrc_taps`	function	rrc_taps		wfmgen — One Engine, Every Waveform CarrierAcquisition: RRC Pulse Shaping	carrier_acq_rrc_demo wfm_rrc_response	MPSK Receiver Receiver Test Harness

S¶

Name	Kind	API	Guide	Gallery	Example	Design
`SAMPLE_MODE`	constant
`SampleClock`	class	SampleClock	Scenes — composing in time Real-Time Pacing & Timestamping	Waveform I/O — One Capture, Four File Types	async_dsss_receiver_lifecycle mpsk_doppler_profile_demo mpsk_telemetry_capture_demo +1 more	Telemetry — zero-cost scalar taps for running pipelines
`saturate`	function	saturate		Lock Detection: Verify Counts + Hysteresis		API taxonomy: the DSP building-block hierarchy and its naming axis The Exponential Moving Average Automatic Gain Control +1 more
`Segment`	class	Segment	Scenes — composing in time Waveforms — what you can generate	A Crowded Band — Many Signals, One Parallel `prepare` Composing a Scene — `.sum()`, `.add()`, and Headroom type="symbols" — Bring Your Own Constellation +1 more	acq_surface_demo burst_capture_demo costas_demo +21 more	A Frame as a Description Waveform amplitude & composition wfmgen — the waveform generator +2 more
`settling_samples`	function	settling_samples
`shl_i64`	function	shl_i64
`shl_q15`	function	shl_q15	Getting Started with Fixed-Point Arithmetic
`shl_q8`	function	shl_q8
`shr_i64`	function	shr_i64
`shr_q15`	function	shr_q15	Getting Started with Fixed-Point Arithmetic
`shr_q8`	function	shr_q8
`simpson_weights`	function	simpson_weights				API taxonomy: the DSP building-block hierarchy and its naming axis
`sinc`	function	sinc	Waveforms — what you can generate		symsync_theory_demo	API taxonomy: the DSP building-block hierarchy and its naming axis AsyncDsssReceiver and AsyncDsssPool — continuous DSSS, from spec to object BurstBank — the coarse-Doppler bank as one C object +1 more
`snr_data_aided_db`	function	snr_data_aided_db				Receiver Test Harness
`snr_data_aided_db_series`	function	snr_data_aided_db_series
`snr_m2m4_db`	function	snr_m2m4_db		AsyncDsssReceiver: the specification link M-PSK Receiver — Pull-in, Lock, and BER	async_dsss_receiver_spec_demo	Receiver Test Harness
`snr_m2m4_db_series`	function	snr_m2m4_db_series
`Specan`	class	Specan	Power Spectra & Measurements			Spectrum Analyzer API taxonomy: the DSP building-block hierarchy and its naming axis Spectral & Measurement API Map +1 more
`Spectrogram`	class	Spectrogram	Streaming Spectrograms	A Streaming Spectrogram	dsss_burst_demo spectrogram_demo wfm_composition_demo	The Spectrogram — chunks in, rows out Spectrum Analyzer
`SPECTROGRAM_MODE`	constant
`square_clip`	function	square_clip				API taxonomy: the DSP building-block hierarchy and its naming axis
`STAGE_CONV`	constant				ccsds_link_demo
`STAGE_CRC16`	constant				burst_capture_demo data_source_link_demo dsss_burst_receiver_demo +4 more
`STAGE_INTERLEAVE`	constant
`STAGE_RANDOMISE`	constant				ccsds_link_demo
`STAGE_RS`	constant				ccsds_link_demo
`STAGE_USER`	constant				frame_own_stage_demo
`StreamSink`	class	StreamSink	Real-Time Pacing & Timestamping	Waveform I/O — One Capture, Four File Types wfmgen — One Engine, Every Waveform	graceful_shutdown_demo wfm_realtime_stream
`STYPE`	constant
`sub_q15`	function	sub_q15	Getting Started with Fixed-Point Arithmetic
`sub_q8`	function	sub_q8
`Subscriber`	class	Subscriber		Waveform I/O — One Capture, Four File Types	graceful_shutdown_demo receiver wfm_realtime_stream	Streaming — one envelope, six roles, two planes Telemetry — zero-cost scalar taps for running pipelines The Spectrogram — the measurement record
`SymbolSync`	class	SymbolSync	Lock Detection Across `doppler.track`	Arbitrary-Rate Symbol Recovery Full-Chain Lock-Up Symbol Timing Recovery +1 more	receiver_lock_demo symsync_demo symsync_theory_demo	MPSK Receiver Symbol Timing on a Rate Cascade SymbolSync Timing Lock Detector +2 more
`SyncFinder`	class	SyncFinder		Name Your Own Code — and What Happens Past the Radius	coding_demo	API taxonomy: the DSP building-block hierarchy and its naming axis
`SyncHit`	class	SyncHit
`Synth`	class	Synth	Scenes — composing in time Waveforms — what you can generate	type="symbols" — Bring Your Own Constellation wfmgen — One Engine, Every Waveform AsyncDsssPool: emitters that come and go +5 more	async_despread_demo async_dsss_pool_demo async_dsss_pool_scene +6 more	A Frame as a Description The Payload as a Data Source Waveform amplitude & composition +4 more

T¶

Name	Kind	API	Guide	Gallery	Example	Design
`T0_SOURCE`	constant
`Telemetry`	class	Telemetry		Capturing All Receiver Telemetry Telemetry: Many Emitters, One Consumer Full-Chain Lock-Up +1 more	acq_surface_demo async_dsss_receiver_lifecycle carrier_nda_seeding_demo +5 more	Telemetry — zero-cost scalar taps for running pipelines AsyncDsssReceiver and AsyncDsssPool — the measurement record Automatic Gain Control +1 more
`TelemetryStats`	class	TelemetryStats
`Timeline`	class	Timeline	Scenes — composing in time			wfmgen — the waveform generator API taxonomy: the DSP building-block hierarchy and its naming axis
`TimeStats`	class	TimeStats
`TLM16`	constant			Capturing All Receiver Telemetry Telemetry: Many Emitters, One Consumer		Streaming — one envelope, six roles, two planes Telemetry — zero-cost scalar taps for running pipelines
`tone`	function		Field reference Waveforms — what you can generate	A Streaming Spectrogram	carrier_acq_rrc_demo ddc_fn_demo fir_demo +4 more	Waveform amplitude & composition
`ToneMeasure`	class	ToneMeasure	Power Spectra & Measurements	Measurement Suite — ADC characterisation	measure_demo	Measurement Suite — single-tone ADC / spectral metrics API taxonomy: the DSP building-block hierarchy and its naming axis Spectral & Measurement API Map
`ToneMetrics`	class			Measurement Suite — ADC characterisation

U¶

Name	Kind	API	Guide	Gallery	Example	Design
`U8ToF32`	class	U8ToF32				API taxonomy: the DSP building-block hierarchy and its naming axis
`UQ15ToF32`	class	UQ15ToF32			q15_uq15_demo	Quantization Design

V¶

Name	Kind	API	Guide	Gallery	Example	Design
`Viterbi`	class	Viterbi		Name Your Own Code — and What Happens Past the Radius A CCSDS CADU, as a Frame Description DsssBurstReceiver — the Composed Burst Chain	coding_demo	Reed-Solomon The FEC Receive Half The Viterbi Decoder

W¶

Name	Kind	API	Guide	Gallery	Example	Design
`wfm_awgn_amplitude`	function	wfm_awgn_amplitude		AsyncDsssReceiver: a signal's lifecycle AsyncDsssReceiver: the specification link	async_despread_demo async_dsss_pool_demo async_dsss_pool_scene +4 more	Waveform amplitude & composition wfmgen — the waveform generator
`wfm_ebno_to_snr_db`	function	wfm_ebno_to_snr_db				Waveform amplitude & composition
`WORK_QUEUE_MAX_ACK_PENDING`	constant
`write_blue_header`	function	write_blue_header		Waveform I/O — One Capture, Four File Types
`Writer`	class	Writer	Reading captures Waveforms — what you can generate Writing captures — output & file types	Composing a Scene — `.sum()`, `.add()`, and Headroom Waveform I/O — One Capture, Four File Types type="symbols" — Bring Your Own Constellation +1 more	wfm_composition_demo wfm_io_demo	Capture files — one reader, one writer, four containers wfmgen — the waveform generator Telemetry — zero-cost scalar taps for running pipelines

_¶

Name	Kind	API	Guide	Gallery	Example	Design
`_sweep_ends`	function
`_SynthEngine`	class		Waveforms — what you can generate			The Payload as a Data Source Waveform amplitude & composition