├── .github └── workflows │ └── python-package.yml ├── LICENSE ├── README.md ├── assets ├── demo_webcam.gif └── show_album.png ├── ezfaces ├── __init__.py └── face_classifier.py ├── requirements.txt ├── setup.cfg ├── setup.py └── tests ├── images_yale ├── README.md ├── subject03_centerlight.png ├── subject03_glasses.png ├── subject03_happy.png ├── subject03_leftlight.png ├── subject03_noglasses.png ├── subject03_normal.png ├── subject03_sad.png ├── subject03_sleepy.png ├── subject03_surprised.png └── subject03_wink.png └── test_face_classifier.py /.github/workflows/python-package.yml: -------------------------------------------------------------------------------- 1 | # This workflow will install Python dependencies, run tests and lint with a variety of Python versions 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions 3 | 4 | name: Python package 5 | 6 | on: 7 | push: 8 | branches: [ master ] 9 | pull_request: 10 | branches: [ master ] 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | strategy: 17 | matrix: 18 | python-version: [3.7, 3.8] 19 | 20 | steps: 21 | - uses: actions/checkout@v2 22 | - name: Set up Python ${{ matrix.python-version }} 23 | uses: actions/setup-python@v2 24 | with: 25 | python-version: ${{ matrix.python-version }} 26 | - name: Install dependencies 27 | run: | 28 | python -m pip install --upgrade pip 29 | if [ -f requirements.txt ]; then pip install -r requirements.txt; fi 30 | - name: Run and evaluate all unit tests 31 | run: | 32 | python -m unittest discover tests 33 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

EZfaces

2 |

Easily create your own face recognition system in Python using Eigenfaces

3 |

4 | 5 | # Description 6 | ![Python package](https://github.com/0xLeo/EZfaces/workflows/Python%20package/badge.svg) 7 | [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) 8 | 9 | A tool for face recognition in Python. it implements [Turk and Pentland's paper](https://sites.cs.ucsb.edu/~mturk/Papers/mturk-CVPR91.pdf). The notation follows my pdf notes [here](https://github.com/0xLeo/journal/tree/master/computer-vision/pca_eigenfaces/pdf). Finally, it is based on the [Olivetti faces dataset](https://scikit-learn.org/stable/modules/generated/sklearn.datasets.fetch_olivetti_faces.html). Some of its features are: 10 | * Load Olivetti faces to initialise dataset. 11 | * Load new subjects from file. 12 | * Read new subjects directly from webcam. 13 | * Predict a novel face from file. 14 | * Predict novel face from webcam. 15 | * Export currently loaded dataset and load it later. 16 | * Built-in benchmarking (classification report) method. 17 | 18 | **Note**: When you add a new subject, it is recommended to take several (5 or more) pictures of its face profile from slighly different small angles. 19 | 20 | 21 | # Installation 22 | You can install the package as follows: 23 | ``` 24 | cd 25 | pip install . 26 | ``` 27 | Next, you can import the package as `import ezfaces` or its main class as `from ezfaces.face_classifier import FaceClassifier`. 28 | 29 | 30 | The project has been tested in CI (see [workflows](https://github.com/0xLeo/EZfaces/tree/master/.github/workflows)) in Python 3.7 and 3.8 with the following dependencies installed, but newer versions will also work: 31 | ``` 32 | opencv-python 4.1.2.30 33 | numpy 1.17.4 34 | matplotlib 3.1.2 35 | scipy 1.4.1 36 | scikit-image 0.16.2 37 | scikit-learn 0.22 38 | ``` 39 | 40 | 41 | # Usage examples 42 | **1. Load new subject from folder** 43 | ``` 44 | from ezfaces.face_classifier import FaceClassifier 45 | 46 | fc = FaceClassifier() 47 | lbl_new = fc.add_img_data('tests/images_yale') 48 | print(fc) 49 | print("New subject\'s label is %d" % lbl_new) 50 | ``` 51 | Output: 52 | ``` 53 | Loaded 410 samples in total. 54 | 348 for training and 61 for testing. 55 | New subject's label is 40 56 | ``` 57 | 58 | **2. Load new subject and predict from webcam** 59 | ``` 60 | from ezfaces.face_classifier import FaceClassifier 61 | import cv2 62 | 63 | 64 | fc = FaceClassifier() 65 | lbl_new = fc.add_img_data(from_webcam=True) 66 | fc.train() 67 | # take a snapshot from webcam 68 | x_novel = fc.webcam2vec() 69 | x_pred, lbl_pred = fc.classify(x_novel) 70 | print("The ID of the newly added subject is %d. The prediction from " 71 | "the webcam is %d" %(lbl_new, lbl_pred)) 72 | cv2.imshow("Prediction", fc.vec2img(x_pred)) 73 | cv2.waitKey(3000) 74 | cv2.destroyAllWindows() 75 | ``` 76 | 77 | ![demo](https://raw.githubusercontent.com/0xLeo/EZfaces/master/assets/demo_webcam.gif) 78 | 79 | **3. Export and import dataset** 80 | ``` 81 | from ezfaces.face_classifier import FaceClassifier 82 | 83 | 84 | fc = FaceClassifier() 85 | data_file, lbl_file = fc.export('/tmp') 86 | 87 | # add some data 88 | lbl_new = fc.add_img_data('tests/images_yale') 89 | print(fc) 90 | 91 | # now let's say we made a mistake and don't like the new data 92 | fc = FaceClassifier(data_pkl = data_file, target_pkl = lbl_file) 93 | print(fc) 94 | ``` 95 | Output: 96 | ``` 97 | Wrote data and target as .pkl at: 98 | /tmp 99 | Loaded 410 samples in total. 100 | 348 for training and 61 for testing. 101 | Loaded 400 samples in total. 102 | 340 for training and 60 for testing. 103 | ``` 104 | 105 | 106 | **4. Show all loaded subjects** 107 | ``` 108 | from ezfaces.face_classifier import FaceClassifier 109 | 110 | 111 | fc = FaceClassifier() 112 | # add some adata 113 | lbl_new = fc.add_img_data('tests/images_yale') 114 | fc.show_album() 115 | ``` 116 | It will show the subjects in 8\*8 image grids as follows: 117 | ![album](https://raw.githubusercontent.com/0xLeo/EZfaces/master/assets/show_album.png) 118 | -------------------------------------------------------------------------------- /assets/demo_webcam.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leonmavr/EZfaces/8ef1c7d53430595c31d9b5851d44cb73ba4ee492/assets/demo_webcam.gif -------------------------------------------------------------------------------- /assets/show_album.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leonmavr/EZfaces/8ef1c7d53430595c31d9b5851d44cb73ba4ee492/assets/show_album.png -------------------------------------------------------------------------------- /ezfaces/__init__.py: -------------------------------------------------------------------------------- 1 | # __init__.py 2 | from .face_classifier import FaceClassifier 3 | -------------------------------------------------------------------------------- /ezfaces/face_classifier.py: -------------------------------------------------------------------------------- 1 | from sklearn.datasets import fetch_olivetti_faces 2 | import numpy as np 3 | import cv2 4 | from collections import OrderedDict as OD 5 | from sklearn.metrics import classification_report 6 | from matplotlib import pyplot as plt 7 | import pickle as pkl 8 | import os 9 | import time 10 | import glob 11 | import itertools as it 12 | from typing import List, Tuple, Union 13 | 14 | 15 | class FaceClassifier(): 16 | def __init__(self, ratio = 0.85, K = 200, data_pkl = None, target_pkl = None): 17 | """__init__. Class constructor. 18 | 19 | Parameters 20 | ---------- 21 | ratio : 22 | How much of the total data to use for training (0 to 1) 23 | K : 24 | How many eigenface space base vectors to keep in order to express each image 25 | data_pkl : 26 | Pickle serialised file that contains data (see export method) 27 | target_pkl : 28 | Pickle serialised file that contains label (see export method) 29 | """ 30 | if data_pkl is not None: 31 | with open(data_pkl, 'rb') as f: 32 | self.data = pkl.load(f) 33 | else: 34 | self.data = None # data vectors 35 | if target_pkl is not None: 36 | with open(target_pkl, 'rb') as f: 37 | self.labels = pkl.load(f) 38 | else: 39 | self.labels = None # label (ground truth) vectors 40 | self.train_data = OD() # maps sample index to data and label 41 | self.test_data = OD() # maps sample index to data and label 42 | # how many eigenfaces to keep 43 | self.K = K 44 | # how much training data to use as part of total data 45 | if not 0 < ratio <= 1: 46 | raise ValueError('Provide a training/total data ratio from 0 to 1 inclusive.') 47 | self.ratio = ratio 48 | # MxK matrix - each row stores the coords of each image in the eigenface space 49 | self.W = None 50 | self.classification_report = None # obtained from benchmarking 51 | # mean needed for reconstruction 52 | self._mean = np.zeros((1, 64*64), dtype=np.float32) 53 | if self.data is None and self.labels is None: # no pre-loaded data 54 | self._load_olivetti_data() 55 | self._TRAIN_SAMPLE = 1 56 | self._PRED_SAMPLE = 0 57 | 58 | 59 | def __str__(self): 60 | M = len(self.data) 61 | return "Loaded %d samples in total.\n"\ 62 | "%d for training and %d for testing."\ 63 | % (M, self.ratio*M, (1-self.ratio)*M) 64 | 65 | 66 | def _load_olivetti_data(self): 67 | """Load the Olivetti face data and save them in the class.""" 68 | data, target = fetch_olivetti_faces(return_X_y = True) 69 | # data as floating vectors of length 64^2, ranging from 0 to 1 70 | self.data = np.array(data) 71 | # subject labels (sequential from to 0 to ...) 72 | self.labels = target 73 | 74 | 75 | def _record_mean(self): 76 | self._mean += np.mean(self.data, axis=0) # along columns 77 | 78 | 79 | def _subtract_mean(self): 80 | """ 81 | Make the mean of every column of self.data zero 82 | """ 83 | self._record_mean() 84 | M = self.data.shape[0] 85 | C = np.eye(M) - 1/M*np.ones((M,1)) # centring matrix 86 | self.data = np.matmul(C, self.data) 87 | 88 | 89 | def _read_from_webcam(self, new_label, stream: Union[str, int] = 0): 90 | """Takes face snapshots from webcam. Pass the new label of the subject 91 | being photographed.""" 92 | print("Position your face in the green box.\n" 93 | "Press p to capture your face profile from slightly different angles,\n" 94 | "or q to quit.") 95 | time.sleep(3) 96 | # if stream == 0, try to open default webcam, else video from path 97 | cap = cv2.VideoCapture(stream) 98 | while True: 99 | # Capture frame by frame 100 | _, frame = cap.read() 101 | grey = cv2.cvtColor(frame, cv2.COLOR_BGR2GRAY) 102 | min_shape = min(grey.shape) 103 | cv2.rectangle( frame, (0,0), (int(3*min_shape/4), 104 | int(3*min_shape/4)), (0,255,0), thickness = 4) 105 | cv2.namedWindow('frame', flags=cv2.WINDOW_GUI_NORMAL) 106 | cv2.imshow('frame',frame) 107 | k = cv2.waitKey(10) & 0xff 108 | if k == ord('q'): 109 | break 110 | elif k == ord('p'): 111 | im_cropped = grey[:int(3*min_shape/4), :int(3*min_shape/4)] 112 | cv2.destroyAllWindows() 113 | cv2.namedWindow('new data', flags=cv2.WINDOW_GUI_NORMAL) 114 | cv2.imshow("new data", im_cropped) 115 | cv2.waitKey(1500) 116 | cv2.destroyAllWindows() 117 | x = self.img2vec(im_cropped) 118 | self.data = np.array([*self.data, np.array(x, dtype=np.float32)]) 119 | self.labels = np.append(self.labels, new_label) 120 | cap.release() 121 | cv2.destroyAllWindows() 122 | 123 | 124 | def add_img_data(self, dir_img: str = "", from_webcam: bool = False) -> int: 125 | """add_img_data. Adds data and their labels to existing database. 126 | 127 | Parameters 128 | ---------- 129 | dir_img : str 130 | directory where image(s) of a subject are saved 131 | from_webcam : bool 132 | if True, opens webcam and lets the user capture face data 133 | 134 | Returns 135 | ------- 136 | int 137 | The label of the newly added subject. 138 | """ 139 | assert len(self.labels) != 0, "No labels have been generated!" 140 | # find all images in given folder 141 | fpaths = glob.glob(os.path.join(dir_img, '*.png')) 142 | fpaths += glob.glob(os.path.join(dir_img, '*.jpg')) 143 | fpaths += glob.glob(os.path.join(dir_img, '*.bmp')) 144 | # create new label for new subject 145 | target_new = self.labels[-1] + 1 146 | self.labels = np.append(self.labels, [target_new]*len(fpaths)) 147 | # convert image to 64*64 data vector (ranging from 0 to 1) 148 | for i, f in enumerate(fpaths): 149 | im = cv2.imread(f) 150 | im = cv2.cvtColor(im, cv2.COLOR_BGR2GRAY) 151 | im = np.asarray(cv2.resize(im, dsize = (64,64))).ravel() 152 | # normalise from 0 to 1 - the range of original Olivetti data 153 | im = im/255 154 | self.data = np.array([*self.data, np.array(im, dtype=np.float32)]) 155 | if from_webcam: 156 | self._read_from_webcam(new_label = target_new) 157 | self.data = np.array(self.data) 158 | return target_new 159 | 160 | 161 | def train(self): 162 | """ Find the coordinates of each training image in the eigenface space """ 163 | self._divide_dataset() 164 | # the matrix X to use for training 165 | X = np.array([v[0] for v in self.train_data.values()]) 166 | # compute eig of MxN^2 matrix first instead of the N^2xN^2, N^2 >> M 167 | XXT = np.matmul(X, X.T) 168 | eval_XXT, evec_XXT = np.linalg.eig(XXT) 169 | # sort eig data by decreasing eigvalue values 170 | idx_eval_XXT = eval_XXT.argsort()[::-1] 171 | eval_XXT = eval_XXT[idx_eval_XXT] 172 | evec_XXT = evec_XXT[idx_eval_XXT] 173 | # now compute eigs of covariance matrix (N^2xN^2) 174 | self.evec_XTX = np.matmul(X.T, evec_XXT) 175 | # coordinates of each face in "eigenface" subspace 176 | self.W = np.matmul(X, self.evec_XTX) 177 | self.W = self.W[:, :self.K] 178 | 179 | 180 | def _divide_dataset(self): 181 | """Divides dataset in training and test (prediction) data""" 182 | training_or_test = [self._random_binary(self.ratio) for _ in self.data] 183 | self._subtract_mean() 184 | 185 | train_inds = [i for i,t in enumerate(training_or_test) if t == self._TRAIN_SAMPLE] 186 | test_inds = [i for i,t in enumerate(training_or_test) if t == self._PRED_SAMPLE] 187 | # {index: (data_vector, data_label)}, index starts from 0 188 | self.train_data = OD( # ordered dict 189 | dict(zip(train_inds, # keys 190 | zip(self.data[train_inds,:], self.labels[train_inds]))) # vals 191 | ) 192 | self.test_data = OD( # ordered dict 193 | dict(zip(test_inds, # keys 194 | zip(self.data[test_inds,:], self.labels[test_inds]))) # vals 195 | ) 196 | 197 | 198 | def _random_binary(self, prob_of_1 = .5) -> int: 199 | """_random_binary. Randomly returns 0 or 1. Accepts probability 200 | to return 1 as input.""" 201 | return np.round(np.random.uniform(.5, 1.5) - 1 + prob_of_1).astype(np.uint8) 202 | 203 | 204 | def get_test_sample(self) -> tuple: 205 | """ Get random training sample and its label. Returns (data vector, label) """ 206 | Ntest = len(self.test_data) 207 | n = np.random.randint(0, Ntest) 208 | test_ind = [k for k in self.test_data.keys()][n] 209 | return self.test_data[test_ind] # data, label 210 | 211 | 212 | def classify(self, x_new: np.ndarray) -> tuple: 213 | """classify. Classify an input data vector. 214 | 215 | Parameters 216 | ---------- 217 | x_new : np.array 218 | Data vector 219 | 220 | Returns 221 | ------- 222 | tuple 223 | containing the predicted data vector and its label (data, label) 224 | """ 225 | train_inds = sorted([i for i in self.train_data.keys()]) 226 | M = len(train_inds) 227 | # find eigenface space coordinates 228 | w_new = np.matmul(self.evec_XTX.T, x_new.T) 229 | w_new = w_new[:self.K] 230 | # if not match w/ itself else inf 231 | dists = [np.linalg.norm(w_new - self.W[i,:]) 232 | if (np.linalg.norm(w_new - self.W[i,:]) > 0.0) else 233 | np.infty 234 | for i in range(M)] 235 | return (self.train_data[train_inds[np.argmin(dists)]][0], # data 236 | self.train_data[train_inds[np.argmin(dists)]][1]) # label 237 | 238 | 239 | def vec2img(self, x: list) -> np.ndarray: 240 | """vec2img. Converts an 1D data vector stored in the class to image. 241 | 242 | Parameters 243 | ---------- 244 | x : list 245 | 0 mean float vector of length 64^2 246 | 247 | Returns 248 | ------- 249 | np.ndarray 250 | the input vector 2D uint8 64x64 image 251 | """ 252 | x = np.array(x) + self._mean 253 | x = np.reshape(255*x, (64,64)) 254 | return np.asarray(x, np.uint8) 255 | 256 | 257 | def img2vec(self, im) -> np.ndarray: 258 | """Converts an input greyscale image to an 1D data vector.""" 259 | if not len(im.shape) == 2: 260 | raise RuntimeError("Provide a greyscale image as input.") 261 | x = np.asarray(cv2.resize(im, dsize=(64,64)), np.float32).ravel() 262 | x /= 255 263 | x = np.reshape(x, self._mean.shape) 264 | x -= self._mean 265 | # needed for eigenface coords dot product, do NOT delete this 266 | x = np.reshape(x, self.data[-1,:].shape) 267 | return x 268 | 269 | 270 | def webcam2vec(self): 271 | """ Opens webcam. The user can take a picture. Returns picture 272 | as data vector""" 273 | cap = cv2.VideoCapture(0) 274 | print("Position your face in the green box.\n" 275 | "Press p to capture a face picture.") 276 | while True: 277 | # Capture frame by frame 278 | _, frame = cap.read() 279 | grey = cv2.cvtColor(frame, cv2.COLOR_BGR2GRAY) 280 | min_shape = min(grey.shape) 281 | cv2.rectangle( frame, (0,0), (int(3*min_shape/4), 282 | int(3*min_shape/4)), (0,255,0), thickness = 4) 283 | cv2.imshow('frame', frame) 284 | k = cv2.waitKey(10) & 0xff 285 | if k == ord('q'): 286 | break 287 | elif k == ord('p'): 288 | im_cropped = grey[:int(3*min_shape/4), :int(3*min_shape/4)] 289 | cv2.destroyAllWindows() 290 | cv2.namedWindow("new data", flags=cv2.WINDOW_GUI_NORMAL) 291 | cv2.imshow("new data", im_cropped) 292 | cv2.waitKey(1500) 293 | cv2.destroyWindow("new data") 294 | x = self.img2vec(im_cropped) 295 | break 296 | cap.release() 297 | cv2.destroyAllWindows() 298 | return x 299 | 300 | 301 | def benchmark(self, imshow = False, wait_time = 0.5, which_labels = []): 302 | """benchmark. Iterates over each test sample and classifies it. 303 | Genrates a classification report with all the classification metrics. 304 | 305 | Parameters 306 | ---------- 307 | imshow : bool 308 | If True, show the actual vs predicted image, each for some times. 309 | wait_time : float 310 | How many seconds to show each actual vs predicted image for. 311 | which_labels : list 312 | Which labels to show. Useful when a new label was just added. 313 | """ 314 | self.train() 315 | lbl_actual = [] 316 | lbl_test = [] 317 | for ind_test, test_data_lbl in self.test_data.items(): 318 | # if we want to show only certain labels 319 | if len(which_labels) != 0: 320 | if test_data_lbl[1] not in which_labels: 321 | continue 322 | x_actual = test_data_lbl[0] 323 | lbl_actual.append(test_data_lbl[1]) 324 | x_test, lbl = self.classify(x_actual) 325 | lbl_test.append(lbl) 326 | if imshow: 327 | fig = plt.figure(figsize=(64, 64)) 328 | cols, rows = 2, 1 329 | ax1 = fig.add_subplot(rows, cols, 1) 330 | ax1.title.set_text('actual: %d' % test_data_lbl[1]) 331 | plt.imshow(self.vec2img(x_actual)) 332 | ax2 = fig.add_subplot(rows, cols, 2) 333 | ax2.title.set_text('predicted: %d' % lbl) 334 | plt.imshow(self.vec2img(x_test)) 335 | plt.show(block=False) 336 | plt.pause(wait_time) 337 | plt.close() 338 | if len(lbl_actual) != 0 and len(lbl_test) != 0: 339 | self.classification_report = classification_report(y_true = lbl_actual, 340 | y_pred = lbl_test) 341 | 342 | 343 | def export(self, dest_folder: str = '/tmp') -> Tuple[str, str]: 344 | """export. Exports the data and labels as serialised files. 345 | 346 | Parameters 347 | ---------- 348 | dest_folder : str 349 | dest_folder 350 | 351 | Returns 352 | ------- 353 | Tuple[str, str] 354 | Tuple containing the path to exported data and label file respectively. 355 | Empty string tuple if failure. 356 | """ 357 | try: 358 | fpath_data = os.path.join(dest_folder, 'data.pkl') 359 | fpath_lbl = os.path.join(dest_folder, 'labels.pkl') 360 | with open(fpath_data, 'wb') as f: 361 | pkl.dump(self.data, f) 362 | with open(fpath_lbl, 'wb') as f: 363 | pkl.dump(self.labels, f) 364 | print("Wrote data and target as .pkl at:\n%s" 365 | % os.path.abspath(dest_folder)) 366 | return os.path.abspath(fpath_data), os.path.abspath(fpath_lbl) 367 | except Exception as e: 368 | return "", "" 369 | 370 | 371 | def grouper(self, inputs, n, fillvalue=None) -> list: 372 | """Credits https://realpython.com/python-itertools/ 373 | >>> fc = faceClassifier() 374 | >>> nums = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] 375 | >>> print(list(fc.grouper(nums, 4))) 376 | [(1, 2, 3, 4), (5, 6, 7, 8), (9, 10, None, None)] 377 | """ 378 | iters = [iter(inputs)] * n 379 | return list(it.zip_longest(*iters, fillvalue=fillvalue)) 380 | 381 | 382 | def show_album(self, wait_time = 2.0): 383 | """show_album. Shows all gathered subjects in a several 384 | pages of 8x8 grids (photo "album"). 385 | 386 | Parameters 387 | ---------- 388 | wait_time : 389 | how long to wait between successive grid pages in sec 390 | """ 391 | data_every_64 = self.grouper(self.data, 64) 392 | lbl_every_64 = self.grouper(self.labels, 64) 393 | cols, rows = 8, 8 394 | blank = np.zeros((64, 64), np.uint8) 395 | 396 | for data, lbls in zip(data_every_64, lbl_every_64): 397 | fig = plt.figure(figsize=(64, 64)) 398 | for i in range(1, cols*rows +1): 399 | ax = fig.add_subplot(rows, cols, i) 400 | try: 401 | plt.imshow(self.vec2img(data[i-1])) 402 | ax.title.set_text("%d" % lbls[i-1]) 403 | except: 404 | plt.imshow(blank) 405 | ax.title.set_text("blank") 406 | plt.subplots_adjust(wspace = .6) 407 | plt.show(block = False) 408 | plt.pause(wait_time) 409 | plt.close() 410 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | opencv-python==4.2.0.32 2 | numpy==1.17.4 3 | matplotlib==3.1.2 4 | scipy==1.4.1 5 | scikit-image==0.16.2 6 | scikit-learn==0.22 7 | sklearn==0.0 8 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | # setup.cfg 2 | [metadata] 3 | description-file = README.md 4 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | try: 2 | from setuptools import setup 3 | except ImportError: 4 | from distutils.core import setup 5 | 6 | setup( 7 | name='EZfaces', 8 | version='0.1', 9 | description='Face recognition using Eigenfaces', 10 | author='0xLeo', 11 | author_email='0xleo.git@gmail.com', 12 | url='https://github.com/0xLeo/EZfaces/archive/alpha.tar.gz', 13 | packages=['ezfaces'], 14 | include_package_data=True, 15 | install_requires=['opencv-python', 16 | 'scikit-learn', 17 | 'matplotlib', 18 | 'numpy'], 19 | zip_safe=False, 20 | ) 21 | -------------------------------------------------------------------------------- /tests/images_yale/README.md: -------------------------------------------------------------------------------- 1 | # About this folder 2 | 3 | Credits to Yale dataset, where these images are obtained from http://vision.ucsd.edu/content/yale-face-database. 4 | -------------------------------------------------------------------------------- /tests/images_yale/subject03_centerlight.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leonmavr/EZfaces/8ef1c7d53430595c31d9b5851d44cb73ba4ee492/tests/images_yale/subject03_centerlight.png -------------------------------------------------------------------------------- /tests/images_yale/subject03_glasses.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leonmavr/EZfaces/8ef1c7d53430595c31d9b5851d44cb73ba4ee492/tests/images_yale/subject03_glasses.png -------------------------------------------------------------------------------- /tests/images_yale/subject03_happy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leonmavr/EZfaces/8ef1c7d53430595c31d9b5851d44cb73ba4ee492/tests/images_yale/subject03_happy.png -------------------------------------------------------------------------------- /tests/images_yale/subject03_leftlight.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leonmavr/EZfaces/8ef1c7d53430595c31d9b5851d44cb73ba4ee492/tests/images_yale/subject03_leftlight.png -------------------------------------------------------------------------------- /tests/images_yale/subject03_noglasses.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leonmavr/EZfaces/8ef1c7d53430595c31d9b5851d44cb73ba4ee492/tests/images_yale/subject03_noglasses.png -------------------------------------------------------------------------------- /tests/images_yale/subject03_normal.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leonmavr/EZfaces/8ef1c7d53430595c31d9b5851d44cb73ba4ee492/tests/images_yale/subject03_normal.png -------------------------------------------------------------------------------- /tests/images_yale/subject03_sad.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leonmavr/EZfaces/8ef1c7d53430595c31d9b5851d44cb73ba4ee492/tests/images_yale/subject03_sad.png -------------------------------------------------------------------------------- /tests/images_yale/subject03_sleepy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leonmavr/EZfaces/8ef1c7d53430595c31d9b5851d44cb73ba4ee492/tests/images_yale/subject03_sleepy.png -------------------------------------------------------------------------------- /tests/images_yale/subject03_surprised.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leonmavr/EZfaces/8ef1c7d53430595c31d9b5851d44cb73ba4ee492/tests/images_yale/subject03_surprised.png -------------------------------------------------------------------------------- /tests/images_yale/subject03_wink.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leonmavr/EZfaces/8ef1c7d53430595c31d9b5851d44cb73ba4ee492/tests/images_yale/subject03_wink.png -------------------------------------------------------------------------------- /tests/test_face_classifier.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import os 3 | import sys 4 | this_script_path = os.path.abspath(__file__) 5 | this_script_folder = os.path.dirname(this_script_path) 6 | sys.path.insert(1, os.path.join(this_script_folder, '..', 'ezfaces')) 7 | from face_classifier import FaceClassifier 8 | import numpy as np 9 | 10 | 11 | class TestUM(unittest.TestCase): 12 | 13 | def test_train_with_olivetti(self): 14 | fc = FaceClassifier() 15 | self.assertEqual(len(fc.data.shape), 2) 16 | # data stored as 64*64 row vectors 17 | self.assertEqual(fc.data.shape[1], 64*64) 18 | # Olivetti data contain 40 subjects 19 | self.assertEqual(len(np.unique(fc.labels)), 40) 20 | fc.train() 21 | # their coordinates in eigenface space as a matrix (.W) 22 | self.assertEqual(len(fc.W.shape), 2) 23 | 24 | 25 | def test_train_with_subject(self): 26 | img_dir = os.path.join(this_script_folder, 'images_yale') 27 | fc = FaceClassifier() 28 | fc.add_img_data(img_dir) 29 | # data stored as 64*64 row vectors 30 | self.assertEqual(fc.data.shape[1], 64*64) 31 | # 40 + 1 subjects 32 | self.assertEqual(len(np.unique(fc.labels)), 41) 33 | fc.train() 34 | # their coordinates in eigenface space as a matrix (.W) 35 | self.assertEqual(len(fc.W.shape), 2) 36 | 37 | 38 | def test_benchmark(self): 39 | img_dir = os.path.join(this_script_folder, 'images_yale') 40 | fc = FaceClassifier(ratio = .725) 41 | fc.add_img_data(img_dir) 42 | fc.benchmark() 43 | self.assertNotEqual(fc.classification_report, None) 44 | print(fc.classification_report) 45 | fc.benchmark(imshow=True, wait_time=0.8, which_labels=[0, 5, 13, 28, 40]) 46 | 47 | 48 | def test_export_import(self): 49 | img_dir = os.path.join(this_script_folder, 'images_yale') 50 | fc = FaceClassifier() 51 | fc.add_img_data(img_dir) 52 | # write as pickle files 53 | fc.export() 54 | 55 | fc2 = FaceClassifier(data_pkl = '/tmp/data.pkl', target_pkl = '/tmp/labels.pkl') 56 | self.assertEqual(len(np.unique(fc2.labels)), 41) 57 | 58 | 59 | def test_show_album(self): 60 | fc = FaceClassifier() 61 | fc.show_album(wait_time=.1) 62 | 63 | 64 | if __name__ == '__main__': 65 | unittest.main() 66 | --------------------------------------------------------------------------------