From 182a137d4b172477bd8e3174fc35148abddd1303 Mon Sep 17 00:00:00 2001 From: ageorge <anjith.george@idiap.ch> Date: Fri, 15 Feb 2019 12:32:59 +0100 Subject: [PATCH] Mosa --- .gitignore | 13 + .gitlab-ci.yml | 129 ++++ COPYING | 674 ++++++++++++++++++ MANIFEST.in | 3 + README.md | 4 - README.rst | 53 ++ bob/__init__.py | 3 + bob/paper/__init__.py | 3 + bob/paper/mccnn/__init__.py | 3 + bob/paper/mccnn/tifs2018/__init__.py | 12 + bob/paper/mccnn/tifs2018/config/__init__.py | 0 .../tifs2018/config/preprocessor/__init__.py | 0 .../config/preprocessor/mc_preprocessor.py | 87 +++ bob/paper/mccnn/tifs2018/script/__init__.py | 0 bob/paper/mccnn/tifs2018/script/version.py | 13 + bob/paper/mccnn/tifs2018/test.py | 9 + buildout.cfg | 14 + conda/meta.yaml | 61 ++ doc/conf.py | 269 +++++++ doc/img/favicon.ico | Bin 0 -> 4286 bytes doc/img/logo.png | Bin 0 -> 6266 bytes doc/index.rst | 32 + doc/links.rst | 18 + doc/references.rst | 8 + requirements.txt | 7 + setup.py | 116 +++ version.txt | 1 + 27 files changed, 1528 insertions(+), 4 deletions(-) create mode 100644 .gitignore create mode 100644 .gitlab-ci.yml create mode 100644 COPYING create mode 100644 MANIFEST.in delete mode 100644 README.md create mode 100644 README.rst create mode 100644 bob/__init__.py create mode 100644 bob/paper/__init__.py create mode 100644 bob/paper/mccnn/__init__.py create mode 100644 bob/paper/mccnn/tifs2018/__init__.py create mode 100644 bob/paper/mccnn/tifs2018/config/__init__.py create mode 100644 bob/paper/mccnn/tifs2018/config/preprocessor/__init__.py create mode 100644 bob/paper/mccnn/tifs2018/config/preprocessor/mc_preprocessor.py create mode 100644 bob/paper/mccnn/tifs2018/script/__init__.py create mode 100644 bob/paper/mccnn/tifs2018/script/version.py create mode 100644 bob/paper/mccnn/tifs2018/test.py create mode 100644 buildout.cfg create mode 100644 conda/meta.yaml create mode 100644 doc/conf.py create mode 100644 doc/img/favicon.ico create mode 100644 doc/img/logo.png create mode 100644 doc/index.rst create mode 100644 doc/links.rst create mode 100644 doc/references.rst create mode 100644 requirements.txt create mode 100644 setup.py create mode 100644 version.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b8afedd --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +*~ +*.swp +*.pyc +bin +eggs +parts +.installed.cfg +.mr.developer.cfg +*.egg-info +src +develop-eggs +sphinx +dist diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..e4c0e14 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,129 @@ +# This build file uses template features from YAML so it is generic enough for +# any Bob project. Don't modify it unless you know what you're doing. + +# Definition of global variables (all stages) +variables: + CONDA_ROOT: "${CI_PROJECT_DIR}/miniconda" + + +# Definition of our build pipeline order +stages: + - build + - deploy + - pypi + + +# Build targets +.build_template: &build_job + stage: build + before_script: + - mkdir _ci + - curl --silent "https://gitlab.idiap.ch/bob/bob.admin/raw/master/gitlab/install.sh" > _ci/install.sh + - chmod 755 _ci/install.sh + - ./_ci/install.sh _ci master #installs ci support scripts + - ./_ci/before_build.sh + script: + - ./_ci/build.sh + after_script: + - ./_ci/after_build.sh + cache: &build_caches + paths: + - miniconda.sh + - ${CONDA_ROOT}/pkgs/*.tar.bz2 + - ${CONDA_ROOT}/pkgs/urls.txt + + +.build_linux_template: &linux_build_job + <<: *build_job + tags: + - docker + image: continuumio/conda-concourse-ci + artifacts: + expire_in: 1 week + paths: + - _ci/ + - ${CONDA_ROOT}/conda-bld/linux-64/*.tar.bz2 + cache: + <<: *build_caches + key: "linux-cache" + + +.build_macosx_template: &macosx_build_job + <<: *build_job + tags: + - macosx + artifacts: + expire_in: 1 week + paths: + - _ci/ + - ${CONDA_ROOT}/conda-bld/osx-64/*.tar.bz2 + cache: + <<: *build_caches + key: "macosx-cache" + + +build_linux_36: + <<: *linux_build_job + variables: + PYTHON_VERSION: "3.6" + BUILD_EGG: "true" + artifacts: + expire_in: 1 week + paths: + - _ci/ + - dist/*.zip + - sphinx + - ${CONDA_ROOT}/conda-bld/linux-64/*.tar.bz2 + + +build_macosx_36: + <<: *macosx_build_job + variables: + PYTHON_VERSION: "3.6" + + +# Deploy targets +.deploy_template: &deploy_job + stage: deploy + before_script: + - ./_ci/install.sh _ci master #updates ci support scripts + script: + - ./_ci/deploy.sh + dependencies: + - build_linux_36 + - build_macosx_36 + tags: + - deployer + + +deploy_beta: + <<: *deploy_job + environment: beta + only: + - master + + +deploy_stable: + <<: *deploy_job + environment: stable + only: + - /^v\d+\.\d+\.\d+([abc]\d*)?$/ # PEP-440 compliant version (tags) + except: + - branches + + +pypi: + stage: pypi + environment: pypi + only: + - /^v\d+\.\d+\.\d+([abc]\d*)?$/ # PEP-440 compliant version (tags) + except: + - branches + before_script: + - ./_ci/install.sh _ci master #updates ci support scripts + script: + - ./_ci/pypi.sh + dependencies: + - build_linux_36 + tags: + - deployer diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -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 0000000..11190ee --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,3 @@ +include README.rst bootstrap-buildout.py buildout.cfg COPYING version.txt requirements.txt +recursive-include doc *.py *.rst *.ico *.png +recursive-include bob/paper/mccnn/tifs2018/config *.pth diff --git a/README.md b/README.md deleted file mode 100644 index 6c70684..0000000 --- a/README.md +++ /dev/null @@ -1,4 +0,0 @@ -Source code and score files for reproducing the experiments and figures of the paper "Biometric Face Presentation Attack Detection with Multi-Channel Convolutional Neural Network" - - -The databse, source code, and score files would be available upon the acceptance of the paper. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..d0779e2 --- /dev/null +++ b/README.rst @@ -0,0 +1,53 @@ +.. vim: set fileencoding=utf-8 : +.. Mon 03 Jul 2017 11:50:06 CEST + +.. image:: http://img.shields.io/badge/docs-stable-yellow.svg + :target: http://beatubulatest.lab.idiap.ch/private/docs/bob/bob.paper.mccnn.tifs2018/stable/index.html +.. image:: http://img.shields.io/badge/docs-latest-orange.svg + :target: http://beatubulatest.lab.idiap.ch/private/docs/bob/bob.paper.mccnn.tifs2018/master/index.html +.. image:: https://gitlab.idiap.ch/bob/bob.paper.mccnn.tifs2018/badges/master/build.svg + :target: https://gitlab.idiap.ch/bob/bob.paper.mccnn.tifs2018/commits/master +.. image:: https://gitlab.idiap.ch/bob/bob.paper.mccnn.tifs2018/badges/master/coverage.svg + :target: https://gitlab.idiap.ch/bob/bob.paper.mccnn.tifs2018/commits/master +.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg + :target: https://gitlab.idiap.ch/bob/bob.paper.mccnn.tifs2018 +.. image:: http://img.shields.io/pypi/v/bob.paper.mccnn.tifs2018.svg + :target: https://pypi.python.org/pypi/bob.paper.mccnn.tifs2018 + + +============================================ +Face PAD using Multi-Channel CNN +============================================ + +This package is part of the Bob_ toolkit and it allows to reproduce the experimental results published in the following paper:: + + @inproceedings{GeorgeTIFS2019, + author = {Anjith George, Zohreh Mostaani, David Geissenbuhler, Olegs Nikisins, Andre Anjos, Sebastien Marcel}, + title = {Biometric Face Presentation Attack Detection with Multi-Channel Convolutional Neural Network}, + year = {2019}, + booktitle = {TIFS 2019}, + } + +If you use this package and/or its results, please cite the paper. + +Installation +------------ + +Follow our `installation`_ instructions. Then, using the Python interpreter +provided by the distribution, build this package with:: + + $ buildout + + +Contact +------- + +For questions or reporting issues to this software package, contact our +development `mailing list`_. + + +.. Place your references here: +.. _bob: https://www.idiap.ch/software/bob +.. _installation: https://www.idiap.ch/software/bob/install +.. _mailing list: https://www.idiap.ch/software/bob/discuss +.. _bob package development: https://www.idiap.ch/software/bob/docs/bob/bob.extension/master/ diff --git a/bob/__init__.py b/bob/__init__.py new file mode 100644 index 0000000..2ab1e28 --- /dev/null +++ b/bob/__init__.py @@ -0,0 +1,3 @@ +# see https://docs.python.org/3/library/pkgutil.html +from pkgutil import extend_path +__path__ = extend_path(__path__, __name__) diff --git a/bob/paper/__init__.py b/bob/paper/__init__.py new file mode 100644 index 0000000..2ab1e28 --- /dev/null +++ b/bob/paper/__init__.py @@ -0,0 +1,3 @@ +# see https://docs.python.org/3/library/pkgutil.html +from pkgutil import extend_path +__path__ = extend_path(__path__, __name__) diff --git a/bob/paper/mccnn/__init__.py b/bob/paper/mccnn/__init__.py new file mode 100644 index 0000000..2ab1e28 --- /dev/null +++ b/bob/paper/mccnn/__init__.py @@ -0,0 +1,3 @@ +# see https://docs.python.org/3/library/pkgutil.html +from pkgutil import extend_path +__path__ = extend_path(__path__, __name__) diff --git a/bob/paper/mccnn/tifs2018/__init__.py b/bob/paper/mccnn/tifs2018/__init__.py new file mode 100644 index 0000000..b6752da --- /dev/null +++ b/bob/paper/mccnn/tifs2018/__init__.py @@ -0,0 +1,12 @@ +from . import script + +def get_config(): + """Returns a string containing the configuration information. + """ + + import bob.extension + return bob.extension.get_config(__name__) + + +# gets sphinx autodoc done right - don't remove it +__all__ = [_ for _ in dir() if not _.startswith('_')] diff --git a/bob/paper/mccnn/tifs2018/config/__init__.py b/bob/paper/mccnn/tifs2018/config/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/bob/paper/mccnn/tifs2018/config/preprocessor/__init__.py b/bob/paper/mccnn/tifs2018/config/preprocessor/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/bob/paper/mccnn/tifs2018/config/preprocessor/mc_preprocessor.py b/bob/paper/mccnn/tifs2018/config/preprocessor/mc_preprocessor.py new file mode 100644 index 0000000..5d8ceba --- /dev/null +++ b/bob/paper/mccnn/tifs2018/config/preprocessor/mc_preprocessor.py @@ -0,0 +1,87 @@ + +# ============================================================================= +# define instance of the preprocessor: + +from bob.pad.face.preprocessor import VideoFaceCropAlignBlockPatch + +from bob.pad.face.preprocessor import FaceCropAlign + +from bob.bio.video.preprocessor import Wrapper + +from bob.bio.video.utils import FrameSelector + +from bob.pad.face.preprocessor.FaceCropAlign import auto_norm_image as _norm_func + +from torchvision import transforms + +from bob.learn.pytorch.datasets import ChannelSelect + +# names of the channels to process: +_channel_names = ['color','depth','infrared','thermal'] + +# dictionary containing preprocessors for all channels: +_preprocessors = {} + +""" +Preprocessor to be used for Color channel. +""" +FACE_SIZE = 128 # The size of the resulting face +RGB_OUTPUT_FLAG = False # BW output +USE_FACE_ALIGNMENT = True # use annotations +MAX_IMAGE_SIZE = None # no limiting here +FACE_DETECTION_METHOD = 'mtcnn' # use ANNOTATIONS +MIN_FACE_SIZE = 50 # skip small faces +ALIGNMENT_TYPE = 'lightcnn' + +_image_preprocessor = FaceCropAlign(face_size = FACE_SIZE, + rgb_output_flag = RGB_OUTPUT_FLAG, + use_face_alignment = USE_FACE_ALIGNMENT, + alignment_type =ALIGNMENT_TYPE, + max_image_size = MAX_IMAGE_SIZE, + face_detection_method = FACE_DETECTION_METHOD, + min_face_size = MIN_FACE_SIZE) + +_frame_selector = FrameSelector(selection_style = "all") + +_preprocessor_rgb = Wrapper(preprocessor = _image_preprocessor, + frame_selector = _frame_selector) + +_preprocessors[_channel_names[0]] = _preprocessor_rgb + +""" +Preprocessor to be used for Depth, Infrared or Thermal channels: +""" +FACE_SIZE = 128 # The size of the resulting face +RGB_OUTPUT_FLAG = False # Gray-scale output +USE_FACE_ALIGNMENT = True # use annotations +MAX_IMAGE_SIZE = None # no limiting here +FACE_DETECTION_METHOD = None # use annotations +MIN_FACE_SIZE = 50 # skip small faces +NORMALIZATION_FUNCTION = _norm_func +NORMALIZATION_FUNCTION_KWARGS = {} +NORMALIZATION_FUNCTION_KWARGS = {'n_sigma':3.0, 'norm_method':'MAD'} + +_image_preprocessor_ir = FaceCropAlign(face_size = FACE_SIZE, + rgb_output_flag = RGB_OUTPUT_FLAG, + use_face_alignment = USE_FACE_ALIGNMENT, + alignment_type =ALIGNMENT_TYPE, + max_image_size = MAX_IMAGE_SIZE, + face_detection_method = FACE_DETECTION_METHOD, + min_face_size = MIN_FACE_SIZE, + normalization_function = NORMALIZATION_FUNCTION, + normalization_function_kwargs = NORMALIZATION_FUNCTION_KWARGS) + +_preprocessor_ir = Wrapper(preprocessor = _image_preprocessor_ir, + frame_selector = _frame_selector) + +_preprocessors[_channel_names[1]] = _preprocessor_ir + + +_preprocessors[_channel_names[2]] = _preprocessor_ir + +_preprocessors[_channel_names[3]] = _preprocessor_ir + + +mc_preprocessor = VideoFaceCropAlignBlockPatch(preprocessors = _preprocessors, + channel_names = _channel_names, + return_multi_channel_flag = True) diff --git a/bob/paper/mccnn/tifs2018/script/__init__.py b/bob/paper/mccnn/tifs2018/script/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/bob/paper/mccnn/tifs2018/script/version.py b/bob/paper/mccnn/tifs2018/script/version.py new file mode 100644 index 0000000..6d1f941 --- /dev/null +++ b/bob/paper/mccnn/tifs2018/script/version.py @@ -0,0 +1,13 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : + +""" +Print the text +""" + +def main(): + """Print the text""" + + print ("Print test text") + return 0 + diff --git a/bob/paper/mccnn/tifs2018/test.py b/bob/paper/mccnn/tifs2018/test.py new file mode 100644 index 0000000..ecba988 --- /dev/null +++ b/bob/paper/mccnn/tifs2018/test.py @@ -0,0 +1,9 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : + +"""Test Units +""" + +def test_version(): + from .script import version + assert version.main() == 0 diff --git a/buildout.cfg b/buildout.cfg new file mode 100644 index 0000000..fbe6a7e --- /dev/null +++ b/buildout.cfg @@ -0,0 +1,14 @@ +; vim: set fileencoding=utf-8 : +; Fri Dec 23 13:58:08 CET 2016 + +[buildout] +parts = scripts +develop = . +eggs = bob.paper.mccnn.tifs2018 +extensions = bob.buildout +newest = false +verbose = true + +[scripts] +recipe = bob.buildout:scripts +dependent-scripts = true \ No newline at end of file diff --git a/conda/meta.yaml b/conda/meta.yaml new file mode 100644 index 0000000..69218db --- /dev/null +++ b/conda/meta.yaml @@ -0,0 +1,61 @@ +{% set name = 'bob.paper.mccnn.tifs2018' %} +{% set project_dir = environ.get('RECIPE_DIR') + '/..' %} + +package: + name: {{ name }} + version: {{ environ.get('BOB_PACKAGE_VERSION', '0.0.1') }} + +build: + skip: true # [not linux] + number: {{ environ.get('BOB_BUILD_NUMBER', 0) }} + run_exports: + - {{ pin_subpackage(name) }} + script: + - cd {{ project_dir }} + {% if environ.get('BUILD_EGG') %} + - python setup.py sdist --formats=zip + {% endif %} + - python setup.py install --single-version-externally-managed --record record.txt + +requirements: + # place your build dependencies before the 'host' section + host: + - python {{ python }} + - setuptools {{ setuptools }} + - six {{ six }} + - numpy + - bob.extension + - bob.bio.base + - bob.bio.video + - bob.pad.face + - bob.learn.pytorch + run: + - python + - setuptools + - six {{ six }} + - numpy + +test: + imports: + - {{ name }} + commands: + # test commands ("script" entry-points) from your package here + - nosetests --with-coverage --cover-package={{ name }} -sv {{ name }} + - sphinx-build -aEW {{ project_dir }}/doc {{ project_dir }}/sphinx + - sphinx-build -aEb doctest {{ project_dir }}/doc sphinx + - conda inspect linkages -p $PREFIX {{ name }} # [not win] + - conda inspect objects -p $PREFIX {{ name }} # [osx] + requires: + - bob-devel {{ bob_devel }}.* + - nose + - coverage + - sphinx + - sphinx_rtd_theme + - gridtk + # extend this list with further test-time-only dependencies + +about: + home: https://www.idiap.ch/software/bob/ + license: GNU General Public License v3 (GPLv3) + summary: Implements tools for reproducing Multi Channel CNN based face PAD experiments. + license_family: GPL diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..45c1a85 --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,269 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : + +import os +import sys +import glob +import pkg_resources + + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = '1.3' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [ + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.ifconfig', + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.doctest', + 'sphinx.ext.graphviz', + 'sphinx.ext.intersphinx', + 'sphinx.ext.napoleon', + 'sphinx.ext.viewcode', + #'matplotlib.sphinxext.plot_directive' + ] + +import sphinx +if sphinx.__version__ >= "1.4.1": + extensions.append('sphinx.ext.imgmath') + imgmath_image_format = 'svg' +else: + extensions.append('sphinx.ext.pngmath') + +# Be picky about warnings +nitpicky = True + +# Ignores stuff we can't easily resolve on other project's sphinx manuals +nitpick_ignore = [] + +# Allows the user to override warnings from a separate file +if os.path.exists('nitpick-exceptions.txt'): + for line in open('nitpick-exceptions.txt'): + if line.strip() == "" or line.startswith("#"): + continue + dtype, target = line.split(None, 1) + target = target.strip() + try: # python 2.x + target = unicode(target) + except NameError: + pass + nitpick_ignore.append((dtype, target)) + +# Always includes todos +todo_include_todos = True + +# Generates auto-summary automatically +autosummary_generate = True + +# Create numbers on figures with captions +numfig = True + +# If we are on OSX, the 'dvipng' path maybe different +dvipng_osx = '/opt/local/libexec/texlive/binaries/dvipng' +if os.path.exists(dvipng_osx): pngmath_dvipng = dvipng_osx + +# 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.paper.mccnn.tifs2018' +import time +copyright = u'%s, Idiap Research Institute' % time.strftime('%Y') + +# Grab the setup entry +distribution = pkg_resources.require(project)[0] + +# 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 = distribution.version +# The full version, including alpha/beta/rc tags. +release = distribution.version + +# 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 = ['links.rst'] + +# 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 = [] + +# Some variables which are useful for generated material +project_variable = project.replace('.', '_') +short_description = u'Example for using Bob inside a buildout project' +owner = [u'Idiap Research Institute'] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +import sphinx_rtd_theme +html_theme = 'sphinx_rtd_theme' + +# 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 = [sphinx_rtd_theme.get_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 = project_variable + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +html_logo = 'img/logo.png' + +# 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 = 'img/favicon.ico' + +# 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 = project_variable + u'_doc' + + +# -- Post configuration -------------------------------------------------------- + +# Included after all input documents +rst_epilog = """ +.. |project| replace:: Bob +.. |version| replace:: %s +.. |current-year| date:: %%Y +""" % (version,) + +# Default processing flags for sphinx +autoclass_content = 'class' +autodoc_member_order = 'bysource' +autodoc_default_flags = [ + 'members', + 'undoc-members', + 'inherited-members', + 'show-inheritance', + ] + +# For inter-documentation mapping: +from bob.extension.utils import link_documentation, load_requirements +sphinx_requirements = "extra-intersphinx.txt" +if os.path.exists(sphinx_requirements): + intersphinx_mapping = link_documentation( + additional_packages=['python','numpy'] + \ + load_requirements(sphinx_requirements) + ) +else: + intersphinx_mapping = link_documentation() + + +# We want to remove all private (i.e. _. or __.__) members +# that are not in the list of accepted functions +accepted_private_functions = ['__array__'] + +def member_function_test(app, what, name, obj, skip, options): + # test if we have a private function + if len(name) > 1 and name[0] == '_': + # test if this private function should be allowed + if name not in accepted_private_functions: + # omit privat functions that are not in the list of accepted private functions + return skip + else: + # test if the method is documented + if not hasattr(obj, '__doc__') or not obj.__doc__: + return skip + return False + +def setup(app): + app.connect('autodoc-skip-member', member_function_test) diff --git a/doc/img/favicon.ico b/doc/img/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..4cc3264302627d40868261add69eb755856611b6 GIT binary patch literal 4286 zcmZQzU}RuqP*4ET3Jfa*7#PGD7#K7d7#I{77#JKFAmR)lAi%)D#|Xh7E(rhs|DS<W z%)r3FDZt5@C&<G!Rfvycs~8X0Wl?_4{Sy2<QzZnsvZMrgZ5S9Bm`OF481?*|oWX+J z?3aXiIR6Xta{d?L<@ztm$Ms)~pZmW!KlgtL0iOSoAS}rHTuO+y1mt~U%q2#RAU9`) z5D({HVIGjZoc~1;c7K%M=Q<-H!1DuSx0E2ye`z7!|1v_n|7C^wb}NhX=n!K*J~bj- zTt>n?93Mq^k?iH;{x8nQvw@$VUl62MmY-i)il4VsT8QV7j4&U_?*DQkeE;Qz`QIvv z@t0B(79zad`@rGM#{~{&P*{ueb3YdsXW$0ejf`bPc<kkb`QFKk@c&m3<^QiJD)3)P zOyIwYsNfW2b;Pm-1Ox=c`MJMIfa8}N8oxaMr3865;W9%(ls{Zil>fV;7{qR6al!v8 z;)4HFB?YT->A@u~#n101DG0KU=fAWdFFbCgMfhrQ=>dr=i3+wu?ftJRA@pBOQs}?B zq|i?d84(ANJh50-m?s;WmLPE|%m;~AQQl;HW+;k@iK|KozJl8OUqedxzowM%e{E^e zV+;%oO!)L7%PENPMS|iIghBBM!q7NvL{^85tu84%0c5Y1wD5mz8Ik|GvLgTWWkvrR z$cd+7Q;$tdO@>oiNlf4;C=Dr#3H*nJsfxJZ3T*0;#kAyvv~^`f{^^136#Z`~FZ$nD zLF~VYqUaiAb%fZel7bgNaR|bo@C0FXNuhVTa*(`-Prs48$P=)g3S$4w6vh6VD~bQN zR1$w{EG5N-Pam?JhLq4eP&k6HrnK;XEol*OcxuZEXCte_#<oxvKVSi}Q(64KwTk$E z8x@KFcB&Hp?KPw=v8l%<rYj?^t0yb+85DQ=a-jHwgr$+Z=zU`;DG_XXU}82Z602=h zCH~u~N&I(Ell<?fF8SX{L-N0ihD;Dl4KcK_f_S^Bg4lmkMMOA){AHmmF&&?NM|H{5 zAp4v(r2e~VO8t*El>T3BEAzk8Nh%SaK6E*2brD``Rk0h^DiYu@1p5i%ub&PY5?J%J zx2~L0imBA6278(Roz61<J6&b|cezXd@Ai=X-|H!5h;9cVzN4yC6gd3UCI35XfUwkm z7fq@Eu3FNkLPIg@+%9+NHDLQZrT_PMOaJfnk^bN7C-uM2U+N(tyKu=@+sSU~aDw{B z1?nd^>Hpns(%`bSp@D&^*H_x2*GFncuP@lH|NQ|{|NDca{!a*&{68^N^8chz$qgX$ zyIf^bI$UH<p<q{;Qys1{r@GvwQE<11^r>!7=~G>v(l<bU0b#IzKz2a<^r=5U>imR2 zsW%gXrT$L{f!Y-=`F~P`<p0T$lK&@1OZ=Y_EpdNxq?888{sspImR=vJ;~;mUV32tr z><@8&AISZIQvdrw80-&-`7k>shDrXP1hXef0%A{$#Q&+W691>hN&KIdAn|`%qWJ%5 zNn%f@rAQis?1tfqp;9&zLnXg~!Ubdw41>*snhAG5$m}SvAO25?k@!CaYCf_Z)04#i zPfr&AKO;r_|BO`e|1;CX|IbVp`#CF9Z2i1!adVix$n?~BiJqx(5}&|0UgFc#c!^Kb z5|D7B_@`-!;-97`iGP}&48b!}#6QhQ75@t{U;O{f46*;SGR6MS$`boOJ4@{KoE-7f zb8^Mj&dC$&oSQ4Ak8B?Xn}LCGeu4rAsd#p-c>kO{(f@PvMgPw&5dA-|Q1t)2BGLZ~ zN<>#;*g-~Hmyj7ta)tO7lnY;9ST6E^VTH*5g_R=z7gdS;UsNsfZ*i?~93lPGkYCy$ z9JHiC`0vsN;r~k;h5s*W68gWaS?K?=7NG}gTSX+PVFw{IR<sK)S=lM{e`S~8|CQZ> z|5t%<kKq3`eFBRJ>7|DJ+DSq(t0xFNSvyJK|Jum{|JO|s_`hx{82?>6LnwqAcHlB& z?M!~74KoDdHq7K-v2hmv|BbWx|8Jbb|9{h5{{Nfi@%`UCkMH*81p;wkJfBY$mpSB$ z@88eBvSlHE>z0LlU$-vi`wzxTc>ix(%KLxYGT#5&m-GJLzJmAvwpF|*7A?YTuaj#p zy1uO|dF*zq;W@i=4bT6bYaw{oI-dW#*7N+|y@BWTuJzmo=z6HlU$u&XbMIE}346D4 z|Jb{g`#%)_+q;!3h1z!EGjHE^Zuh<0xUYch-?No_4nDQClH0b8fp6b-?za7_7<h2n z@q_XI{|^lH{~s{e|39F>|NlS*|Nn+R?Ef47G5>G)$N0bDKLj7BZ}<<!_6`3ZfUrEn z{}23(|9@~Wg8G%9{(b`k1N#962KfUFj8N+u>i_>g0K)eF|2MEh@B{w;|3Aq8|NqDS I|NnpX0RF|L5C8xG literal 0 HcmV?d00001 diff --git a/doc/img/logo.png b/doc/img/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..b60858a7068bf45c1ed8e3da12fe244ccdcfe85d GIT binary patch literal 6266 zcmeAS@N?(olHy`uVBq!ia0y~yVA##Tz>vbh!oa{#^08Bzfq{W3$=lt9;eUJonf(k5 z44efXk;M!QOfx{3(d@GOeFg>w_7YEDSM~=S+}t7z@=~s03=9(7o-U3d6}R5bt(+4R zI`w${^Q&>OSF@`;ms@j3HVClrw5Xm)n<6L?8N#Hr=}bE#W1wT3V9KJJV~nLwn46Ro z+WKo;%vdM-vM@C{MND$=P*T+1yJYgalI#2SS3m1t^{VRYt9#+=cUv{i^Iv7>8M^oB zyzl$I-zh$C`~2SZBR9U!Iw5{_p(yj5O?F<l*|VG$Zm)egt2poI#H)S9@0?8&PyC(x zJGR#S`9;gx>>0l*F5A7SX0CcIDK1~;nr!~y(8=X_f7JiZDvy@gdw!cgLs9<kp7r-` z?!56<JMZSMr`z5?F5KFBzkP4ni(o(N_aEMyoHfW3{&i|9f9(17Z;Xwq*>)~p`FfT0 z?!M1IeCKsNzTmt)&g1W&hjwp-`S(73vROR#whgxcgU0@~8_qx9zUjm7o--8_cQ;=? z_q*~t=R5|V6PaIT<VNT17p$KW`J?v6arV7Gms}RVd%@=RhNCSq3LJmePVM*5{S#+q z6q0UP;$4&{q)`6LN`K$l>`wg^(;cTbl<QcOymmF>-XFg4a*RyE#^?lAyN5SA4c?wO zFZcQHvzsnV*LLv<*!-L9cXvnYyXXCOX3CpO{(V_qn!j_;CH-Y5ZvFOu_(om2diL+` z^6m8(FZ*~s3AxBrw&wRw(?8SuJ#TmJ+iPPmnRmr$ZG~OGuS(m$ywK>acWL*g_0L%t z*1xux?!NSG%Ln&$<)#cRRp%r7`qz5z{qjrG+)~E%PTI;{|IS;_+cC@j<6rB*k5cPv zR{aby{v`Cx<;m3b`#yd-E;sq-p)Eh}tF&u8c*d1`f9tzW`41`utGcdN9NZ~8Uo`8q zUe)}lpL;?rt2uw4xxdT$i_znx6dC!-ztS@EY~DQ<{ObPK<MXS4$~T8+%kMdLE8(5! z8}XP+Rckbwb6xbm%xgE>V>olqH~+h@=P$kXHKgQgY1qZ%dt3hAc;>v1e|y}+y(0GI z^&g&m)luXBvUz&RoJHOff)Db%{c&2_KU6zeKVklN>GLItO>w{MC99ru@%hTV*lgqd zu7u5{wLPw;b-P_%Wods-e{y`4+w12oC#OwcuzBC(kEQjqeb~}IzTH>3>&Ss8`%@pi z&hy~E^`Yb2n%@NpcMVs+ezxg||M~x1wI3c_v@xn&Fn`yE&#eB7PZg%TtN+BGUc9Wz zvf85c@5}ff&$y=C`}HE)K|!$cfAnNdtIV_CEv37|*N5K;&G`L!`pw3D?Y(DSc1NEN z+1bk@W<9^^ee21TgnfVR-(z*M)H{2`{H}=PhRDY1b0@a!@{0@I?r^PF%xb=GzwF7w zli7cL+`N4MyUfs^uMV6`|5qZm{O#1O>|6i-m|yYybr3%rgV99Ya38f74!@b#g>7AT zeB0m0_un{~CoUJOP=BSwKfmn2Pbcm7PTem!&sfLBZk@KwSMJ5~Ik)$0crh{5?fT}E z{O_cE0-1|EHrlBv8}EPD@cS#9S>%IL4@AQoru@yjp>MF8W9OFjJM3lO{%@CF6Ix}F zrg?RHnDOM4>eW{#>bC#5m9o#O(Xr!g%>NJTdUvx=JYv8$(Sc90<*I1Hfqz@?o6SGZ zwnFFNxl8fKjJa;DS)n6$ReV}sMBv4bQ7uc4y=uR4%l*<@)w^k#YMl%(R^}K@KjCIP z@yv&HU!}u7r{y>Y*@?&;t$X(9TKb)@F>UK*#JtbAevDVmcr3W&MMz{<|M7->w+u~| zy;68-nNld?xw`Ry(njlBo1Y#%`#wRn&2rHJzjL3%ugd0Ji;5JTa*J{1s>2m+Tlbwl z%o6q@`})_cs{yi>n#@coKaMZB_`b^Q&i0o(d-W4kf1O_J$NDDyfBxlikL1qEi3hi> zVyT>R@s8V?51Sqp?-6w{`#$+m#UzFBM*a0HY>ww!s;}9Yd|=Np@VleHwjt&Jy8XMO zpFDGoWBnOlbmiImH7`n@+O|mjbm=!Z!L)bH>n)34f70@3Gq?G9uxL-Pk=YT3bG3Wl zY0Rut^gJGw8I!Ur|6SVK3fJV<5tU6oJ*DYct#>Mx?G!o_I>9&R|8MK^hn0Q(zuu<D zTrb%X@M@dPHmR+#wcB4sJU#HeZQJR66Lmi?x>m~c;KO;FgMu~2T}}o^Dx-q`h8A$C zzI#-jczNQQ9L}pc|88uV`<<!4!IXD#k+$cTc`3SwuU5Wz)1ASc&&ZH|`tB}u<0aQh zcYfEq?`5}^&#QX9x?sCIci++F7lY@tS$;n9M7{gsmU%8-+!Idg)iF)*4&YkERJ8Y* z+R~dBm8V>7dZM=U-t_;M_7wZQi+BBAAfjL)*kUKxTNZYCj(KcuQSu>yU+d!cls}&H zYg_BN#VcnoyI8Y!>n?xc_x0tGw;xBg7uFxX^Wbt{Tg`7_(OicVw`oV;Wxx6$w^(-p zU#^y{OYhGg+rk<a^eSCkAX?{Yw*DVqoL+E+-ItzY)u#QYmZcw_eV%je9CPi0EoBoH zGY89ZZ)rHQXG-{i3+?OwTJPtvux#h-s+j*{!De5NTr1{|`XBd<`V^Yt{%|t%&3wPh z*IMpf(Eot0Q=eb_ugbo=v6jF1ibnc5;gf7%Lzi6pa`#{%Pg3r`?`JCCrIv7+9y&B5 z<ALA*MMpLtlblf;yHEPYVxN13PuAP&7w{=ZOub)lN9jB7Eupjilf1M-9csfrR8+NA z9%9;md`{T+70*ITm*0GGZK>_~S?4Vu2^E^kPVkp7C|UW{FYn(ABQuw$>2dG&`Q|!& zdDy7B@#?d+#s6FLmRDXgv)i`q{p&r;zEpqHuf4BevB0sJ`DcFLMdP5`_ieQT1*7d> zD!pxwG7l};mvZ6fzp1OIefq|EO0U!+#$Iu~;ccZJNr}EaSF}Ad_LSy7>Ud$zxn!bi zUdZE}Z{EK7P;*S+aDKrb_LyUTQ+I0H{`08uT{?$<{$b8X^Lak+zOqYVo?d%mWb$>J z+)Td6B@-NY1X~Py?%wE4Y!P%evHWnkMP=c~OGW>Z*7?it&ENax)u;W;mkWQisD4fR zd!y80ser7cis0dd_f@WDwaz^8LeY_3Ht}6y*9&xdSEb%vzeVzCP)~Y_8Gnra{OE0k z?D1>f3r)(>^(r!9<-HO6J+Sy^U7Legri#GP3#)SXPb{t|<c*)(J#(V;{_5yi;(h|( zSnsamF3}R3bA6(L8`mvCU;ckOm)Bc;Z+`njbu&-p$KBUj4xL(XPWfes<hDQ2{jUFl z=gz$Q#p++g%ExY<?_M5#HMeeJ^2A79ult*Kx9L4z;&rae{m1%ac3$S840qPD`v`n{ z@b}gfnV=5QgmwW(rk70*J=WbTU4QlFBeUAMk;i)-R`9)LaCq`ZmG$Z}rL9VTwxqs! z#<p?uC!6LuPG7hEkTpM)+ZOvruc)&<>3#G`&i~;mlN^q*>{;@8p4lZehTl#4%f<T> zSQL*;aM%@adNFT(#tS3Ah`IYU+s)UW;rV%imtpSp%=Q^;D_{2HyuToNE%LYS;XnI) zPIuqdXy9Y`aNl$Dlec~j3ZEYyFv^z8zSp1ImmqPNL$OVzNKL+%X~lZW>9^iw{*=GF zxJ!!5_GiGOy{j&MvRl1Tqw*q)Pv*zk$+BAey_X1YPp@8e>SmnQY%RAVPn@;Q%4ObI zcDo0cJ7_wyF;uCP<bJix`6DRLmNL;*s)5<h;$h3`2b>e-8)t1azxQf}_7uh2XWE(n zht@J}jYt)Jmc(Av@Z0>#N<EF;RZsM!PfnQUCCT=OFNNXx-YWr8vjQzE{Pv4f-ea56 z-xEH|Sx<ht=7MymU2bnKKl^zuF}1};eCw+xJRD&~Hv4Dzu!W^;*j(G0&8eL{A*uYw zr=*<oLFcmBj!xYo@x^!VrL6%TU*|ABscK)hW%Hw!?PBMRyG|>%n>3U#O_bVL{qFLt zNXdI%>pASRmrr?Xy~{mdIagb!37hQchv95TzFb+n(zNVJ$9BP`Rgq5x876)(j6Hqs z)L+(?l}B=K+F2L<2<6zic~WO_?k&5=HP@B4u1jB4R>Y=oVaiIri8*_l_)=2yG`D9y zVVkY(SoA80Ln*9&w%J_YXG^E#onIrl^Y*>FA?KzWX6=<*S6DTvEcf2UNvxY))avrL zU5~Sj_4^TN>DnxOt~erisilS7{*&)a)brBkYq=bFz*FluH9+yj;f47(4O18n6fao0 zHgel`wKv7fF3Oau*zQ&?>AyQ^$JP$#WgnxMm#vy=d3|!lrEPQac0@Fa7L)`epL{Z- z|8$<u`c1m&+m71VUJVxhc4xb(yta^d&l@Yb4Yf0kA10=9HNRR|B6D!&bj!5pb4;Nc zJ&cU<-abx+d=8Hie`_Cc-ENhucWGv+Y2tI?$eBw7KAy1s<}H*yX<3ni>zS;!84{hn zuICJAT?!Oc7BMNA|LnxGb4QYsClqf`+xm)Og6z3<YZ!m8ahrAglu7J1^UtRwv<em; z-Pdw$k(uEyvp9P;OZLr1$5|G&bu~tvEWOiUw>xN=@cGAGe3c@<)xKP9n7hAk!JRz} z4$t0hT;u+za*2c%qk=_<obBtC>2J?(%FT8#_x9moZg^l}?(O6M&sehlz`s?Ig$B27 zv{aYG#i)I&ekSFVXd|`VA+m=#;l;-jo4<Ky{k18TIN!d|#a7Sk^fvJ%m4#2Zeiwc5 zzOX>co4@n!rng6*cs^Tecw*<GDS`&mr^$BNGhbQocG27gUUtP^Z)BVU@1KotJ#+j* zdDfbFvT8vuB%2q_IW6kEAn^Nw^Dl!XB^-`yJp66P+yKLQdYN^3!S^D1qi?&q?`)GU zb@jiwy(QOC=3J_=XisC<M>X>)*>RF53?F2~Iehkg+;}Pa`h2GiF~?88)9YH1`~O|e ztiYRkpPzR4Ji1<~D^>qs`_UU6r&v2%YGr=$uk@U^jlre<PxaA0zi(oKH_GMeIr5jb zBpqLK|1{%IQwAPEsl!E2Pd{8S$1;k;Z+*Az#QS#t^roKao8c(GxZ{Sl>VwZUt_x2- zh<Vm{XIq-@&6`c`Z^}vz>OJp_dAMI>o%PIpN2e#W?}|R3yWKnWl;OEnovBU&6JKmS zYANve`|ZO;Pk0>sZ(QZOzV^z}S+6zBj^#6+X;yq}_-n!4?yK({g}v99F+2%Vm;bVK z;uEW>(<g7vHQE{-nEuATN4fD#*O3*$wsmimU%mYQL^XeFx)rm-hP!`LjZX!wQLPnj zXZShUoXg$x=9RC?TOWrwD;m!EWv1S+%wpLBB@+jR1(~{LrL`*`8zlQ|&at>AziXAr zIobWW{GsRS<Xwd}upcSpUpAw<?c$C{(ks;&8r&9a*vYVU0`FEu^}B&R&%&o1{&o3g zIYWbT8vCX%v9mK@=hgghEZjA9CU5%X)0^9#xAxx8zpv?jj^RZ2x>u@K;#cT49;z0& zeR=vbcBehg?=~0jtBPKIdS$d*`${dp`xADk<qND7pYYqL;hK|Kn1R{7w>RS5m>G)l zTkB%ddXBAq+pn}*$SLm3%CcSc+rBMMdUdE~b5i=V?3rg<gW{)#^E5YF$%KTSOWM^m z*XVzX;<lydgj)YKhM%6u%yT8$?xH^b-<r2;7R^pvwrD+n{n8qzhd(y%SKW4cg0aMv zH+Iu%rt#W8sET;q^2M!Er8xA{){D;ag1bZIOt)sZPkbtC5xw<k#-#qnqYl6JoMB&F z{-N4$<DnB4w=x5#o|^l3N9(I6Y2i8D^YZ4Yo8-N*o^fxgB0ED-wf}*GVi%;FzGt>i zy&tuaMezK+DMl{84+%!`uiSpt;lS7RH_kixb^i`LGnJj?NWr&HU+j5`?mhRN5W>e0 zF!?#pCWG{Ie(#f`)V;-}I~$K&N;#_hC3~j&W|_<oh4b}R%P)0aS=Mk-W=FiW@T`&* zQ%~KU`p0$W@00ass-GLZ_A&kt8B}sVYWMd-tFXLz7PF$K)g3B1^ts42!C>dJWKPzn zMR$yw&p%23Fhi5!*SjZ6H=3*RWX=3|`=5<ndzVIv;+Nf;McngJCa3$>W%1p4Z*g$O z4ud-hPBs&E+_IUex!_^0%rXfh&cA=ZoUJ$~^L~lK)++gh{-=$yS@^o=FU>PN&&a{H zVb-%5izl?^?>sa6<opM&pEa7KVvJwO6~2kD`?BJ?{gl0Wdt%I%tmgflR5z_@Rja{F z-;1+9$^>~7GAY={e5gM6A!eOy$g8TJ7nK2jG(KuaDr|q3bceaU<^;>a^=I$&gimmr z6wL7Rq1%Dd#>Y;xl>65f&)=c-cZp88$REaOE5q~)&3?OmT3#WXsbcBNVt;4F_xP7_ zt4dFcPwmv5$-Q{}$>SGI&*kUu<`)-Dd*|WsY+LF)zx`)-Z(xn{DV2X==|4NZW`@gA zp;^8+xr6J&ts2iiOu2eW?M2e$e@p)9v2EmaEV1A(pW|EXCAUR$*$%VsQ{S+61+=z@ zJ$T{uq}6QF)$6JM=EU~LzHk(_s_BkRxBAxXylack_3&foJ+&V%-kNm%hosfbq@ybz ztdI~>T+7HSV#23(%C7Y9*DpIQyDQo1?Ekg3zH&_!ka>2uBT!jNgJHT-^OT4CQ}o1~ z#S9mf#VwT8xcu!<x?f9WN6-}yUJ;e{KNfx6?M~sFU1L@~yDF1gXU6!@u&ztMe#(x% z)hy?0Vk0KX^R7s5_sri=a!2o9=(pq7E+;e|SXjYz`O0aPtJ&Y&&IabcTXrIU?dCY) z4IRt2cFG^~biHkD_Co2L_Se;yU%yFty7%|P?-45QXQv%tY^iA75q3XGJxS7n>HEV6 zSqGjzsGKn0GiLs~^->#V%-HI!YkoO3W6hS2(_Z@rC-wf@d*$`F%?sny-#uJ<)Rk@9 zdYd-$BjsO9zp2Nt{P`j4*Ib<QKu~D?lKr!9<t)!q&p8=!I=#SFOj+Y|mP&WC`-Z^( zk)K{>`R@Dl^rz6eC&~{ux6U(c`MSra{&3yZzOqNtFS-6GDJ+Z<{m@kYare#ls@HC< zy~SDU68(7j7U=?!QnBUvUJtnC9`ODN`c^)(apPi%-b?cS*FQLwIQ;#xROZ)4x$_;z zD>DB0x30JD);p|tg)1nlf^F}fY5%9xXqlf$j<{?6(Er$H>)7tCmp9rkD`c>%c=$-< zQHRnQWeG9;W%I7Kt3T@8$0t9xCD=gxEyscLauyR@m;_r4niBs+?&<m9Vl(T`<p+Ok zbQfCQabx`PK#`a8h~QFzHp3P6QuW=+$@-=Jwi70B<XOblxhn_@IY^zf{ajOa=|S7% zR}UTw3K%7uN1Hvhc+hlNR>9wj#p#rvRQmd4b#<u=Eov1HnzZeE1zsMq?mKu(@0P;x zRyC7_jB-03oUylCprG2U!S>eg%Q~&&&1xnK<??oLEpEzj^pZ;C>HVtz;(}a7%n1=6 z_vESVVy=cAihb9v%(`{4_m@^|mV~p!CTqv2g-?Sow(im@ax>^q{C&z~;SJ6g4(5Nh z`FkX@S4GORf69E(bo?8q=a;18H+p3(FZBBD$eAzT%wP8L-cdijGh1henC;p0;^2XZ z2@}MBD;uO)YSy$I+;~U#>cfUYn?94iw^y%c`%08?ISJKm>Rlqf`)w?zX|lb=F-`SG zx!u7@D`hVqpWEB9;CR)wzbuK%8J^v$da+1!lI~S&hpa89)NZ<LT3f~L@pi>m#~p`% zc)Zo{=O`;m?mOBeEz5ai0>eRW{-#rA3zMrwWj`iwbA9?uz+HyZ;z29>*HhZ35_bQZ z$;jZqJ0meu>~V)Or}~}`3mk8%1>IN{w1o43pVYU_2Kt6yBy`OMr7o^=*%bWOJmy4d zW}MrG=F{s}N$Pezmi+t5-ohpB%%&B0Vr^1hl`UW3*%;@({!aHSjyJj)8x3S@r`}Z+ zT&7`tU!&}lw0dd8j&4Do4QGTi!^`$5O9Z9V?OHhRtHBxPOMzbPm+GY_tyNwlX>EC7 zZBAO|m(?{QSuUF|alBbkqIELY@Tq3s+%<BpSG4bXb+WtK`GlV0TzyMP@Ya-lwQDY| zTq9d8+$6?plzNkQ^}+Wh%nLQe9yivl_M0T7dmwzrlq(BOX7t!~`w3+PHucYnJtZZ+ zU-&`bzuwC-I_|kL${GzB8H*Cl+~Y!uE?t|)+1?@Q5R>6>BSp_-sm$rhGd#C=!+!j< zJ2lOkd#hdIVNS-YM~|%9wnSnM*WDteh;2=WQa`fitk&1<IIwU>F#px5rB!*{mZ45O zJX{MS6AS)MG2Zs)*2d>LZU0tOElga>{7h;7!Lyqu1z)|LzRcj2=)KPNqP7$Joi*E6 zAAcJe;E{RZ&ywk0D@1pvH6C^gnL9JdYxdhkcV4tkV&#**EBsm{_?NoerO#<ypOyuh zuG;YNk<8Jl8<q55x*CUSmjz1mH55+?iff%*)EabU*_pIcEt{VNRK@6>vafE|d2oyO z#?pnFd+Wk4GF|D44Ug-q71zuzT*D@-pb+gnTZ;A3mI=yS*Mk<zur0mXY;}oi^ULf) zg_EEB8E^D!2}Ryo=&5#m*OVGV6V87^pZ*`7zK#Fj@sGdk>#m&_J^Ek0jDdlH!PC{x JWt~$(69D)+N{avh literal 0 HcmV?d00001 diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..bc56048 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,32 @@ +.. vim: set fileencoding=utf-8 : +.. Andre Anjos <andre.anjos@idiap.ch> +.. Mon 13 Aug 2012 12:36:40 CEST + +.. _bob.paper.mccnn.tifs2018: + +============================================ +Face PAD using Multi-Channel CNNs +============================================ + +This package is part of the Bob_ toolkit and it allows to reproduce the experimental results published in the following paper:: + + @inproceedings{GeorgeTIFS2019, + author = {Anjith George, Zohreh Mostaani, David Geissenbuhler, Olegs Nikisins, Andre Anjos, Sebastien Marcel}, + title = {Biometric Face Presentation Attack Detection with Multi-Channel Convolutional Neural Network}, + year = {2019}, + booktitle = {TIFS 2019}, + } + +If you use this package and/or its results, please cite the paper. + +User guide +--------------------- + +.. toctree:: + :maxdepth: 2 + + references + + +.. include:: links.rst + diff --git a/doc/links.rst b/doc/links.rst new file mode 100644 index 0000000..9043c68 --- /dev/null +++ b/doc/links.rst @@ -0,0 +1,18 @@ + + +.. This file contains all links we use for documentation in a centralized place + + +.. _idiap: http://www.idiap.ch +.. _bob: http://www.idiap.ch/software/bob +.. _buildout: http://www.buildout.org +.. _pypi: http://pypi.python.org +.. _installation: https://www.idiap.ch/software/bob/install +.. _bob.pad.base: https://pypi.python.org/pypi/bob.pad.base +.. _replayattack: https://www.idiap.ch/dataset/replayattack +.. _replay-mobile: https://www.idiap.ch/dataset/replay-mobile +.. _dependencies: https://gitlab.idiap.ch/bob/bob/wikis/Dependencies +.. _MSU MFSD: http://biometrics.cse.msu.edu/Publications/Databases/MSUMobileFaceSpoofing/index.htm +.. _MIFS: http://www.antitza.com/makeup-datasets.html +.. _CELEBA: http://mmlab.ie.cuhk.edu.hk/projects/CelebA.html + diff --git a/doc/references.rst b/doc/references.rst new file mode 100644 index 0000000..0b5ae55 --- /dev/null +++ b/doc/references.rst @@ -0,0 +1,8 @@ +.. vim: set fileencoding=utf-8 : + +=========== +References +=========== + +.. [GMGNAM19] *A. George, Z. Mostaani, D. Geissenbuhler, O. Nikisins, A. Anjos, S. Marcel*, **Biometric Face Presentation Attack Detection with Multi-Channel Convolutional Neural Network**, + in: Submitted to: IEEE Transactions on Information Forensics & Security. \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..81f7a46 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,7 @@ +setuptools +six +numpy +bob.bio.base +bob.bio.video +bob.pad.face +bob.learn.pytorch diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..027573b --- /dev/null +++ b/setup.py @@ -0,0 +1,116 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : +# Andre Anjos <andre.anjos@idiap.ch> +# Mon 16 Apr 08:18:08 2012 CEST +# +# Copyright (C) Idiap Research Institute, Martigny, Switzerland +# +# 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, version 3 of the License. +# +# 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/>. + +# 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 administrative 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, dist +dist.Distribution(dict(setup_requires = ['bob.extension'])) + +# load the requirements.txt for additional requirements +from bob.extension.utils import load_requirements, find_packages +install_requires = load_requirements() + +# 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.paper.mccnn.tifs2018', + version = open("version.txt").read().rstrip(), + description = 'Package allowing to reproduce experiments from the paper "Biometric Face Presentation Attack Detection with Multi-Channel Convolutional Neural Network"', + + url = 'https://gitlab.idiap.ch/bob/bob.paper.mccnn.tifs2018', + license = 'GPLv3', + author = 'Anjith George', + author_email = 'anjith.george@idiap.ch', + keywords = 'bob', + + # If you have a better, long description of your package, place it on the + # 'doc' directory and then hook it here + long_description = open('README.rst').read(), + + # This line is required for any distutils based packaging. + # It will find all package-data inside the 'bob' directory. + packages = find_packages('bob'), + include_package_data = True, + + # 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 administrative + # privileges when using buildout. + install_requires = install_requires, + + # 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 = { + + # scripts should be declared using this entry: + 'console_scripts' : [ + 'bob_example_project_version.py = bob.paper.mccnn.tifs2018.script.version:main', + ], + + # registered preprocessors: + 'bob.pad.preprocessor': [ + 'mc-face-preprocessor = bob.paper.mccnn.tifs2018.config.preprocessor.mc_preprocessor:mc_preprocessor', # returns Multi channel aligned face images + ], + + + }, + + # Classifiers are important if you plan to distribute this package through + # PyPI. You can find the complete list of classifiers that are valid and + # useful here (http://pypi.python.org/pypi?%3Aaction=list_classifiers). + classifiers = [ + 'Framework :: Bob', + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', + 'Natural Language :: English', + 'Programming Language :: Python', + 'Topic :: Scientific/Engineering :: Artificial Intelligence', + ], +) diff --git a/version.txt b/version.txt new file mode 100644 index 0000000..8ea4f48 --- /dev/null +++ b/version.txt @@ -0,0 +1 @@ +0.0.1a0 -- GitLab