Metadata-Version: 2.1
Name: face_symmetrizer
Version: 1.6
Summary: Easy symmetrizer for an image contained face(s)
Home-page: https://github.com/eggplants/face-symmetrizer
Author: eggplants
License: MIT
Description: # face-symmetrizer
        
        [![PyPI version](https://img.shields.io/pypi/v/face_symmetrizer)](https://pypi.org/project/face-symmetrizer) [![GitHub release](https://img.shields.io/github/v/release/eggplants/face-symmetrizer)](https://github.com/eggplants/face-symmetrizer/releases)
        
        - Easy symmetrizer for an image contained face(s)
        
        ## Install
        
        ```bash
        pip install face-symmetrizer
        ```
        
        ## How
        
        - Here is an example image of two people
        
        ![fig0](img/two_people.jpg)
        
        ### Command
        
        ```txt
        $ fsym -h
        usage: fsym [-h] [-s] [-S] [-q] [-o dir] file [file ...]
        
        Easy symmetrizer for an image contained face(s)
        
        positional arguments:
          file                  input image files
        
        optional arguments:
          -h, --help            show this help message and exit
          -s, --show            show images (default: False)
          -S, --save            save images (default: False)
          -q, --quiet           make log quiet (default: False)
          -o dir, --outdir dir  directory when saving images (default: .)
        ```
        
        - Detect with window and save symmetrized images to [outimg](outimg)
        
        ```txt
        $ fsym img/two_people.jpg -o outimg -s --save
        [+]image: img/two_people.jpg
        [+]2 face(s) was detected.
        [+]face: 0 # open window when using `-s`
        [+]save: outimg/two_people.face-0.left_cropped.jpg
        [+]save: outimg/two_people.face-0.left_cropped_inner.jpg
        [+]save: outimg/two_people.face-0.left_cropped_outer.jpg
        [+]save: outimg/two_people.face-0.right_cropped.jpg
        [+]save: outimg/two_people.face-0.right_cropped_inner.jpg
        [+]save: outimg/two_people.face-0.right_cropped_outer.jpg
        [+]face: 1 # open window when using `-s`
        [+]save: outimg/two_people.face-1.left_cropped.jpg
        [+]save: outimg/two_people.face-1.left_cropped_inner.jpg
        [+]save: outimg/two_people.face-1.left_cropped_outer.jpg
        [+]save: outimg/two_people.face-1.right_cropped.jpg
        [+]save: outimg/two_people.face-1.right_cropped_inner.jpg
        [+]save: outimg/two_people.face-1.right_cropped_outer.jpg
        ```
        
        ### Library
        
        - First, load an image
        
        ```python
        from face_symmetrizer import FaceSym
        
        # load from local file path
        f = FaceSym("img/two_people.jpg")
        # or, load from URL
        # f = FaceSym("https://raw.githubusercontent.com/ageitgey/"
        #             "face_recognition/master/examples/two_people.jpg")
        
        
        # ATTRS: ['image_location',
        #         'f_img', 'f_img_PIL', 'image_size',
        #         'face_locations', 'face_landmarks',
        #         'mid_face_locations', 'face_count']
        ```
        
        - Get & show a full image
        
        ```python
        f.get_full_image(show=True) #=> <PIL.Image.Image>
        ```
        
        ![fig1](img/Figure_1.png)
        
        - Get & show an image of a rectangle drawn around a face.
        
        ```python
        f.get_face_box_drawed_image(show=True) #=> <PIL.Image.Image>
        ```
        
        ![fig2](img/Figure_2.png)
        
        - Get & show cropped face(s)
        
        ```python
        f.get_cropped_face_images(show=True) #=> [<PIL.Image.Image>, ...]
        ```
        
        ![fig3](img/Figure_3.png)
        ![fig4](img/Figure_4.png)
        
        - Get & show symmetrized images (face: 0)
        
        ```python
        f.get_symmetrized_images(show=True, idx=0)
        #=> (left_cropped, left_cropped_inner, left_cropped_outer,
        #    right_cropped, right_cropped_inner, right_cropped_outer)
        ```
        
        ![fig5](img/Figure_5.png)
        
        - Get & show symmetrized images (face: 1)
        
        ```python
        f.get_symmetrized_images(show=True, idx=1)
        ```
        
        ![fig6](img/Figure_6.png)
        
        ## LICENSE
        
        MIT
        
Platform: UNKNOWN
Requires-Python: >=3.8
Description-Content-Type: text/markdown
