The bordeaux-fft Reference Manual

Table of Contents

The bordeaux-fft Reference Manual

This is the bordeaux-fft Reference Manual, version 1.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Apr 28 10:37:45 2020 GMT+0.

1 Introduction

Bordeaux FFT Library

The Bordeaux FFT library implements the following:

• Forward and inverse FFT for arrays of complex samples
• Windowed FFT with a selection of window functions (Hann, Blackman, etc.)

The manual is available online at http://vintage-digital.com/hefner/software/bordeaux-fft/manual.html

Source code is maintained on github

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 bordeaux-fft

Author

Various

License

GNU Public License version 2

Description

An efficient and portable implementation of the Fast Fourier Transform

Version

1.0.1

Source

bordeaux-fft.asd (file)

Component

fft.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 bordeaux-fft.asd

Location

bordeaux-fft.asd

Systems

bordeaux-fft (system)

3.1.2 bordeaux-fft/fft.lisp

Parent

bordeaux-fft (system)

Location

fft.lisp

Packages

bordeaux-fft

Exported Definitions

• *fft-instance* (special variable)
• *ifft-instance* (special variable)
• bartlett (function)
• blackman (function)
• blackman-harris (function)
• complex-sample (type)
• complex-sample-array (type)
• extract-centered-window (function)
• extract-centered-window-into (function)
• extract-window (function)
• extract-window-into (function)
• fft (function)
• fft! (function)
• gaussian (function)
• gaussian*bartlett^x (function)
• hann (function)
• ifft (function)
• ifft! (function)
• rectangular (function)
• sfft (function)
• sifft (function)
• triangle (function)
• window-vector (function)
• windowed-fft (function)

Internal Definitions

• blackman* (function)
• clip-in-window (function)
• convert-to-complex-sample-array (function)
• cosine-series (function)
• fft-common (function)
• fft-instance (class)
• gauss* (function)
• ifft-common (function)
• make-fft-instance (function)
• make-fourier-instance (function)
• make-ifft-instance (function)
• power-of-two (function)
• size (method)
• with-fft-instance (macro)

4 Packages

Packages are listed by definition order.

4.1 bordeaux-fft

Source

fft.lisp (file)

Use List

common-lisp

Exported Definitions

• *fft-instance* (special variable)
• *ifft-instance* (special variable)
• bartlett (function)
• blackman (function)
• blackman-harris (function)
• complex-sample (type)
• complex-sample-array (type)
• extract-centered-window (function)
• extract-centered-window-into (function)
• extract-window (function)
• extract-window-into (function)
• fft (function)
• fft! (function)
• gaussian (function)
• gaussian*bartlett^x (function)
• hann (function)
• ifft (function)
• ifft! (function)
• rectangular (function)
• sfft (function)
• sifft (function)
• triangle (function)
• window-vector (function)
• windowed-fft (function)

Internal Definitions

• blackman* (function)
• clip-in-window (function)
• convert-to-complex-sample-array (function)
• cosine-series (function)
• fft-common (function)
• fft-instance (class)
• gauss* (function)
• ifft-common (function)
• make-fft-instance (function)
• make-fourier-instance (function)
• make-ifft-instance (function)
• power-of-two (function)
• size (generic function)
• size (method)
• with-fft-instance (macro)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *fft-instance*

Package

bordeaux-fft

Source

fft.lisp (file)

Special Variable: *ifft-instance*

Package

bordeaux-fft

Source

fft.lisp (file)

5.1.2 Functions

Function: bartlett I N

Package

bordeaux-fft

Source

fft.lisp (file)

Function: blackman I N

Package

bordeaux-fft

Source

fft.lisp (file)

Function: blackman-harris I N

Package

bordeaux-fft

Source

fft.lisp (file)

Function: extract-centered-window VECTOR CENTER SIZE &optional ELEMENT-TYPE

Extract a subsequence of SIZE from VECTOR, centered on CENTER and padding with zeros beyond the edges of the vector.

Package

bordeaux-fft

Source

fft.lisp (file)

Function: extract-centered-window-into VECTOR CENTER SIZE DESTINATION

Extract a subsequence of SIZE from VECTOR, centered on OFFSET and padding with zeros beyond the boundaries of the vector, storing it to DESTINATION.

Package

bordeaux-fft

Source

fft.lisp (file)

Function: extract-window VECTOR START LENGTH &optional ELEMENT-TYPE

Package

bordeaux-fft

Source

fft.lisp (file)

Function: extract-window-into VECTOR START LENGTH DESTINATION

Copy an extent of VECTOR to DESTINATION. Outside of its legal array indices, VECTOR is considered to be zero.

Package

bordeaux-fft

Source

fft.lisp (file)

Function: fft SOURCE

Returns the Fourier transform of source, allocating a new array for the result.

Package

bordeaux-fft

Source

fft.lisp (file)

Function: fft! SOURCE DEST

Destructive version of fft, since it fills dest.

Package

bordeaux-fft

Source

fft.lisp (file)

Function: gaussian SIGMA

Package

bordeaux-fft

Source

fft.lisp (file)

Function: gaussian*bartlett^x SIGMA TRIANGLE-EXPONENT

Package

bordeaux-fft

Source

fft.lisp (file)

Function: hann I N

Package

bordeaux-fft

Source

fft.lisp (file)

Function: ifft SOURCE

Returns the inverse Fourier transform of source, allocating a new array for the result.

Package

bordeaux-fft

Source

fft.lisp (file)

Function: ifft! SOURCE DEST

Destructive version of ifft, since it fills dest.

Package

bordeaux-fft

Source

fft.lisp (file)

Function: rectangular I N

Package

bordeaux-fft

Source

fft.lisp (file)

Function: sfft SOURCE &optional LEN

This is the generic fft function. Stands for stupid fft. Can take any kind of array as input.

Package

bordeaux-fft

Source

fft.lisp (file)

Function: sifft SOURCE

This is the generic fft function. Stands for stupid fft. Can take any kind of array as input.

Package

bordeaux-fft

Source

fft.lisp (file)

Function: triangle I N

Package

bordeaux-fft

Source

fft.lisp (file)

Function: window-vector FUNCTION N

Package

bordeaux-fft

Source

fft.lisp (file)

Function: windowed-fft SIGNAL-VECTOR CENTER LENGTH &optional WINDOW-FN

Perform an FFT on the window of a signal, centered on the given index, multiplied by a window generated by the chosen window function

Package

bordeaux-fft

Source

fft.lisp (file)

5.1.3 Types

Type: complex-sample ()

Package

bordeaux-fft

Source

fft.lisp (file)

Type: complex-sample-array ()

Package

bordeaux-fft

Source

fft.lisp (file)

5.2 Internal definitions

5.2.1 Macros

Macro: with-fft-instance INSTANCE SIZE &body BODY

Package

bordeaux-fft

Source

fft.lisp (file)

5.2.2 Functions

Function: blackman* ALPHA I N

Package

bordeaux-fft

Source

fft.lisp (file)

Function: clip-in-window X START END

Package

bordeaux-fft

Source

fft.lisp (file)

Function: convert-to-complex-sample-array ARRAY

Package

bordeaux-fft

Source

fft.lisp (file)

Function: cosine-series I N A0 A1 A2 A3

Package

bordeaux-fft

Source

fft.lisp (file)

Function: fft-common INSTANCE SOURCE DEST

Package

bordeaux-fft

Source

fft.lisp (file)

Function: gauss* SIGMA I N

Package

bordeaux-fft

Source

fft.lisp (file)

Function: ifft-common INSTANCE SOURCE DEST

Package

bordeaux-fft

Source

fft.lisp (file)

Function: make-fft-instance SIZE

Package

bordeaux-fft

Source

fft.lisp (file)

Function: make-fourier-instance SIZE DIRECTION

Package

bordeaux-fft

Source

fft.lisp (file)

Function: make-ifft-instance SIZE

Package

bordeaux-fft

Source

fft.lisp (file)

Function: power-of-two X

Package

bordeaux-fft

Source

fft.lisp (file)

5.2.3 Generic functions

Generic Function: size OBJECT

Package

bordeaux-fft

Methods

Method: size (FFT-INSTANCE fft-instance)

automatically generated reader method

Source

fft.lisp (file)

5.2.4 Classes

Class: fft-instance ()

Package

bordeaux-fft

Source

fft.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

size (method)

Direct slots

Slot: size

Initargs

:size

Readers

size (generic function)

Slot: inter

Initargs

:inter

Slot: coeffs

Initargs

:coeffs

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types