signal/COPYING 0000644 0000000 0000000 00000104513 12124117010 011505 0 ustar 0000000 0000000 GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
Copyright (C)
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
.
signal/DESCRIPTION 0000644 0000000 0000000 00000000765 12124117010 012164 0 ustar 0000000 0000000 Name: Signal
Version: 1.2.2
Date: 2013-03-25
Author: various authors
Maintainer: Octave-Forge community
Title: Signal Processing.
Description: Signal processing tools, including filtering, windowing and display functions.
Depends: octave (>= 3.6.0), specfun, control (>= 2.2.3), general (>= 1.3.2)
## depends on specfun because of ellipke. When it moves to octave core, dependency can be removed
Autoload: no
License: GPLv3+, public domain
Url: http://octave.sf.net
signal/INDEX 0000644 0000000 0000000 00000002773 12124117010 011251 0 ustar 0000000 0000000 signal >> Signal processing
Signals
diric
gauspuls
gmonopuls
pulstran
tripuls
rectpuls
sawtooth
square
chirp
specgram
buffer
mexihat
meyeraux
morlet
shanwavf
cmorwavf
sigmoid_train
Filtering
filtfilt
filtic
sgolayfilt
sosfilt
medfilt1
movingrms
Filter analysis
freqs freqs_plot
grpdelay
impz
zplane
fwhm
Filter conversion
convmtx
residuez
residued
sos2tf
sos2zp
ss2tf
ss2zp
tf2sos
tf2ss
tf2zp
zp2sos
zp2ss
zp2tf
polystab
IIR Filter design
besself
buttap
butter
cheb
cheb1ap
cheb2ap
cheby1
cheby2
ellipap
ellip
ncauer
buttord
cheb1ord
cheb2ord
ellipord
besselap
sftrans
bilinear
impinvar
invimpinvar
iirlp2mb
pei_tseng_notch
FIR filter design
fir1
fir2
firls
kaiserord
remez
sgolay
qp_kaiser
cl2bp
Transforms
czt
dctmtx
dct2
idct2
dct
idct
dst
idst
dftmtx
hilbert
rceps
cceps
cplxreal
bitrevorder
dwt
fht
ifht
fwht
ifwht
Power spectrum analysis
pwelch
tfe
tfestimate
cohere
csd
ar_psd
cpsd
mscohere
pburg
pyulear
xcorr
xcorr2
xcov
__power
Window functions
window
barthannwin
blackmanharris
blackmannuttall
bohmanwin
boxcar
chebwin flattopwin
hann
kaiser
nuttallwin
triang
gaussian
gausswin
tukeywin
rectwin
welchwin
parzenwin
System identification
arburg
aryule
invfreq
invfreqs
invfreqz
levinson
Sample rate change
decimate
interp
downsample
upsample
resample
upfirdn
data2fun
Utility
buffer
findpeaks
fracshift
marcumq
wkeep
wrev
zerocrossing
sampled2continuous
schtrig
clustersegment
signal/NEWS 0000644 0000000 0000000 00000010610 12124117010 011143 0 ustar 0000000 0000000 Summary of important user-visible changes for releases of the signal package
===============================================================================
signal-1.2.2 Release Date: 2013-03-25 Release Manager: Mike Miller
===============================================================================
** No change release to correct bad file permissions on previous release.
===============================================================================
signal-1.2.1 Release Date: 2013-03-17 Release Manager: Mike Miller
===============================================================================
** The following functions are new:
buttap
cheb1ap
cheb2ap
ellipap
findpeaks
fwht
ifwht
** Improved Matlab compatibility for the following window functions:
barthannwin
blackmanharris
blackmannuttall
chebwin
flattopwin
nuttallwin
The changes include always returning a column vector, returning a valid
window for a length argument of 1, and making all arguments after the
length optional.
** Minor updates to documentation for the following functions:
cpsd
mscohere
sos2tf
sos2zp
tfestimate
zp2sos
** signal is no longer dependent on the optim package.
===============================================================================
signal-1.2.0 Release Date: 2012-09-21 Release Manager: Carnë Draug
===============================================================================
** Improved Matlab compability for the function `fir2'. This changes include
always returning vaues in a row (even when the smoothing window is a single
column), the default values for grid_n and ramp_n, and returning an error
when invalid values are used (instead of silently adjusting them).
** Fixed failing tests for the following functions:
fir1 pei_tseng_notch residued
** The function `rceps' was fixed to work correctly with odd-length inputs.
** Bugfix in `xcorr2' introduced in 1.1.2 that would not accept "none" as
scale option.
** `xcorr2' scaling option "coeff" was changed to return the normalized
cross-correlation.
** The following functions are new:
movingrms schtrig clustersegment
** signal is no longer dependent on the image package.
** signal is now dependent on the general package.
===============================================================================
signal-1.1.3 Release Date: 2012-05-12 Release Manager: Carnë Draug
===============================================================================
** signal is no longer dependent on the audio package.
** signal is now dependent on the image package.
** The function `marcumq' was imported from the communications package and has
been completely rewritten to improve performance and fix computational
errors.
** Package is no longer automatically loaded.
** The functions `__ellip_ws' and `__ellip_ws_min' have been removed (they
are now subfunctions of `ncauer'.
** The function `blackmanharris' was fixed to have even symmetry.
===============================================================================
signal-1.1.2 Release Date: 2012-01-06 Release Manager: Lukas Reichlin
===============================================================================
* Added the following filter conversion functions:
ss2tf
ss2zp
tf2ss
tf2zp
zp2ss
zp2tf
===============================================================================
signal-1.1.1 Release Date: 2011-11-06 Release Manager: Juan Pablo Carbajal
===============================================================================
* Following function now show help text correctly instead of copyright notice:
downsample
dst
flattopwin
fwhm
idst
square
upsample
* Apply pathc by Paul Dreik to cl2bp_lib.h.
===============================================================================
signal-1.1.0 Release Date: 2011-11-04 Release Manager: Juan Pablo Carbajal
===============================================================================
* Minor bug fixes in:
blackmannuttall.m
xcorr.m
filtfilt.m
invfreq.m
invfreqs.m
resample.m
* New functions added:
data2fun.m
impinvar.m
invimpinvar.m
sigmoid_train.m
pei_tseng_notch.m
iirlp2mb.m
* Not implemented functions removed from the documentation.
* All demos are now working!
signal/inst/__power.m 0000644 0000000 0000000 00000005076 12124117010 013243 0 ustar 0000000 0000000 ## Copyright (C) 1999 Paul Kienzle
##
## This program is free software; you can redistribute it and/or modify it under
## the terms of the GNU General Public License as published by the Free Software
## Foundation; either version 3 of the License, or (at your option) any later
## version.
##
## This program is distributed in the hope that it will be useful, but WITHOUT
## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
## details.
##
## You should have received a copy of the GNU General Public License along with
## this program; if not, see .
## usage: [P, w] = __power (b, a, [, nfft [, Fs]] [, range] [, units])
##
## Plot the power spectrum of the given ARMA model.
##
## b, a: filter coefficients (b=numerator, a=denominator)
## nfft is number of points at which to sample the power spectrum
## Fs is the sampling frequency of x
## range is 'half' (default) or 'whole'
## units is 'squared' or 'db' (default)
## range and units may be specified any time after the filter, in either
## order
##
## Returns P, the magnitude vector, and w, the frequencies at which it
## is sampled. If there are no return values requested, then plot the power
## spectrum and don't return anything.
## TODO: consider folding this into freqz --- just one more parameter to
## TODO: distinguish between 'linear', 'log', 'logsquared' and 'squared'
function [varargout] = __power (b, a, varargin)
if (nargin < 2 || nargin > 6) print_usage; endif
nfft = [];
Fs = [];
range = [];
range_fact = 1.0;
units = [];
pos = 0;
for i=1:length(varargin)
arg = varargin{i};
if strcmp(arg, 'squared') || strcmp(arg, 'db')
units = arg;
elseif strcmp(arg, 'whole')
range = arg;
range_fact = 1.0;
elseif strcmp(arg, 'half')
range = arg;
range_fact = 2.0;
elseif ischar(arg)
usage(usagestr);
elseif pos == 0
nfft = arg;
pos++;
elseif pos == 1
Fs = arg;
pos++;
else
usage(usagestr);
endif
endfor
if isempty(nfft); nfft = 256; endif
if isempty(Fs); Fs = 2; endif
if isempty(range)
range = 'half';
range_fact = 2.0;
endif
[P, w] = freqz(b, a, nfft, range, Fs);
P = (range_fact/Fs)*(P.*conj(P));
if nargout == 0,
if strcmp(units, 'squared')
plot(w, P, ";;");
else
plot(w, 10.0*log10(abs(P)), ";;");
endif
endif
if nargout >= 1, varargout{1} = P; endif
if nargout >= 2, varargout{2} = w; endif
endfunction
signal/inst/ar_psd.m 0000644 0000000 0000000 00000026467 12124117010 013070 0 ustar 0000000 0000000 %% Copyright (C) 2006 Peter V. Lanspeary
%%
%% This program is free software; you can redistribute it and/or modify it under
%% the terms of the GNU General Public License as published by the Free Software
%% Foundation; either version 3 of the License, or (at your option) any later
%% version.
%%
%% This program is distributed in the hope that it will be useful, but WITHOUT
%% ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
%% FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
%% details.
%%
%% You should have received a copy of the GNU General Public License along with
%% this program; if not, see .
%% Usage:
%% [psd,f_out] = ar_psd(a,v,freq,Fs,range,method,plot_type)
%%
%% Calculate the power spectrum of the autoregressive model
%%
%% M
%% x(n) = sqrt(v).e(n) + SUM a(k).x(n-k)
%% k=1
%% where x(n) is the output of the model and e(n) is white noise.
%% This function is intended for use with
%% [a,v,k] = arburg(x,poles,criterion)
%% which use the Burg (1968) method to calculate a "maximum entropy"
%% autoregressive model of "x". This function runs on octave and matlab.
%%
%% If the "freq" argument is a vector (of frequencies) the spectrum is
%% calculated using the polynomial method and the "method" argument is
%% ignored. For scalar "freq", an integer power of 2, or "method='FFT'",
%% causes the spectrum to be calculated by FFT. Otherwise, the spectrum
%% is calculated as a polynomial. It may be computationally more
%% efficient to use the FFT method if length of the model is not much
%% smaller than the number of frequency values. The spectrum is scaled so
%% that spectral energy (area under spectrum) is the same as the
%% time-domain energy (mean square of the signal).
%%
%% ARGUMENTS:
%% All but the first two arguments are optional and may be empty.
%%
%% a %% [vector] list of M=(order+1) autoregressive model
%% %% coefficients. The first element of "ar_coeffs" is the
%% %% zero-lag coefficient, which always has a value of 1.
%%
%% v %% [real scalar] square of the moving-average coefficient of
%% %% the AR model.
%%
%% freq %% [real vector] frequencies at which power spectral density
%% %% is calculated
%% %% [integer scalar] number of uniformly distributed frequency
%% %% values at which spectral density is calculated.
%% %% [default=256]
%%
%% Fs %% [real scalar] sampling frequency (Hertz) [default=1]
%%
%% CONTROL-STRING ARGUMENTS -- each of these arguments is a character string.
%% Control-string arguments can be in any order after the other arguments.
%%
%% range %% 'half', 'onesided' : frequency range of the spectrum is
%% %% from zero up to but not including sample_f/2. Power
%% %% from negative frequencies is added to the positive
%% %% side of the spectrum.
%% %% 'whole', 'twosided' : frequency range of the spectrum is
%% %% -sample_f/2 to sample_f/2, with negative frequencies
%% %% stored in "wrap around" order after the positive
%% %% frequencies; e.g. frequencies for a 10-point 'twosided'
%% %% spectrum are 0 0.1 0.2 0.3 0.4 0.5 -0.4 -0.3 -0.2 -0.1
%% %% 'shift', 'centerdc' : same as 'whole' but with the first half
%% %% of the spectrum swapped with second half to put the
%% %% zero-frequency value in the middle. (See "help
%% %% fftshift". If "freq" is vector, 'shift' is ignored.
%% %% If model coefficients "ar_coeffs" are real, the default
%% %% range is 'half', otherwise default range is 'whole'.
%%
%% method %% 'fft': use FFT to calculate power spectrum.
%% %% 'poly': calculate power spectrum as a polynomial of 1/z
%% %% N.B. this argument is ignored if the "freq" argument is a
%% %% vector. The default is 'poly' unless the "freq"
%% %% argument is an integer power of 2.
%%
%% plot_type%% 'plot', 'semilogx', 'semilogy', 'loglog', 'squared' or 'db':
%% %% specifies the type of plot. The default is 'plot', which
%% %% means linear-linear axes. 'squared' is the same as 'plot'.
%% %% 'dB' plots "10*log10(psd)". This argument is ignored and a
%% %% spectrum is not plotted if the caller requires a returned
%% %% value.
%%
%% RETURNED VALUES:
%% If returned values are not required by the caller, the spectrum
%% is plotted and nothing is returned.
%% psd %% [real vector] estimate of power-spectral density
%% f_out %% [real vector] frequency values
%%
%% N.B. arburg runs in octave and matlab, and does not depend on octave-forge
%% or signal-processing-toolbox functions.
%%
%% REFERENCE
%% [1] Equation 2.28 from Steven M. Kay and Stanley Lawrence Marple Jr.:
%% "Spectrum analysis -- a modern perspective",
%% Proceedings of the IEEE, Vol 69, pp 1380-1419, Nov., 1981
%%
function [varargout]=ar_psd(a,v,varargin)
%%
%% Check fixed arguments
if ( nargin < 2 )
error( 'ar_psd: needs at least 2 args. Use help ar_psd.' );
elseif ( ~isvector(a) || length(a)<2 )
error( 'ar_psd: arg 1 (a) must be vector, length>=2.' );
elseif ( ~isscalar(v) )
error( 'ar_psd: arg 2 (v) must be real scalar >0.' );
else
real_model = isreal(a);
%%
%% default values for optional areguments
freq = 256;
user_freqs = 0; %% boolean: true for user-specified frequencies
Fs = 1.0;
%% FFT padding factor (is also frequency range divisor): 1=whole, 2=half.
pad_fact = 1 + real_model;
do_shift = 0;
force_FFT = 0;
force_poly = 0;
plot_type = 1;
%%
%% decode and check optional arguments
%% end_numeric_args is boolean; becomes true at 1st string arg
end_numeric_args = 0;
for iarg = 1:length(varargin)
arg = varargin{iarg};
end_numeric_args = end_numeric_args || ischar(arg);
%% skip empty arguments
if ( isempty(arg) )
1;
%% numeric optional arguments must be first, cannot follow string args
%% N.B. older versions of matlab may not have the function "error" so
%% the user writes "function error(msg); disp(msg); end" and we need
%% a "return" here.
elseif ( ~ischar(arg) )
if ( end_numeric_args )
error( 'ar_psd: control arg must be string.' );
%%
%% first optional numeric arg is "freq"
elseif ( iarg == 1 )
user_freqs = isvector(arg) && length(arg)>1;
if ( ~isscalar(arg) && ~user_freqs )
error( 'ar_psd: arg 3 (freq) must be vector or scalar.' );
elseif ( ~user_freqs && ( ~isreal(arg) || ...
fix(arg)~=arg || arg <= 2 || arg >= 1048576 ) )
error('ar_psd: arg 3 (freq) must be integer >=2, <=1048576' );
elseif ( user_freqs && ~isreal(arg) )
error( 'ar_psd: arg 3 (freq) vector must be real.' );
end
freq = arg(:); % -> column vector
%%
%% second optional numeric arg is "Fs" - sampling frequency
elseif ( iarg == 2 )
if ( ~isscalar(arg) || ~isreal(arg) || arg<=0 )
error( 'ar_psd: arg 4 (Fs) must be real positive scalar.' );
end
Fs = arg;
%%
else
error( 'ar_psd: control arg must be string.' );
end
%%
%% decode control-string arguments
elseif ( strcmp(arg,'plot') || strcmp(arg,'squared') )
plot_type = 1;
elseif ( strcmp(arg,'semilogx') )
plot_type = 2;
elseif ( strcmp(arg,'semilogy') )
plot_type = 3;
elseif ( strcmp(arg,'loglog') )
plot_type = 4;
elseif ( strcmp(arg,'dB') )
plot_type = 5;
elseif ( strcmp(arg,'fft') )
force_FFT = 1;
force_poly = 0;
elseif ( strcmp(arg,'poly') )
force_FFT = 0;
force_poly = 1;
elseif ( strcmp(arg,'half') || strcmp(arg,'onesided') )
pad_fact = 2; % FFT zero-padding factor (pad FFT to double length)
do_shift = 0;
elseif ( strcmp(arg,'whole') || strcmp(arg,'twosided') )
pad_fact = 1; % FFT zero-padding factor (do not pad)
do_shift = 0;
elseif ( strcmp(arg,'shift') || strcmp(arg,'centerdc') )
pad_fact = 1;
do_shift = 1;
else
error( 'ar_psd: string arg: illegal value: %s', arg );
end
end
%% end of decoding and checking args
%%
if ( user_freqs )
%% user provides (column) vector of frequencies
if ( any(abs(freq)>Fs/2) )
error( 'ar_psd: arg 3 (freq) cannot exceed half sampling frequency.' );
elseif ( pad_fact==2 && any(freq<0) )
error( 'ar_psd: arg 3 (freq) must be positive in onesided spectrum' );
end
freq_len = length(freq);
fft_len = freq_len;
use_FFT = 0;
do_shift = 0;
else
%% internally generated frequencies
freq_len = freq;
freq = (Fs/pad_fact/freq_len) * [0:freq_len-1]';
%% decide which method to use (poly or FFT)
is_power_of_2 = rem(log(freq_len),log(2))<10.*eps;
use_FFT = ( ~ force_poly && is_power_of_2 ) || force_FFT;
fft_len = freq_len * pad_fact;
end
end
%%
%% calculate denominator of Equation 2.28, Kay and Marple, ref [1]Jr.:
len_coeffs = length(a);
if ( use_FFT )
%% FFT method
fft_out = fft( [ a(:); zeros(fft_len-len_coeffs,1) ] );
else
%% polynomial method
%% complex data on "half" frequency range needs -ve frequency values
if ( pad_fact==2 && ~real_model )
freq = [freq; -freq(freq_len:-1:1)];
fft_len = 2*freq_len;
end
fft_out = polyval( a(len_coeffs:-1:1), exp( (-i*2*pi/Fs) * freq ) );
end
%%
%% The power spectrum (PSD) is the scaled squared reciprocal of amplitude
%% of the FFT/polynomial. This is NOT the reciprocal of the periodogram.
%% The PSD is a continuous function of frequency. For uniformly
%% distributed frequency values, the FFT algorithm might be the most
%% efficient way of calculating it.
%%
psd = ( v / Fs ) ./ ( fft_out .* conj(fft_out) );
%%
%% range='half' or 'onesided',
%% add PSD at -ve frequencies to PSD at +ve frequencies
%% N.B. unlike periodogram, PSD at zero frequency _is_ doubled.
if ( pad_fact==2 )
freq = freq(1:freq_len);
if ( real_model )
%% real data, double the psd
psd = 2 * psd(1:freq_len);
elseif ( use_FFT )
%% complex data, FFT method, internally-generated frequencies
psd = psd(1:freq_len)+[psd(1); psd(fft_len:-1:freq_len+2)];
else
%% complex data, polynomial method
%% user-defined and internally-generated frequencies
psd = psd(1:freq_len)+psd(fft_len:-1:freq_len+1);
end
%%
%% range='shift'
%% disabled for user-supplied frequencies
%% Shift zero-frequency to the middle (pad_fact==1)
elseif ( do_shift )
len2 = fix((fft_len+1)/2);
psd = [psd(len2+1:fft_len); psd(1:len2)];
freq = [freq(len2+1:fft_len)-Fs; freq(1:len2)];
end
%%
%% Plot the spectrum if there are no return variables.
if ( nargout >= 2 )
varargout{1} = psd;
varargout{2} = freq;
elseif ( nargout == 1 )
varargout{1} = psd;
else
if ( plot_type == 1 )
plot(freq,psd);
elseif ( plot_type == 2 )
semilogx(freq,psd);
elseif ( plot_type == 3 )
semilogy(freq,psd);
elseif ( plot_type == 4 )
loglog(freq,psd);
elseif ( plot_type == 5 )
plot(freq,10*log10(psd));
end
end
end
signal/inst/arburg.m 0000644 0000000 0000000 00000022641 12124117010 013070 0 ustar 0000000 0000000 %% Copyright (C) 2006 Peter V. Lanspeary
%%
%% This program is free software; you can redistribute it and/or modify it under
%% the terms of the GNU General Public License as published by the Free Software
%% Foundation; either version 3 of the License, or (at your option) any later
%% version.
%%
%% This program is distributed in the hope that it will be useful, but WITHOUT
%% ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
%% FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
%% details.
%%
%% You should have received a copy of the GNU General Public License along with
%% this program; if not, see .
%% [a,v,k] = arburg(x,poles,criterion)
%%
%% Calculate coefficients of an autoregressive (AR) model of complex data
%% "x" using the whitening lattice-filter method of Burg (1968). The inverse
%% of the model is a moving-average filter which reduces "x" to white noise.
%% The power spectrum of the AR model is an estimate of the maximum
%% entropy power spectrum of the data. The function "ar_psd" calculates the
%% power spectrum of the AR model.
%%
%% ARGUMENTS:
%% x %% [vector] sampled data
%%
%% poles %% [integer scalar] number of poles in the AR model or
%% %% limit to the number of poles if a
%% %% valid "stop_crit" is provided.
%%
%% criterion %% [optional string arg] model-selection criterion. Limits
%% %% the number of poles so that spurious poles are not
%% %% added when the whitened data has no more information
%% %% in it (see Kay & Marple, 1981). Recognised values are
%% %% 'AKICc' -- approximate corrected Kullback information
%% %% criterion (recommended),
%% %% 'KIC' -- Kullback information criterion
%% %% 'AICc' -- corrected Akaike information criterion
%% %% 'AIC' -- Akaike information criterion
%% %% 'FPE' -- final prediction error" criterion
%% %% The default is to NOT use a model-selection criterion
%%
%% RETURNED VALUES:
%% a %% [polynomial/vector] list of (P+1) autoregression coeffic-
%% %% ients; for data input x(n) and white noise e(n),
%% %% the model is
%% %% P+1
%% %% x(n) = sqrt(v).e(n) + SUM a(k).x(n-k)
%% %% k=1
%%
%% v %% [real scalar] mean square of residual noise from the
%% %% whitening operation of the Burg lattice filter.
%%
%% k %% [column vector] reflection coefficients defining the
%% %% lattice-filter embodiment of the model
%%
%% HINTS:
%% (1) arburg does not remove the mean from the data. You should remove
%% the mean from the data if you want a power spectrum. A non-zero mean
%% can produce large errors in a power-spectrum estimate. See
%% "help detrend".
%% (2) If you don't know what the value of "poles" should be, choose the
%% largest (reasonable) value you could want and use the recommended
%% value, criterion='AKICc', so that arburg can find it.
%% E.g. arburg(x,64,'AKICc')
%% The AKICc has the least bias and best resolution of the available
%% model-selection criteria.
%% (3) arburg runs in octave and matlab, does not depend on octave forge
%% or signal-processing-toolbox functions.
%% (4) Autoregressive and moving-average filters are stored as polynomials
%% which, in matlab, are row vectors.
%%
%% NOTE ON SELECTION CRITERION
%% AIC, AICc, KIC and AKICc are based on information theory. They attempt
%% to balance the complexity (or length) of the model against how well the
%% model fits the data. AIC and KIC are biassed estimates of the asymmetric
%% and the symmetric Kullback-Leibler divergence respectively. AICc and
%% AKICc attempt to correct the bias. See reference [4].
%%
%%
%% REFERENCES
%% [1] John Parker Burg (1968)
%% "A new analysis technique for time series data",
%% NATO advanced study Institute on Signal Processing with Emphasis on
%% Underwater Acoustics, Enschede, Netherlands, Aug. 12-23, 1968.
%%
%% [2] Steven M. Kay and Stanley Lawrence Marple Jr.:
%% "Spectrum analysis -- a modern perspective",
%% Proceedings of the IEEE, Vol 69, pp 1380-1419, Nov., 1981
%%
%% [3] William H. Press and Saul A. Teukolsky and William T. Vetterling and
%% Brian P. Flannery
%% "Numerical recipes in C, The art of scientific computing", 2nd edition,
%% Cambridge University Press, 2002 --- Section 13.7.
%%
%% [4] Abd-Krim Seghouane and Maiza Bekara
%% "A small sample model selection criterion based on Kullback's symmetric
%% divergence", IEEE Transactions on Signal Processing,
%% Vol. 52(12), pp 3314-3323, Dec. 2004
function [varargout] = arburg( x, poles, criterion )
%%
%% Check arguments
if ( nargin < 2 )
error( 'arburg(x,poles): Need at least 2 args.' );
elseif ( ~isvector(x) || length(x) < 3 )
error( 'arburg: arg 1 (x) must be vector of length >2.' );
elseif ( ~isscalar(poles) || ~isreal(poles) || fix(poles)~=poles || poles<=0.5)
error( 'arburg: arg 2 (poles) must be positive integer.' );
elseif ( poles >= length(x)-2 )
%% lattice-filter algorithm requires "poles0
error( 'arburg: arg 2 (poles) must be less than length(x)-2.' );
elseif ( nargin>2 && ~isempty(criterion) && ...
(~ischar(criterion) || size(criterion,1)~=1 ) )
error( 'arburg: arg 3 (criterion) must be string.' );
else
%%
%% Set the model-selection-criterion flags.
%% is_AKICc, isa_KIC and is_corrected are short-circuit flags
if ( nargin > 2 && ~isempty(criterion) )
is_AKICc = strcmp(criterion,'AKICc'); %% AKICc
isa_KIC = is_AKICc || strcmp(criterion,'KIC'); %% KIC or AKICc
is_corrected = is_AKICc || strcmp(criterion,'AICc'); %% AKICc or AICc
use_inf_crit = is_corrected || isa_KIC || strcmp(criterion,'AIC');
use_FPE = strcmp(criterion,'FPE');
if ( ~use_inf_crit && ~use_FPE )
error( 'arburg: value of arg 3 (criterion) not recognised' );
end
else
use_inf_crit = 0;
use_FPE = 0;
end
%%
%% f(n) = forward prediction error
%% b(n) = backward prediction error
%% Storage of f(n) and b(n) is a little tricky. Because f(n) is always
%% combined with b(n-1), f(1) and b(N) are never used, and therefore are
%% not stored. Not storing unused data makes the calculation of the
%% reflection coefficient look much cleaner :)
%% N.B. {initial v} = {error for zero-order model} =
%% {zero-lag autocorrelation} = E(x*conj(x)) = x*x'/N
%% E = expectation operator
N = length(x);
k = [];
if ( size(x,1) > 1 ) % if x is column vector
f = x(2:N);
b = x(1:N-1);
v = real(x'*x) / N;
else % if x is row vector
f = x(2:N).';
b = x(1:N-1).';
v = real(x*x') / N;
end
%% new_crit/old_crit is the mode-selection criterion
new_crit = abs(v);
old_crit = 2 * new_crit;
for p = 1:poles
%%
%% new reflection coeff = -2* E(f.conj(b)) / ( E(f^2)+E(b(^2) )
last_k= -2 * (b' * f) / ( f' * f + b' * b);
%% Levinson-Durbin recursion for residual
new_v = v * ( 1.0 - real(last_k * conj(last_k)) );
if ( p > 1 )
%%
%% Apply the model-selection criterion and break out of loop if it
%% increases (rather than decreases).
%% Do it before we update the old model "a" and "v".
%%
%% * Information Criterion (AKICc, KIC, AICc, AIC)
if ( use_inf_crit )
old_crit = new_crit;
%% AKICc = log(new_v)+p/N/(N-p)+(3-(p+2)/N)*(p+1)/(N-p-2);
%% KIC = log(new_v)+ 3 *(p+1)/N;
%% AICc = log(new_v)+ 2 *(p+1)/(N-p-2);
%% AIC = log(new_v)+ 2 *(p+1)/N;
%% -- Calculate KIC, AICc & AIC by using is_AKICc, is_KIC and
%% is_corrected to "short circuit" the AKICc calculation.
%% The extra 4--12 scalar arithmetic ops should be quicker than
%% doing if...elseif...elseif...elseif...elseif.
new_crit = log(new_v) + is_AKICc*p/N/(N-p) + ...
(2+isa_KIC-is_AKICc*(p+2)/N) * (p+1) / (N-is_corrected*(p+2));
if ( new_crit > old_crit )
break;
end
%%
%% (FPE) Final prediction error
elseif ( use_FPE )
old_crit = new_crit;
new_crit = new_v * (N+p+1)/(N-p-1);
if ( new_crit > old_crit )
break;
end
end
%% Update model "a" and "v".
%% Use Levinson-Durbin recursion formula (for complex data).
a = [ prev_a + last_k .* conj(prev_a(p-1:-1:1)) last_k ];
else %% if( p==1 )
a = last_k;
end
k = [ k; last_k ];
v = new_v;
if ( p < poles )
prev_a = a;
%% calculate new prediction errors (by recursion):
%% f(p,n) = f(p-1,n) + k * b(p-1,n-1) n=2,3,...n
%% b(p,n) = b(p-1,n-1) + conj(k) * f(p-1,n) n=2,3,...n
%% remember f(p,1) is not stored, so don't calculate it; make f(p,2)
%% the first element in f. b(p,n) isn't calculated either.
nn = N-p;
new_f = f(2:nn) + last_k * b(2:nn);
b = b(1:nn-1) + conj(last_k) * f(1:nn-1);
f = new_f;
end
end
%% end of for loop
%%
varargout{1} = [1 a];
varargout{2} = v;
if ( nargout>=3 )
varargout{3} = k;
end
end
end
%%
signal/inst/aryule.m 0000644 0000000 0000000 00000004314 12124117010 013104 0 ustar 0000000 0000000 ## Copyright (C) 1999 Paul Kienzle
## Copyright (C) 2006 Peter Lanspeary
##
## This program is free software; you can redistribute it and/or modify it under
## the terms of the GNU General Public License as published by the Free Software
## Foundation; either version 3 of the License, or (at your option) any later
## version.
##
## This program is distributed in the hope that it will be useful, but WITHOUT
## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
## details.
##
## You should have received a copy of the GNU General Public License along with
## this program; if not, see .
## usage: [a, v, k] = aryule (x, p)
##
## fits an AR (p)-model with Yule-Walker estimates.
## x = data vector to estimate
## a: AR coefficients
## v: variance of white noise
## k: reflection coeffients for use in lattice filter
##
## The power spectrum of the resulting filter can be plotted with
## pyulear(x, p), or you can plot it directly with ar_psd(a,v,...).
##
## See also:
## pyulear, power, freqz, impz -- for observing characteristics of the model
## arburg -- for alternative spectral estimators
##
## Example: Use example from arburg, but substitute aryule for arburg.
##
## Note: Orphanidis '85 claims lattice filters are more tolerant of
## truncation errors, which is why you might want to use them. However,
## lacking a lattice filter processor, I haven't tested that the lattice
## filter coefficients are reasonable.
function [a, v, k] = aryule (x, p)
if ( nargin~=2 )
print_usage;
elseif ( ~isvector(x) || length(x)<3 )
error( 'aryule: arg 1 (x) must be vector of length >2' );
elseif ( ~isscalar(p) || fix(p)~=p || p > length(x)-2 )
error( 'aryule: arg 2 (p) must be an integer >0 and