view doc/interpreter/signal.txi @ 20628:3af34e1ef330

Preliminary inclusion of uixx objects properties in the manual (bug #46076) * doc/interpreter/genpropdoc.m: add uixx objects to the list of supported graphics objects * doc/interpreter/genpropdoc.m (get_doc): add uixx objects and their specific properties (currently empty documentation) * doc/interpreter/plot.txi("Interacting with Plots"): add a note and a reference about ui* family of functions. * doc/interpreter/plot.txi("Interacting with Plots"): for consistency, remove "uimenu" reference. All the other uixx are already in the gui section * doc/interpreter/plot.txi("graphics data structure"): add uixx objects * doc/interpreter/gui.txi("UI Elements"): add "uimenu" function reference * doc/module.mk: add rules to build uixx properties texi files. * graphics.in.h: make uixx "__object__" property (Octave internal) hidden so that it does not appear in the documentation.
author Pantxo Diribarne <pantxo.diribarne@gmail.com>
date Fri, 09 Oct 2015 16:25:27 +0200
parents 4197fc428c7d
children
line wrap: on
line source

@c Copyright (C) 1996-2015 John W. Eaton
@c
@c This file is part of Octave.
@c
@c Octave is free software; you can redistribute it and/or modify it
@c under the terms of the GNU General Public License as published by the
@c Free Software Foundation; either version 3 of the License, or (at
@c your option) any later version.
@c
@c Octave is distributed in the hope that it will be useful, but WITHOUT
@c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
@c FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
@c for more details.
@c
@c You should have received a copy of the GNU General Public License
@c along with Octave; see the file COPYING.  If not, see
@c <http://www.gnu.org/licenses/>.

@node Signal Processing
@chapter Signal Processing

This chapter describes the signal processing and fast Fourier
transform functions available in Octave.  Fast Fourier transforms are
computed with the @sc{fftw} or @sc{fftpack} libraries depending on how
Octave is built.

@DOCSTRING(fft)

@DOCSTRING(ifft)

@DOCSTRING(fft2)

@DOCSTRING(ifft2)

@DOCSTRING(fftn)

@DOCSTRING(ifftn)

Octave uses the @sc{fftw} libraries to perform FFT computations.  When Octave
starts up and initializes the @sc{fftw} libraries, they read a system wide
file (on a Unix system, it is typically @file{/etc/fftw/wisdom}) that
contains information useful to speed up FFT computations.  This
information is called the @emph{wisdom}.  The system-wide file allows
wisdom to be shared between all applications using the @sc{fftw} libraries.

Use the @code{fftw} function to generate and save wisdom.  Using the
utilities provided together with the @sc{fftw} libraries
(@command{fftw-wisdom} on Unix systems), you can even add wisdom
generated by Octave to the system-wide wisdom file.

@DOCSTRING(fftw)

@DOCSTRING(fftconv)

@DOCSTRING(fftfilt)

@DOCSTRING(filter)

@DOCSTRING(filter2)

@DOCSTRING(freqz)

@DOCSTRING(freqz_plot)

@DOCSTRING(sinc)

@DOCSTRING(unwrap)

@c FIXME: someone needs to organize these ...

@DOCSTRING(arch_fit)

@DOCSTRING(arch_rnd)

@DOCSTRING(arch_test)

@DOCSTRING(arma_rnd)

@DOCSTRING(autoreg_matrix)

@DOCSTRING(bartlett)

@DOCSTRING(blackman)

@DOCSTRING(detrend)

@DOCSTRING(diffpara)

@DOCSTRING(durbinlevinson)

@DOCSTRING(fftshift)

@DOCSTRING(ifftshift)

@DOCSTRING(fractdiff)

@DOCSTRING(hamming)

@DOCSTRING(hanning)

@DOCSTRING(hurst)

@DOCSTRING(pchip)

@DOCSTRING(periodogram)

@DOCSTRING(sinetone)

@DOCSTRING(sinewave)

@DOCSTRING(spectral_adf)

@DOCSTRING(spectral_xdf)

@DOCSTRING(spencer)

@DOCSTRING(stft)

@DOCSTRING(synthesis)

@DOCSTRING(yulewalker)