fftw

README

hz.tools/fftw

This only supports single-precision floating point math for now.

Documentation

Index

• Variables
• func Plan(iq sdr.SamplesC64, frequency []complex64, direction fft.Direction, ...) (fft.Plan, error)
• func ThreadsafePlanner(ctx context.Context) fft.Planner
• type RealPlan
  • func PlanReal(samples []float32, frequency []complex64, direction fft.Direction, ...) (RealPlan, error)

Variables

var (
	// OptNoScale if passed via `opts`, will leave the values unscaled by the
	// length of the vector. This means values returned will *not* be between
	// the range of -1 to +1.
	OptNoScale opt = 1
)

Functions

func Plan

func Plan(
	iq sdr.SamplesC64,
	frequency []complex64,
	direction fft.Direction,
	opts interface{},
) (fft.Plan, error)

Plan will create a hz.tools/sdr/fft.Plan to be used to preform frequency-to-time or time-to-frequency conversions of complex data.

func ThreadsafePlanner

func ThreadsafePlanner(ctx context.Context) fft.Planner

ThreadsafePlanner will span a goroutine, lock to a single thread, and conduct all FFT planning on that thread. This must be used in places where concurency is a requirement.

Types

type RealPlan

type RealPlan interface {
	Transform() error
	Close() error
}

RealPlan is the same thing to an fft.Plan, but I also don't want to have anyone confuse this for an fft.Plan once returned. As such I'm making a new type to make it less confusing in docstrings, even though this is the same type interface. D'oh.

func PlanReal

func PlanReal(
	samples []float32,
	frequency []complex64,
	direction fft.Direction,
	opts interface{},
) (RealPlan, error)

PlanReal will create an interface similar to a hz.tools/sdr/fft.Plan to except it's used for real-data to frequency conversions.