diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 0000000000000000000000000000000000000000..94a9ed024d3859793618152ea559a168bbcbb5e2
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ 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.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ 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 <http://www.gnu.org/licenses/>.
+
+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:
+
+ <program> Copyright (C) <year> <name of author>
+ 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
+<http://www.gnu.org/licenses/>.
+
+ 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
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000000000000000000000000000000000000..466879fbd9b111d6b0b5f0c34abba1bb5ef875c0
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1 @@
+recursive-include doc *.rst
diff --git a/README.md b/README.md
deleted file mode 100644
index a9bfe50204d557b5103a0d0480e2192dcc56aa61..0000000000000000000000000000000000000000
--- a/README.md
+++ /dev/null
@@ -1,2 +0,0 @@
-bob.example.faceverify
-======================
\ No newline at end of file
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000000000000000000000000000000000000..a7402fb265a1e754b266e5ae1f85a5c8f519bd62
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,43 @@
+Face verification using Bob
+===========================
+
+This example demonstrates how to use Bob to build different face verification
+systems. It includes examples with three different complexities:
+
+* A simple eigenface based example
+* An example using Gabor jets and a Gabor-phase based similarity function
+* An example building an UBM/GMM model on top of DCT blocks.
+
+To use this example, you will require Bob and the AT&T database. If you do not
+have a Bob version yet, you can get it from::
+
+ http://idiap.github.com/bob/
+
+The AT&T image database is quite small, but sufficient to show how the face
+verification methods work. Still, the results may not be meaningful. One good
+thing about the AT&T database is that it is freely available. You can download
+it from::
+
+ http://www.cl.cam.ac.uk/research/dtg/attarchive/facedatabase.html
+
+
+Finally, to download this package, please open a shell, go to a directory of
+your choice and call:
+
+.. code-block:: sh
+
+ $ git clone https://github.com/bioidiap/bob.example.faceverify.git
+ $ cd bob.example.faceverify
+
+
+To generate the Documentation, please further go into the "doc" directory and
+call:
+
+.. code-block:: sh
+
+ make html
+ firefox _build/html/index.html
+
+(or use any other browser of your choice). After you did this, please read the
+documentation and try to execute the examples.
+
diff --git a/bootstrap.py b/bootstrap.py
new file mode 100644
index 0000000000000000000000000000000000000000..7647cbbe10e7638d71079fd8f6ca295e89941a51
--- /dev/null
+++ b/bootstrap.py
@@ -0,0 +1,262 @@
+##############################################################################
+#
+# Copyright (c) 2006 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Bootstrap a buildout-based project
+
+Simply run this script in a directory containing a buildout.cfg.
+The script accepts buildout command-line options, so you can
+use the -c option to specify an alternate configuration file.
+"""
+
+import os, shutil, sys, tempfile, urllib, urllib2, subprocess
+from optparse import OptionParser
+
+if sys.platform == 'win32':
+ def quote(c):
+ if ' ' in c:
+ return '"%s"' % c # work around spawn lamosity on windows
+ else:
+ return c
+else:
+ quote = str
+
+# See zc.buildout.easy_install._has_broken_dash_S for motivation and comments.
+stdout, stderr = subprocess.Popen(
+ [sys.executable, '-Sc',
+ 'try:\n'
+ ' import ConfigParser\n'
+ 'except ImportError:\n'
+ ' print 1\n'
+ 'else:\n'
+ ' print 0\n'],
+ stdout=subprocess.PIPE, stderr=subprocess.PIPE).communicate()
+has_broken_dash_S = bool(int(stdout.strip()))
+
+# In order to be more robust in the face of system Pythons, we want to
+# run without site-packages loaded. This is somewhat tricky, in
+# particular because Python 2.6's distutils imports site, so starting
+# with the -S flag is not sufficient. However, we'll start with that:
+if not has_broken_dash_S and 'site' in sys.modules:
+ # We will restart with python -S.
+ args = sys.argv[:]
+ args[0:0] = [sys.executable, '-S']
+ args = map(quote, args)
+ os.execv(sys.executable, args)
+# Now we are running with -S. We'll get the clean sys.path, import site
+# because distutils will do it later, and then reset the path and clean
+# out any namespace packages from site-packages that might have been
+# loaded by .pth files.
+clean_path = sys.path[:]
+import site # imported because of its side effects
+sys.path[:] = clean_path
+for k, v in sys.modules.items():
+ if k in ('setuptools', 'pkg_resources') or (
+ hasattr(v, '__path__') and
+ len(v.__path__) == 1 and
+ not os.path.exists(os.path.join(v.__path__[0], '__init__.py'))):
+ # This is a namespace package. Remove it.
+ sys.modules.pop(k)
+
+is_jython = sys.platform.startswith('java')
+
+setuptools_source = 'http://peak.telecommunity.com/dist/ez_setup.py'
+distribute_source = 'http://python-distribute.org/distribute_setup.py'
+
+
+# parsing arguments
+def normalize_to_url(option, opt_str, value, parser):
+ if value:
+ if '://' not in value: # It doesn't smell like a URL.
+ value = 'file://%s' % (
+ urllib.pathname2url(
+ os.path.abspath(os.path.expanduser(value))),)
+ if opt_str == '--download-base' and not value.endswith('/'):
+ # Download base needs a trailing slash to make the world happy.
+ value += '/'
+ else:
+ value = None
+ name = opt_str[2:].replace('-', '_')
+ setattr(parser.values, name, value)
+
+usage = '''\
+[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options]
+
+Bootstraps a buildout-based project.
+
+Simply run this script in a directory containing a buildout.cfg, using the
+Python that you want bin/buildout to use.
+
+Note that by using --setup-source and --download-base to point to
+local resources, you can keep this script from going over the network.
+'''
+
+parser = OptionParser(usage=usage)
+parser.add_option("-v", "--version", dest="version",
+ help="use a specific zc.buildout version")
+parser.add_option("-d", "--distribute",
+ action="store_true", dest="use_distribute", default=False,
+ help="Use Distribute rather than Setuptools.")
+parser.add_option("--setup-source", action="callback", dest="setup_source",
+ callback=normalize_to_url, nargs=1, type="string",
+ help=("Specify a URL or file location for the setup file. "
+ "If you use Setuptools, this will default to " +
+ setuptools_source + "; if you use Distribute, this "
+ "will default to " + distribute_source + "."))
+parser.add_option("--download-base", action="callback", dest="download_base",
+ callback=normalize_to_url, nargs=1, type="string",
+ help=("Specify a URL or directory for downloading "
+ "zc.buildout and either Setuptools or Distribute. "
+ "Defaults to PyPI."))
+parser.add_option("--eggs",
+ help=("Specify a directory for storing eggs. Defaults to "
+ "a temporary directory that is deleted when the "
+ "bootstrap script completes."))
+parser.add_option("-t", "--accept-buildout-test-releases",
+ dest='accept_buildout_test_releases',
+ action="store_true", default=False,
+ help=("Normally, if you do not specify a --version, the "
+ "bootstrap script and buildout gets the newest "
+ "*final* versions of zc.buildout and its recipes and "
+ "extensions for you. If you use this flag, "
+ "bootstrap and buildout will get the newest releases "
+ "even if they are alphas or betas."))
+parser.add_option("-c", None, action="store", dest="config_file",
+ help=("Specify the path to the buildout configuration "
+ "file to be used."))
+
+options, args = parser.parse_args()
+
+# if -c was provided, we push it back into args for buildout's main function
+if options.config_file is not None:
+ args += ['-c', options.config_file]
+
+if options.eggs:
+ eggs_dir = os.path.abspath(os.path.expanduser(options.eggs))
+else:
+ eggs_dir = tempfile.mkdtemp()
+
+if options.setup_source is None:
+ if options.use_distribute:
+ options.setup_source = distribute_source
+ else:
+ options.setup_source = setuptools_source
+
+if options.accept_buildout_test_releases:
+ args.append('buildout:accept-buildout-test-releases=true')
+args.append('bootstrap')
+
+try:
+ import pkg_resources
+ import setuptools # A flag. Sometimes pkg_resources is installed alone.
+ if not hasattr(pkg_resources, '_distribute'):
+ raise ImportError
+except ImportError:
+ ez_code = urllib2.urlopen(
+ options.setup_source).read().replace('\r\n', '\n')
+ ez = {}
+ exec ez_code in ez
+ setup_args = dict(to_dir=eggs_dir, download_delay=0)
+ if options.download_base:
+ setup_args['download_base'] = options.download_base
+ if options.use_distribute:
+ setup_args['no_fake'] = True
+ ez['use_setuptools'](**setup_args)
+ if 'pkg_resources' in sys.modules:
+ reload(sys.modules['pkg_resources'])
+ import pkg_resources
+ # This does not (always?) update the default working set. We will
+ # do it.
+ for path in sys.path:
+ if path not in pkg_resources.working_set.entries:
+ pkg_resources.working_set.add_entry(path)
+
+cmd = [quote(sys.executable),
+ '-c',
+ quote('from setuptools.command.easy_install import main; main()'),
+ '-mqNxd',
+ quote(eggs_dir)]
+
+if not has_broken_dash_S:
+ cmd.insert(1, '-S')
+
+find_links = options.download_base
+if not find_links:
+ find_links = os.environ.get('bootstrap-testing-find-links')
+if find_links:
+ cmd.extend(['-f', quote(find_links)])
+
+if options.use_distribute:
+ setup_requirement = 'distribute'
+else:
+ setup_requirement = 'setuptools'
+ws = pkg_resources.working_set
+setup_requirement_path = ws.find(
+ pkg_resources.Requirement.parse(setup_requirement)).location
+env = dict(
+ os.environ,
+ PYTHONPATH=setup_requirement_path)
+
+requirement = 'zc.buildout'
+version = options.version
+if version is None and not options.accept_buildout_test_releases:
+ # Figure out the most recent final version of zc.buildout.
+ import setuptools.package_index
+ _final_parts = '*final-', '*final'
+
+ def _final_version(parsed_version):
+ for part in parsed_version:
+ if (part[:1] == '*') and (part not in _final_parts):
+ return False
+ return True
+ index = setuptools.package_index.PackageIndex(
+ search_path=[setup_requirement_path])
+ if find_links:
+ index.add_find_links((find_links,))
+ req = pkg_resources.Requirement.parse(requirement)
+ if index.obtain(req) is not None:
+ best = []
+ bestv = None
+ for dist in index[req.project_name]:
+ distv = dist.parsed_version
+ if _final_version(distv):
+ if bestv is None or distv > bestv:
+ best = [dist]
+ bestv = distv
+ elif distv == bestv:
+ best.append(dist)
+ if best:
+ best.sort()
+ version = best[-1].version
+if version:
+ requirement = '=='.join((requirement, version))
+cmd.append(requirement)
+
+if is_jython:
+ import subprocess
+ exitcode = subprocess.Popen(cmd, env=env).wait()
+else: # Windows prefers this, apparently; otherwise we would prefer subprocess
+ exitcode = os.spawnle(*([os.P_WAIT, sys.executable] + cmd + [env]))
+if exitcode != 0:
+ sys.stdout.flush()
+ sys.stderr.flush()
+ print ("An error occurred when trying to install zc.buildout. "
+ "Look above this message for any errors that "
+ "were output by easy_install.")
+ sys.exit(exitcode)
+
+ws.add_entry(eggs_dir)
+ws.require(requirement)
+import zc.buildout.buildout
+zc.buildout.buildout.main(args)
+if not options.eggs: # clean up temporary egg directory
+ shutil.rmtree(eggs_dir)
diff --git a/buildout.cfg b/buildout.cfg
new file mode 100644
index 0000000000000000000000000000000000000000..f2fe8ecdb8cf35141fb5bd779729694463a2ddf7
--- /dev/null
+++ b/buildout.cfg
@@ -0,0 +1,30 @@
+; vim: set fileencoding=utf-8 :
+; Andre Anjos <andre.anjos@idiap.ch>
+; Mon 16 Apr 08:29:18 2012 CEST
+
+; This is the configuration file for buildout. It is a windows-init style file
+; divided into sections. This is probably the most minimalistic example you can
+; have.
+;
+; The first section of this file defines to which other sections buildout will
+; look at for information. We only have 1 other section (or part) to look at,
+; the 'python' section.
+
+[buildout]
+parts = python
+
+; We will be 'developing' the current package, so we should put '.' here
+develop = .
+
+; Names of other packages that we need installed locally, including this one.
+; You can use this instruction here to 'augment' the portfolio of packages that
+; will be available at this local installation. This happens besides what has
+; already been described at your package's setup.py. So, don't repeat those
+; requirements here unless you would like to define specific version numbers
+; for testing purposes.
+eggs = bob.example.faceverify
+
+[python]
+recipe = zc.recipe.egg
+interpreter = python
+eggs = ${buildout:eggs}
diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000000000000000000000000000000000000..234f658a0baaafec996ac247930dfdbab250479f
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FaceRecLib.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FaceRecLib.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/FaceRecLib"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FaceRecLib"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ make -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/doc/conf.py b/doc/conf.py
new file mode 100644
index 0000000000000000000000000000000000000000..c971fc57a2726f949155327071b133c672f629be
--- /dev/null
+++ b/doc/conf.py
@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+#
+# FaceRecLib documentation build configuration file, created by
+# sphinx-quickstart on Wed Jan 25 17:23:57 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'bob.example.faceverify'
+copyright = u'2012, Manuel Guenther'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+#html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'bob.example.faceverify.doc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+#latex_documents = [
+# ('index', 'FaceRecLib.tex', u'FaceRecLib Documentation',
+# u'Laurent El Shafey', 'manual'),
+#]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'bob.example.faceverify', u'Documentation for the examples how to use Bob for face verification',
+ [u'Manuel Guenther'], 1)
+]
diff --git a/doc/dct_ubm.png b/doc/dct_ubm.png
new file mode 100644
index 0000000000000000000000000000000000000000..324e358372b2e3ca19e664bb7e6cda25d2e9d62c
Binary files /dev/null and b/doc/dct_ubm.png differ
diff --git a/doc/eigenface.png b/doc/eigenface.png
new file mode 100644
index 0000000000000000000000000000000000000000..4249388f8c2adfc2e37d37071568ff862dd11b51
Binary files /dev/null and b/doc/eigenface.png differ
diff --git a/doc/examples.rst b/doc/examples.rst
new file mode 100644
index 0000000000000000000000000000000000000000..e9bef5b3701e846290e93305e637a71d47fc49e0
--- /dev/null
+++ b/doc/examples.rst
@@ -0,0 +1,147 @@
+=====================
+ Running the examples
+=====================
+
+To run the examples, just call the scripts from within the ``bin`` directory,
+e.g.:
+
+.. code-block:: sh
+
+ $ bin/eigenface.py
+
+If you installed the image database in another folder than ``Database``, please
+give this directrory as parameter to the script, e.g.:
+
+.. code-block:: sh
+
+ $ bin/eigenface.py <AT&T_DATABASE_DIR>
+
+
+There are three example scripts:
+
+.. code-block:: sh
+
+ $ bin/eigenface.py
+ $ bin/gabor_phase.py
+ $ bin/dct_ubm.py
+
+that perform more or less complicated face verification experiments. Each
+experiment creates an ROC curve that contains the final verification result of
+the test. The generated files will be ``eigenface.png``, ``gabor_phase.png``,
+and ``dct_ubm.png``.
+
+Since the complexity of the algorithms increase the expected execution time of
+them differ a lot. While the eigenface example should be finished in a couple of
+seconds, the Gabor phase example could take some minutes, and the UBM/GMM model
+needs in the order of half an hour to compute.
+
+
+The eigenface example
+~~~~~~~~~~~~~~~~~~~~~
+The eigenface example follows the work-flow that is presented in the original
+paper *Eigenfaces for Recognition* [TP91]_ by Turk and Pentland. First, it
+creates an object to query the database:
+
+.. code-block:: python
+
+ >>> atnt_db = bob.db.atnt.Database()
+
+For training the projection matrix, the training images need to be read:
+
+.. code-block:: python
+
+ >>> training_image_files = atnt_db.files(groups = 'train', ...)
+ >>> for filename in training_image_files.values():
+ ... training_image = bob.io.load(filename)
+
+Since the images are already aligned to the eye positions, they can simply be
+linearized (converted into one long vector) and put into an ``bob.io.ArraySet``:
+
+.. code-block:: python
+
+ >>> training_set = bob.io.Arrayset()
+ >>> for image in training_images.values():
+ ... training_set.append(image.flatten())
+
+which is used to train a ``bob.machine.LinearMachine``:
+
+.. code-block:: python
+
+ >>> pca_trainer = bob.trainer.SVDPCATrainer()
+ >>> pca_machine, eigen_values = pca_trainer.train(training_set)
+
+For some distance functions, the eigenvalues are needed, but in our example we
+just ignore them.
+
+After training, the model and probe images are loaded, linearized, and projected
+into the eigenspace using the trained ``pca_machine``:
+
+.. code-block:: python
+
+ >>> model_image_files = atnt_db.files(groups = 'test', purpose = 'enrol', ...)
+ >>> for filename in model_image_files.values():
+ ... model_image = bob.io.load(filename)
+ ... model_feature = pca_machine(model_image.flatten())
+
+ >>> probe_image_files = atnt_db.files(groups = 'test', purpose = 'probe', ...)
+ >>> for filename in probe_image_files.values():
+ ... probe_image = bob.io.load(filename)
+ ... probe_feature = pca_machine(probe_image.flatten())
+
+To compute the verification result, each model feature is compared to each probe
+feature by computing the Euclidean distance:
+
+.. code-block:: python
+
+ >>> for model_feature in model_features:
+ ... for probe_feature in probe_features:
+ ... score = bob.math.euclidean_distance(model_feature, probe_feature)
+
+The results are divided into a list of positive scores (model and probe are from
+the same identity) and a a list of negative scores (identities of model and
+probe differ). Using these lists, the ROC curve is plotted:
+
+.. code-block:: python
+
+ >>> bob.measure.plot.roc(negatives, positives)
+
+.. image:: eigenface.png
+ :scale: 70 %
+
+and the performance is computed:
+
+.. code-block:: python
+
+ >>> threshold = bob.measure.eer_threshold(negatives, positives)
+ >>> FAR, FRR = bob.measure.farfrr(negatives, positives, threshold)
+
+The expected result is: FAR 83.6% and FRR 83.6% at distance threshold 2048.9
+
+.. note::
+
+ Computing eigenfaces with such a low amount of training data is usually not an
+ excellent idea. Hence, the performance in this example is extremely poor.
+
+
+Gabor jet comparisons
+~~~~~~~~~~~~~~~~~~~~~
+Description of algorithm will follow. The expected output is:
+
+.. image:: gabor_phase.png
+ :scale: 70 %
+
+The expected result is: FAR 22% and FRR 22% at distance threshold 0.1799
+
+
+The UBM/GMM modeling of DCT Blocks
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Description of algorithm will follow. The expected output is:
+
+.. image:: dct_ubm.png
+ :scale: 70 %
+
+The expected result is: FAR 5% and FRR 5% at distance threshold 7640.9
+
+
+.. [TP91] Matthew Turk and Alex Pentland. Eigenfaces for recognition. Journal of Cognitive Neuroscience, 3(1):71-86, 1991.
+
diff --git a/doc/gabor_phase.png b/doc/gabor_phase.png
new file mode 100644
index 0000000000000000000000000000000000000000..ccf4a324dbb07e536a6497d04f6af283671e1377
Binary files /dev/null and b/doc/gabor_phase.png differ
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000000000000000000000000000000000000..5a81959d3f6f98c6bff424ae2b0589ee22cb0f30
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,23 @@
+.. FaceRecLib documentation master file, created by
+ sphinx-quickstart on Wed Jan 25 17:23:57 2012.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to the documentation of the face verification examples!
+===============================================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ installation
+ examples
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/doc/installation.rst b/doc/installation.rst
new file mode 100644
index 0000000000000000000000000000000000000000..9f3eb8a5f0df57bb391ee0830f5bb0432c68cafa
--- /dev/null
+++ b/doc/installation.rst
@@ -0,0 +1,71 @@
+=============
+ Installation
+=============
+
+.. note::
+
+ To follow these instructions locally you will need a local copy of this
+ package. Start by cloning this project with something like::
+
+ $ git clone https://github.com/bioidiap/bob.example.faceverify.git
+ $ cd bob.example.faceverify
+
+
+Installation of the toolkit uses the `buildout <http://www.buildout.org/>`_
+build environment. You don't need to understand its inner workings to use this
+package. Here is a recipe to get you started (shell commands are marked with a
+``$`` signal):
+
+.. code-block:: sh
+
+ $ python bootstrap.py
+ $ ./bin/buildout
+
+These 2 commands should download and install all non-installed dependencies and
+get you a fully operational test and development environment.
+
+.. note::
+
+ The python shell used in the first line of the previous command set
+ determines the python interpreter that will be used for all scripts developed
+ inside this package. Because this package makes use of `Bob
+ <http://idiap.github.com/bob>`_, you must make sure that the ``bootstrap.py``
+ script is called with the **same** interpreter used to build Bob, or
+ unexpected problems might occur.
+
+ If Bob is installed by the administrator of your system, it is safe to
+ consider it uses the default python interpreter. In this case, the above 3
+ command lines should work as expected.
+
+
+Use this example with Bob not installed globally
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+If your Bob version is not installed globally, this package provides a
+configuration file *localbob.cfg* that has to be modified. Please search for the
+``bob.install.directory`` region and set the value according to your local Bob
+install directory. If you are at Idiap, you can simply choose one the existing
+directories.
+
+
+Use Bob at Idiap
+~~~~~~~~~~~~~~~~
+To get the example running nicely at Idiap, as noted above, ``bootstrap.py`` has
+to be executed with the correct python version. For Idiap, this is (currently):
+
+.. code-block:: sh
+
+ $ /idiap/group/torch5spro/nightlies/externals/v2/linux-x86_64/bin/python2.6 bootstrap.py
+ $ ./bin/buildout -c localbob.cfg
+
+
+Downloading the test database
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The images that are required to run the test are not included in this package,
+but they are freely downloadable from the internet:
+
+http://www.cl.cam.ac.uk/research/dtg/attarchive/facedatabase.html
+
+Unpack the database in a directory that fits you. The easiest solution is to
+create a subdirectory ``Database`` in this package. If you decide to put the
+data somewhere else, please remember the image directory.
+
diff --git a/faceverify/__init__.py b/faceverify/__init__.py
new file mode 100644
index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
diff --git a/faceverify/dct_ubm.py b/faceverify/dct_ubm.py
new file mode 100644
index 0000000000000000000000000000000000000000..17e86d97680a5465852cfe1a08cd07c94c23fd44
--- /dev/null
+++ b/faceverify/dct_ubm.py
@@ -0,0 +1,225 @@
+import bob
+import os, sys
+import numpy
+from matplotlib import pyplot
+
+# This is the base directory where by default the AT&T images are found. You can
+# overwrite this directory on the command line
+global ATNT_IMAGE_DIRECTORY
+ATNT_IMAGE_DIRECTORY = "Database"
+
+# The default file name extension of the AT&T images
+ATNT_IMAGE_EXTENSION = ".pgm"
+
+
+def load_images(db, group = None, purpose = None, client_id = None):
+ """Reads the images for the given group and the given client id from the given database"""
+ # get the file names from the database
+ file_names = db.files(groups = group, purposes = purpose, client_ids = client_id, directory = ATNT_IMAGE_DIRECTORY, extension = ATNT_IMAGE_EXTENSION)
+ # iterate through the list of file names
+ images = {}
+ for key, image_name in file_names.iteritems():
+ # load image and linearize it into a vector
+ images[key] = bob.io.load(image_name).astype(numpy.float64)
+ return images
+
+
+# Parameters of the DCT extraction
+DCT_BLOCK_SIZE = 12
+DCT_BLOCK_OVERLAP = 11
+NUMBER_OF_DCT_COMPONENTS = 45
+
+# create a DCT block extractor model
+dct_extractor = bob.ip.DCTFeatures(DCT_BLOCK_SIZE, DCT_BLOCK_SIZE, DCT_BLOCK_OVERLAP, DCT_BLOCK_OVERLAP, NUMBER_OF_DCT_COMPONENTS)
+
+def extract_feature(image):
+ """Extracts the DCT features for the given image"""
+
+ # compute shape of the image blocks
+ block_shape = bob.ip.get_block_3d_output_shape(image, DCT_BLOCK_SIZE, DCT_BLOCK_SIZE, DCT_BLOCK_OVERLAP, DCT_BLOCK_OVERLAP)
+ image_blocks = numpy.ndarray(block_shape, 'float64')
+
+ # fill image blocks
+ bob.ip.block(image, image_blocks, DCT_BLOCK_SIZE, DCT_BLOCK_SIZE, DCT_BLOCK_OVERLAP, DCT_BLOCK_OVERLAP)
+
+ # perform DCT on image blocks
+ dct_blocks = dct_extractor(image_blocks)
+
+ return dct_blocks
+
+
+
+# Parameters of the UBM/GMM module training
+NUMBER_OF_GAUSSIANS = 100
+
+def train(training_features):
+ """Trains the UBM/GMM module with the given set of training DCT features"""
+
+ # create array set used for training
+ training_set = bob.io.Arrayset()
+ # iterate through the training examples
+ for feature in training_features.values():
+ # stack the examples to generate training matrix
+ training_set.extend(feature)
+
+ input_size = training_set.shape[0]
+ # create the KMeans and UBM machine
+ kmeans = bob.machine.KMeansMachine(NUMBER_OF_GAUSSIANS, input_size)
+ ubm = bob.machine.GMMMachine(NUMBER_OF_GAUSSIANS, input_size)
+
+ # create the KMeansTrainer
+ kmeans_trainer = bob.trainer.KMeansTrainer()
+
+ # train using the KMeansTrainer
+ kmeans_trainer.train(kmeans, training_set)
+
+ [variances, weights] = kmeans.get_variances_and_weights_for_each_cluster(training_set)
+ means = kmeans.means
+
+ # initialize the GMM
+ ubm.means = means
+ ubm.variances = variances
+ ubm.weights = weights
+
+ # train the GMM
+ trainer = bob.trainer.ML_GMMTrainer()
+ trainer.train(ubm, training_set)
+
+ return ubm
+
+
+def enrol(model_features, ubm, gmm_trainer):
+ """Enrolls the GMM model for the given model features (which should stem from the same identity)"""
+ # create array set used for training
+ training_set = bob.io.Arrayset()
+ for feature in model_features.values():
+ training_set.extend(feature)
+ # create a GMM from the UBM
+ gmm = bob.machine.GMMMachine(ubm)
+
+ # train the GMM
+ gmm_trainer.train(gmm, training_set)
+
+ # return the resulting gmm
+ return gmm
+
+
+def stats(feature, ubm):
+ """Computes the UBM Statistics for the given feature vector"""
+ # compute the UBM stats for the given feature
+ feature = bob.io.Arrayset(feature)
+
+ # Accumulate statistics
+ gmm_stats = bob.machine.GMMStats(ubm.dim_c, ubm.dim_d)
+ gmm_stats.init()
+ ubm.acc_statistics(feature, gmm_stats)
+
+ return gmm_stats
+
+
+def main():
+ """This function will perform an a DCT block extraction and a UBM/GMM modeling test on the AT&T database"""
+
+ # use the bob.db interface to retrieve information about the Database
+ atnt_db = bob.db.atnt.Database()
+
+ # check if the AT&T database directory is overwritten by the command line
+ global ATNT_IMAGE_DIRECTORY
+ if len(sys.argv) > 1:
+ ATNT_IMAGE_DIRECTORY = sys.argv[1]
+
+ # check if the database directory exists
+ if not os.path.isdir(ATNT_IMAGE_DIRECTORY):
+ print "The database directory '" + ATNT_IMAGE_DIRECTORY + "' does not exists!"
+ return
+
+ #####################################################################
+ ### UBM Training
+ # load all training images
+ training_images = load_images(atnt_db, group = 'train')
+
+ print "Extracting training features"
+ training_features = {}
+ for key, image in training_images.iteritems():
+ training_features[key] = extract_feature(image)
+
+ print "Training UBM model"
+ ubm = train(training_features)
+
+ #####################################################################
+ ### GMM model enrollment
+ print "Enrolling GMM models"
+ gmm_trainer = bob.trainer.MAP_GMMTrainer()
+ gmm_trainer.max_iterations = 1
+ gmm_trainer.set_prior_gmm(ubm)
+
+ # create a GMM model for each model identity
+ model_ids = atnt_db.client_ids(groups = 'test')
+ models = {}
+ for model_id in model_ids:
+ # load images for the current model id
+ model_images = load_images(atnt_db, group = 'test', purpose = 'enrol', client_id = model_id)
+ models_for_current_id = {}
+ # extract model features
+ for key, image in model_images.iteritems():
+ models_for_current_id[key] = extract_feature(image)
+ # enroll model for the current identity from these features
+ model = enrol(models_for_current_id, ubm, gmm_trainer)
+ models[model_id] = model
+
+ #####################################################################
+ ### probe stats
+
+ print "Computing probe statistics"
+ probe_images = load_images(atnt_db, group = 'test', purpose = 'probe')
+ probes = {}
+ for key, image in probe_images.iteritems():
+ # extract probe features
+ probe_feature = extract_feature(image)
+ # compute GMM statistics
+ probes[key] = stats(probe_feature, ubm)
+
+ #####################################################################
+ ### compute scores, we here choose a simple Euclidean distance measure
+ positive_scores = []
+ negative_scores = []
+
+ print "Computing scores"
+ distance_function = bob.machine.linear_scoring
+
+ # iterate through models and probes and compute scores
+ for model_id, model_gmm in models.iteritems():
+ for probe_key, probe_stats in probes.iteritems():
+ # compute score
+ score = distance_function([model_gmm], ubm, [probe_stats])[0,0]
+
+ # check if this is a positive score
+ if model_id == atnt_db.get_client_id_from_file_id(probe_key):
+ positive_scores.append(score)
+ else:
+ negative_scores.append(score)
+
+ print "Evaluation"
+ # convert list of scores to numpy arrays
+ positives = numpy.array(positive_scores)
+ negatives = numpy.array(negative_scores)
+
+ # compute equal error rate
+ threshold = bob.measure.eer_threshold(negatives, positives)
+ FAR, FRR = bob.measure.farfrr(negatives, positives, threshold)
+
+ print "Result: FAR", FAR, "and FRR", FRR, "at threshold", threshold
+
+ # plot ROC curve
+ bob.measure.plot.roc(negatives, positives)
+ pyplot.xlabel("False Rejection Rate (%)")
+ pyplot.ylabel("False Acceptance Rate (%)")
+ pyplot.title("ROC Curve for UBM/GMM based AT&T Verification Experiment")
+ pyplot.grid()
+ pyplot.axis([0, 100, 0, 100]) #xmin, xmax, ymin, ymax
+
+ # save plot to file
+ pyplot.savefig("dct_ubm.png")
+ # show ROC curve
+ pyplot.show()
+
diff --git a/faceverify/eigenface.py b/faceverify/eigenface.py
new file mode 100644
index 0000000000000000000000000000000000000000..753b93bc94d6f67094eef5242e8d52972f64f5f8
--- /dev/null
+++ b/faceverify/eigenface.py
@@ -0,0 +1,148 @@
+import bob
+import os, sys
+import numpy
+from matplotlib import pyplot
+
+# This is the base directory where by default the AT&T images are found. You can
+# overwrite this directory on the command line
+global ATNT_IMAGE_DIRECTORY
+ATNT_IMAGE_DIRECTORY = "Database"
+
+# The default file name extension of the AT&T images
+ATNT_IMAGE_EXTENSION = ".pgm"
+
+
+def load_images(db, group = None, purpose = None):
+ """Reads the images for the given group and the given purpose from the given database"""
+ # get the file names from the database
+ file_names = db.files(groups = group, purposes = purpose, directory = ATNT_IMAGE_DIRECTORY, extension = ATNT_IMAGE_EXTENSION)
+ # iterate through the list of file names
+ images = {}
+ for key, image_name in file_names.iteritems():
+ # load image and linearize it into a vector
+ images[key] = bob.io.load(image_name).astype(numpy.float64)
+ return images
+
+
+# The number of eigenfaces that should be kept
+KEPT_EIGENFACES = 5
+
+def train(training_images):
+ """Trains the PCA module with the given list of training images"""
+ # perform training using a SVD PCA trainer
+ pca_trainer = bob.trainer.SVDPCATrainer()
+
+ # create array set used for training
+ training_set = bob.io.Arrayset()
+
+ # iterate through the training examples and linearize the images
+ for image in training_images.values():
+ training_set.append(image.flatten())
+
+ # training the SVD PCA returns a machine that can be used for projection
+ pca_machine, eigen_values = pca_trainer.train(training_set)
+
+ # limit the number of kept eigenfaces
+ pca_machine.resize(pca_machine.shape[0], KEPT_EIGENFACES)
+
+ return pca_machine
+
+
+def extract_feature(image, pca_machine):
+ """Projects the given list of images to the PCA subspace and returns the results"""
+ # create projection result in the desired size
+ projected_feature = numpy.ndarray((KEPT_EIGENFACES,), dtype = numpy.float64)
+
+ # project the data after linearizing them
+ pca_machine(image.flatten(), projected_feature)
+
+ # return the projected data
+ return projected_feature
+
+
+def main():
+ """This function will perform an eigenface test on the AT&T database"""
+
+ # use the bob.db interface to retrieve information about the Database
+ atnt_db = bob.db.atnt.Database()
+
+ # check if the AT&T database directory is overwritten by the command line
+ global ATNT_IMAGE_DIRECTORY
+ if len(sys.argv) > 1:
+ ATNT_IMAGE_DIRECTORY = sys.argv[1]
+
+ # check if the database directory exists
+ if not os.path.isdir(ATNT_IMAGE_DIRECTORY):
+ print "The database directory '" + ATNT_IMAGE_DIRECTORY + "' does not exists!"
+ return
+
+ #####################################################################
+ ### Training
+
+ # load all training images
+ training_images = load_images(atnt_db, group = 'train')
+
+ print "Training PCA machine"
+ pca_machine = train(training_images)
+
+ #####################################################################
+ ### extract eigenface features of model and probe images
+
+ # load model and probe images
+ model_images = load_images(atnt_db, group = 'test', purpose = 'enrol')
+ probe_images = load_images(atnt_db, group = 'test', purpose = 'probe')
+
+ print "Extracting models"
+ model_features = {}
+ for key, image in model_images.iteritems():
+ model_features[key] = extract_feature(image, pca_machine)
+ print "Extracting probes"
+ probe_features = {}
+ for key, image in probe_images.iteritems():
+ probe_features[key] = extract_feature(image, pca_machine)
+
+
+ #####################################################################
+ ### compute scores, we here choose a simple Euclidean distance measure
+ positive_scores = []
+ negative_scores = []
+
+ print "Computing scores"
+ distance_function = bob.math.euclidean_distance
+
+ # iterate through models and probes and compute scores
+ for model_key, model_feature in model_features.iteritems():
+ for probe_key, probe_feature in probe_features.iteritems():
+ # compute score
+ score = distance_function(model_feature, probe_feature)
+
+ # check if this is a positive score
+ if atnt_db.get_client_id_from_file_id(model_key) == atnt_db.get_client_id_from_file_id(probe_key):
+ positive_scores.append(score)
+ else:
+ negative_scores.append(score)
+
+ print "Evaluation"
+ # convert list of scores to numpy arrays
+ positives = numpy.array(positive_scores)
+ negatives = numpy.array(negative_scores)
+
+ # compute equal error rate
+ threshold = bob.measure.eer_threshold(negatives, positives)
+ FAR, FRR = bob.measure.farfrr(negatives, positives, threshold)
+
+ print "Result: FAR", FAR, "and FRR", FRR, "at threshold", threshold
+
+ # plot ROC curve
+ bob.measure.plot.roc(negatives, positives)
+ pyplot.xlabel("False Rejection Rate (%)")
+ pyplot.ylabel("False Acceptance Rate (%)")
+ pyplot.title("ROC Curve for Eigenface based AT&T Verification Experiment")
+ pyplot.grid()
+ pyplot.axis([0, 100, 0, 100]) #xmin, xmax, ymin, ymax
+
+ # save plot to file
+ pyplot.savefig("eigenface.png")
+ # show ROC curve
+ pyplot.show()
+
diff --git a/faceverify/gabor_phase.py b/faceverify/gabor_phase.py
new file mode 100644
index 0000000000000000000000000000000000000000..e8c1ed5834bf551aeeccb16fb137db70a907c2d6
--- /dev/null
+++ b/faceverify/gabor_phase.py
@@ -0,0 +1,135 @@
+import bob
+import os, sys
+import numpy
+from matplotlib import pyplot
+
+# This is the base directory where by default the AT&T images are found. You can
+# overwrite this directory on the command line
+global ATNT_IMAGE_DIRECTORY
+ATNT_IMAGE_DIRECTORY = "Database"
+
+# The default file name extension of the AT&T images
+ATNT_IMAGE_EXTENSION = ".pgm"
+
+
+def load_images(db, group = None, purpose = None):
+ """Reads the images for the given group and the given purpose from the given database"""
+ # get the file names from the database
+ file_names = db.files(groups = group, purposes = purpose, directory = ATNT_IMAGE_DIRECTORY, extension = ATNT_IMAGE_EXTENSION)
+ # iterate through the list of file names
+ images = {}
+ for key, image_name in file_names.iteritems():
+ # load image and linearize it into a vector
+ images[key] = bob.io.load(image_name).astype(numpy.float64)
+ return images
+
+
+# define Gabor wavelet transform class globally since it is reused for all images
+gabor_wavelet_transform = bob.ip.GaborWaveletTransform()
+# create empty Gabor jet image including Gabor phases in the required size
+jet_image = gabor_wavelet_transform.empty_jet_image(numpy.ndarray((112,92)), True)
+
+def extract_feature(image, graph_machine):
+ """Extracts the Gabor graphs from the given image"""
+
+ # create extraction result in the desired size
+ shape = [graph_machine.number_of_nodes]
+ # add the shape of one Gabor jet
+ shape.extend(jet_image[0,0].shape)
+ gabor_graph = numpy.ndarray(shape, dtype = numpy.float64)
+
+ # perform Gabor wavelet transform on the image
+ gabor_wavelet_transform.compute_jets(image, jet_image)
+
+ # extract the Gabor graphs from the feature image
+ graph_machine(jet_image, gabor_graph)
+
+ # return the extracted graph
+ return gabor_graph
+
+
+def main():
+ """This function will perform Gabor graph comparison test on the AT&T database"""
+
+ # use the bob.db interface to retrieve information about the Database
+ atnt_db = bob.db.atnt.Database()
+
+ # check if the AT&T database directory is overwritten by the command line
+ global ATNT_IMAGE_DIRECTORY
+ if len(sys.argv) > 1:
+ ATNT_IMAGE_DIRECTORY = sys.argv[1]
+
+ # check if the database directory exists
+ if not os.path.isdir(ATNT_IMAGE_DIRECTORY):
+ print "The database directory '" + ATNT_IMAGE_DIRECTORY + "' does not exists!"
+ return
+
+ #####################################################################
+ ### Training
+
+ # for Gabor graphs, no training is required.
+
+ print "Creating Gabor graph machine"
+ # create a machine that will produce tight Gabor graphs with inter-node distance (1,1)
+ graph_machine = bob.machine.GaborGraphMachine((0,0), (111,91), (1,1))
+
+ #####################################################################
+ ### extract Gabor graph features for all model and probe images
+ # load all model and probe images
+ model_images = load_images(atnt_db, group = 'test', purpose = 'enrol')
+ probe_images = load_images(atnt_db, group = 'test', purpose = 'probe')
+
+ print "Extracting models"
+ model_features = {}
+ for key, image in model_images.iteritems():
+ model_features[key] = extract_feature(image, graph_machine)
+ print "Extracting probes"
+ probe_features = {}
+ for key, image in probe_images.iteritems():
+ probe_features[key] = extract_feature(image, graph_machine)
+
+
+ #####################################################################
+ ### compute scores, we here choose a simple Euclidean distance measure
+ positive_scores = []
+ negative_scores = []
+
+ print "Computing scores"
+ # define a certain Gabor jet similarity function that should be used
+ similarity_function = bob.machine.DisparityCorrectedPhaseDifference()
+
+ # iterate through models and probes and compute scores
+ for model_key, model_feature in model_features.iteritems():
+ for probe_key, probe_feature in probe_features.iteritems():
+ # compute score using the desired Gabor jet similarity function
+ score = graph_machine.similarity(model_feature, probe_feature, similarity_function)
+
+ # check if this is a positive score
+ if atnt_db.get_client_id_from_file_id(model_key) == atnt_db.get_client_id_from_file_id(probe_key):
+ positive_scores.append(score)
+ else:
+ negative_scores.append(score)
+
+ print "Evaluation"
+ # convert list of scores to numpy arrays
+ positives = numpy.array(positive_scores)
+ negatives = numpy.array(negative_scores)
+
+ # compute equal error rate
+ threshold = bob.measure.eer_threshold(negatives, positives)
+ FAR, FRR = bob.measure.farfrr(negatives, positives, threshold)
+
+ print "Result: FAR", FAR, "and FRR", FRR, "at threshold", threshold
+
+ # plot ROC curve
+ bob.measure.plot.roc(negatives, positives)
+ pyplot.xlabel("False Rejection Rate (%)")
+ pyplot.ylabel("False Acceptance Rate (%)")
+ pyplot.title("ROC Curve for Gabor phase based AT&T Verification Experiment")
+ pyplot.grid()
+ pyplot.axis([0, 100, 0, 100]) #xmin, xmax, ymin, ymax
+
+ # save plot to file
+ pyplot.savefig("gabor_phase.png")
+ # show ROC curve
+ pyplot.show()
diff --git a/localbob.cfg b/localbob.cfg
new file mode 100644
index 0000000000000000000000000000000000000000..f51b78b83c83fd46371a5abc1c759363b7e635e7
--- /dev/null
+++ b/localbob.cfg
@@ -0,0 +1,48 @@
+; vim: set fileencoding=utf-8 :
+; Andre Anjos <andre.anjos@idiap.ch>
+; Mon 16 Apr 08:29:18 2012 CEST
+
+; Example buildout recipe using a local (off-root) Bob installation
+
+[buildout]
+parts = bob python
+develop = .
+
+; The 'mr.developer' extension is available publicly at PyPI (the python
+; package index). You don't need to worry about it as buildout will download
+; install it for you.
+extensions = mr.developer
+auto-checkout = *
+
+; Note: You will notice 'bob' is listed as an egg here. If you have a version
+; of Bob installed by the administrator, centrally, but want to use your
+; locally compiled version, that is required to assure the include path order
+; in generated scripts.
+eggs = bob.example.faceverify
+ bob
+
+[sources]
+; You will need this package so that buildout includes the path to Bob's build
+; or installation directory using this configuration file as reference.
+local.bob.recipe = git git@github.com:idiap/local.bob.recipe.git
+
+[bob]
+recipe = local.bob.recipe:config
+
+; Choose here your bob installation - **re-run buildout if you change it**
+; the path here can be relative or absolute to either the build directory of
+; Bob or to an installation directory. Both should work w/o problems.
+;
+; If you go for a relative path, remember this path is relative to the path
+; you are calling buildout from. This is normally the path that contains the
+; file 'setup.py' for your own package.
+install-directory = ../bob/build
+
+; Some examples for Idiap:
+;install-directory = /idiap/group/torch5spro/releases/bob-1.0.2/install/linux-x86_64-release
+;install-directory = /idiap/group/torch5spro/nightlies/last/install/linux-x86_64-release
+
+[python]
+recipe = zc.recipe.egg
+interpreter = python
+eggs = ${buildout:eggs}
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000000000000000000000000000000000000..de3bdb88967961109b4fc32712266a127475887f
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,78 @@
+#!/usr/bin/env python
+# vim: set fileencoding=utf-8 :
+# Manuel Guenther <Manuel.Guenther@idiap.ch>
+# Tue Apr 24 18:55:40 CEST 2012
+
+# This file contains the python (distutils/setuptools) instructions so your
+# package can be installed on **any** host system. It defines some basic
+# information like the package name for instance, or its homepage.
+#
+# It also defines which other packages this python package depends on and that
+# are required for this package's operation. The python subsystem will make
+# sure all dependent packages are installed or will install them for you upon
+# the installation of this package.
+#
+# The 'buildout' system we use here will go further and wrap this package in
+# such a way to create an isolated python working environment. Buildout will
+# make sure that dependencies which are not yet installed do get installed, but
+# **without** requiring adminstrative privileges on the host system. This
+# allows you to test your package with new python dependencies w/o requiring
+# administrative interventions.
+
+from setuptools import setup, find_packages
+
+# The only thing we do in this file is to call the setup() function with all
+# parameters that define our package.
+setup(
+
+ # This is the basic information about your project. Modify all this
+ # information before releasing code publicly.
+ name='bob.example.faceverify',
+ version='0.1',
+ description='Example for using Bob to create face verification systems',
+ url='http://github.com/idiap/bob.example.faceverify',
+ license='LICENSE.txt',
+ author_email='Manuel Guenther <Manuel.Guenther@idiap.ch>',
+
+ # If you have a better, long description of your package, place it on the
+ # 'doc' directory and then hook it here
+ #long_description=open('doc/long-description.rst').read(),
+
+ # This line is required for any distutils based packaging.
+ packages=find_packages(),
+
+ # This line defines which packages should be installed when you "install"
+ # this package. All packages that are mentioned here, but are not installed
+ # on the current system will be installed locally and only visible to the
+ # scripts of this package. Don't worry - You won't need adminstrative
+ # privileges when using buildout.
+ install_requires=[
+ "bob", # base signal proc./machine learning library
+
+ # here are some more examples you could include:
+ #"argparse", # better option parsing
+ ],
+
+ # This entry defines which scripts you will have inside the 'bin' directory
+ # once you install the package (or run 'bin/buildout'). The order of each
+ # entry under 'console_scripts' is like this:
+ # script-name-at-bin-directory = module.at.your.library:function
+ #
+ # The module.at.your.library is the python file within your library, using
+ # the python syntax for directories (i.e., a '.' instead of '/' or '\').
+ # This syntax also omits the '.py' extension of the filename. So, a file
+ # installed under 'example/foo.py' that contains a function which
+ # implements the 'main()' function of particular script you want to have
+ # should be referred as 'example.foo:main'.
+ #
+ # In this simple example we will create a single program that will print
+ # the version of bob.
+ entry_points={
+ 'console_scripts': [
+ 'eigenface.py = faceverify.eigenface:main',
+ 'gabor_phase.py = faceverify.gabor_phase:main',
+ 'dct_ubm.py = faceverify.dct_ubm:main'
+ ],
+ },
+
+)