alignfaces 1.0.1__py3-none-any.whl

alignfaces-1.0.1.dist-info/METADATA

@@ -0,0 +1,135 @@
+Metadata-Version: 2.4
+Name: alignfaces
+Version: 1.0.1
+Summary: Automatically align and warp face images
+Author-email: Carl Michael Gaspar <carl.michael.gaspar@icloud.com>, "Oliver G.B. Garrod" <oliver.garrod@fabdata.io>
+License: Apache-2.0
+Keywords: face-alignment,face-morphing,psychophysics,psychology-experiments
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: dlib
+Requires-Dist: scikit-image
+Dynamic: license-file
+
+Automatic Face Alignment (AFA)
+================
+Carl M. Gaspar & Oliver G.B. Garrod
+
+#### You have lots of photos of faces like this:
+![](https://github.com/SourCherries/auto-face-align/raw/main/demos/demo_1_alignment/collage_originals.png)
+
+#### But you want to line up all of the faces like this:
+![](https://github.com/SourCherries/auto-face-align/raw/main/demos/demo_1_alignment/collage_aligned.png)
+
+#### Perhaps you would also like to window the faces to show only inner facial features like this:
+![](https://github.com/SourCherries/auto-face-align/raw/main/demos/demo_1_alignment/collage_aligned_windowed.png)
+
+#### All of the above can be done using AFA like this:
+```python
+import alignfaces as afa
+
+faces_path = "/Users/Me/faces_for_my_study/"
+pfx = ""     # relevant input files may start with a string
+sfx = "jpg"  # input image format
+
+afa.get_landmarks(
+    faces_path,
+    file_prefix=pfx,
+    file_postfix=sfx,
+)
+
+aligned_path = afa.align_procrustes(
+    faces_path,
+    file_prefix=pfx,
+    file_postfix=sfx,
+)
+
+afa.get_landmarks(
+    aligned_path,
+    file_prefix=pfx,
+    file_postfix=sfx,
+)
+
+the_aperture, aperture_path = afa.place_aperture(
+    aligned_path,
+    file_prefix=pfx,
+    file_postfix=sfx,
+)
+```
+To better understand how to write a script for your specific purposes, we direct you to [demo 1](https://github.com/SourCherries/auto-face-align/tree/main/demos/demo_1_alignment/README.md). [Demo 1](https://github.com/SourCherries/auto-face-align/tree/main/demos/demo_1_alignment/README.md) also describes how AFA alignment works.
+
+All of these functions depend on reliable detection of facial landmarks, which is provided by the [DLIB](http://dlib.net) library. Alignment is based on generalized Procrustes analysis (GPA), which extensively unit tested.
+
+# Additional functions (warping)
+Automatic landmark detection means that it is also easy to separate **shape** and **texture** in order to produce various kinds of **warped** images.
+
+AFA provides functions for two types of face-warping manipulations common in face perception research.
+
+### Morphing between faces
+To learn how to do this please see [demo 2](https://github.com/SourCherries/auto-face-align/tree/main/demos/demo_2_morphing/README.md).
+
+### Enhanced average of facial identity
+To learn how to do this please see [demo 3](https://github.com/SourCherries/auto-face-align/tree/main/demos/demo_3_averaging/README.md).
+
+# Setup
+
+It is highly recommended that you have **conda** installed, preferably **miniconda** rather than full fat **anaconda**.
+
+If you do have **conda**, then this is the easiest way to install:
+
+```bash
+conda create --name myenv "conda-forge::dlib<19.24.2" "python>=3.9" scikit-image
+
+conda activate myenv
+
+conda install -c conda-forge matplotlib
+```
+
+To install AFA next you have two options:
+
+You either do this:
+
+```bash
+pip install "alignfaces @ git+https://git@github.com/SourCherries/auto-face-align.git"
+```
+
+Or if instead you want a readable and editable copy of AFA on your local machine, then first clone this repository, go to the root folder `auto-face-align`, and then do this:
+
+```bash
+pip install .
+```
+
+Regardless of how you installed AFA, the above process will create a new virtual environment called `myenv`. You can use another name for that. You'll need to activate this environment using `conda activate myenv` whenever you want to use AFA. To deactivate, simply type `conda deactivate myenv`.
+
+If you have a readable/editable copy of AFA on your local machine, you will have copies of all the demos. Most users will want those demo scripts to get started on their projects.
+
+Other users may want a readable/editable copy of AFA to contribute to AFA, or to evaluate AFA by running the analyses under `results` or the unit tests. To run the unit tests, go to the root folder `auto-face-align` then do this:
+
+```bash
+pip install -U pytest
+pytest -v src/alignfaces/tests/
+```
+
+# How well does this work?
+In addition to unit-testing critical computations, I evaluated both landmark estimation (DLIB) and the outcome of the entire alignment procedure using various face databases. The results are described [here](https://github.com/SourCherries/auto-face-align/tree/main/results/README.md).
+
+<!-- ## Ensure that you have the proper C compiler
+On Linux, you will already have an appropriate C compiler.
+
+On Windows, you need to install Microsoft Visual Studio.
+
+On Mac, you need to install Xcode Command Line Tools.
+1. Find an Xcode version compatible with your [macOS version](https://en.wikipedia.org/wiki/Xcode).
+2. Get the right version of [Xcode Command Line Tools](https://developer.apple.com/downloads/index.action).
+``` -->
+
+# Citation
+If you use this package for your research, please cite the following preprint:
+>Gaspar, C. M., & Garrod, O. G. B. (2021, November 8). A Python toolbox for Automatic Face Alignment (AFA). Retrieved from psyarxiv.com/erc8a
+
+DOI:
+>10.31234/osf.io/erc8a
+
+# License
+This module is under an Apache-2.0 license.

alignfaces-1.0.1.dist-info/RECORD

@@ -0,0 +1,27 @@
+alignfaces/__init__.py,sha256=lbKkA2sHvuMXMfykWOhcSc2vHCLUQe-7_6b1qUnq5zE,345
+alignfaces/aperture_tools.py,sha256=WcJ6plLU-GPBXYbCxx1B7QnCpWrT-D8Xf1rc08Jz9Cs,8090
+alignfaces/contrast_tools.py,sha256=biy9Mc7XT_rBGZUSs77-4zWydCAVOLdrWUDf9QZwRoA,4352
+alignfaces/contrast_tools_.py,sha256=NOxvNyIbW95zhFkaC34owB2azxN0A9724HNUJ0KX4c8,4332
+alignfaces/face_landmarks.py,sha256=Jx9j8JxyAgzidlSfFBAM1J_1DNiNcH8P9pMLM8_9S04,9748
+alignfaces/make_aligned_faces.py,sha256=7Kw1aw6gjix4EaM5STCKvh39MrA8g5-oVOBQ8hdVWsU,51972
+alignfaces/make_aligned_faces_.py,sha256=mU0SaD7_5Gmx76fVaHl13NBnZp2zfBiqU-ZBLHo3pFA,51552
+alignfaces/make_files.py,sha256=grxFSfss6qrSpkpIZRGhqfvMKv4dtrumjcg8S8_stus,1583
+alignfaces/make_files_.py,sha256=3Ohk0271mVc35s20Z278yu3sOgDXpC6f-Nhc5dbDutk,1577
+alignfaces/make_files_OLD.py,sha256=Zm97xj6FrlItiQsFrXyTbloQO2kgQGt8E1Y4eVuUUwA,3288
+alignfaces/phase_cong_3.py,sha256=wGW-UHBDeYDTcuvIimBXAtoscJMpNOvYhTrI2O_qY1k,26218
+alignfaces/plot_tools.py,sha256=NstKasB93S2gSSLheFG2ABNVKY34Ktp_X5hGwQKMpDg,6129
+alignfaces/procrustes_tools.py,sha256=tdWFeLHSjO1a0KjU7I1zwlHxYem1zxKMTNslrCU0mX0,5720
+alignfaces/warp_tools.py,sha256=oVuR7qes5aQ7ch45Dc0nwQxRYl-JR4nsLZOXfJPYR4U,10345
+alignfaces/data/shape_predictor_68_face_landmarks.dat,sha256=-9wsuA65qnp1hnLL_doyumMA7-m25seimf9-c2sRuS8,99693937
+alignfaces/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+alignfaces/tests/_test_pawarp.py,sha256=4gva1rLWcSv7SKYoHRRxahHlelt75cmrqsvq_jzUeDk,8371
+alignfaces/tests/test_procrustes_tools.py,sha256=oPglnK0VaFBFsVIGrEySjxSIO8Ea0dLh9JNq7PThej4,22345
+alignfaces/tests/test_warp_tools.py,sha256=V0CVg3dCX4qrkzFa0Xd7JxmIqnSd56-5AEdrPMoERHA,10508
+alignfaces/tests/R/align_reference.csv,sha256=fliCYaGnvdxxq6KumISzehKF4mwpFn9u4aSyI2SqGU4,457
+alignfaces/tests/R/align_shapes.csv,sha256=ca1aPlRiaCpEz2h2CnP6VwmEjeCgoZq-z6808LFcvaE,18241
+alignfaces/tests/R/input_shapes.csv,sha256=uH25QAKQ-tsWvVKbhqQm22cx0Su3Hhs4HMdeGxviza4,8857
+alignfaces-1.0.1.dist-info/licenses/LICENSE.txt,sha256=bZvZeGJgnC6_aLZOQgPlaIr4qnZtml3ePc9CZjuLDSk,557
+alignfaces-1.0.1.dist-info/METADATA,sha256=m_LOPZDBbTaZuCySRh5amXYooXQD6PFIDMoG2XSJjhs,5461
+alignfaces-1.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+alignfaces-1.0.1.dist-info/top_level.txt,sha256=g2p6npb5XYp9YJ4DTCT9sS3PcwdLbdQi9Ml7ka-C0lk,11
+alignfaces-1.0.1.dist-info/RECORD,,

alignfaces-1.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

alignfaces-1.0.1.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2021 Carl Michael Gaspar
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

alignfaces-1.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+alignfaces