# facialmatch
**facialmatch** is a Python package that provides easy-to-use functions for comparing faces in images and extracting facial regions from a given image.
## Features
- 🧑🤝🧑 **Compare Faces:** Compare two images and check if they match with a given similarity threshold.
- 🖼️ **Extract Face:** Extract and return the facial region from an image.
## Installation
You can install the package via pip:
```bash
pip install facialmatch
```
## Usage
**match.py**
```bash
from facialmatch import compare_faces
# Compare two faces
result = compare_faces("path/to/image1.jpg", "path/to/image2.jpg")
# Custom similarity threshold
custom_result = compare_faces("path/to/image1.jpg", "path/to/image2.jpg", minimum_similarity=0.80)
```
**output**
```bash
{
"similarity": 0.86,
"match": "true"
}
```
##
**ExtractFace.py**
```bash
from facialmatch import get_face_from_image
import matplotlib.pyplot as plt
# Extract a face from an image
face_image = get_face_from_image("path/to/image")
# Display the extracted face using matplotlib
plt.imshow(face_image)
plt.axis('off') # Turn off the axis
plt.show()
```
Raw data
{
"_id": null,
"home_page": null,
"name": "facialmatch",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, face, face matching, face detection, face recognition, opencv, opencv-python, numpy, scikit-learn",
"author": "Hemang Baldha",
"author_email": "hemang9705@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/da/a0/6bb30d9f6f58ead78268c9fb7ab7e4bdbfcd3175f1bf79a891b85714371d/facialmatch-1.0.1.tar.gz",
"platform": null,
"description": "\r\n# facialmatch\r\n\r\n\r\n\r\n**facialmatch** is a Python package that provides easy-to-use functions for comparing faces in images and extracting facial regions from a given image.\r\n\r\n\r\n\r\n## Features\r\n\r\n\r\n\r\n- \ud83e\uddd1\u200d\ud83e\udd1d\u200d\ud83e\uddd1 **Compare Faces:** Compare two images and check if they match with a given similarity threshold.\r\n\r\n- \ud83d\uddbc\ufe0f **Extract Face:** Extract and return the facial region from an image.\r\n\r\n\r\n\r\n## Installation\r\n\r\n\r\n\r\nYou can install the package via pip:\r\n\r\n\r\n\r\n```bash\r\n\r\npip install facialmatch\r\n\r\n```\r\n\r\n\r\n\r\n## Usage\r\n\r\n\r\n\r\n**match.py**\r\n\r\n```bash\r\n\r\nfrom facialmatch import compare_faces\r\n\r\n\r\n\r\n# Compare two faces\r\n\r\nresult = compare_faces(\"path/to/image1.jpg\", \"path/to/image2.jpg\")\r\n\r\n\r\n\r\n# Custom similarity threshold\r\n\r\ncustom_result = compare_faces(\"path/to/image1.jpg\", \"path/to/image2.jpg\", minimum_similarity=0.80)\r\n\r\n```\r\n\r\n**output**\r\n\r\n```bash\r\n\r\n{\r\n\r\n \"similarity\": 0.86,\r\n\r\n \"match\": \"true\"\r\n\r\n}\r\n\r\n\r\n\r\n```\r\n\r\n##\r\n\r\n**ExtractFace.py**\r\n\r\n```bash\r\n\r\nfrom facialmatch import get_face_from_image\r\n\r\nimport matplotlib.pyplot as plt\r\n\r\n\r\n\r\n# Extract a face from an image\r\n\r\nface_image = get_face_from_image(\"path/to/image\")\r\n\r\n\r\n\r\n# Display the extracted face using matplotlib\r\n\r\nplt.imshow(face_image)\r\n\r\nplt.axis('off') # Turn off the axis\r\n\r\nplt.show()\r\n\r\n```\r\n\r\n",
"bugtrack_url": null,
"license": null,
"summary": "face matching",
"version": "1.0.1",
"project_urls": null,
"split_keywords": [
"python",
" face",
" face matching",
" face detection",
" face recognition",
" opencv",
" opencv-python",
" numpy",
" scikit-learn"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f23f09f181013ef61ae9bded60ab22fa99a76af102733b8684d381f841bae6c1",
"md5": "0480d9d0e7ab8c51747e9aa4ecbf02e0",
"sha256": "ae3e7be2643d5fe5311b3400044305923ce8ed432c54668979dbad9476e5e416"
},
"downloads": -1,
"filename": "facialmatch-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0480d9d0e7ab8c51747e9aa4ecbf02e0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4185,
"upload_time": "2024-09-15T16:41:50",
"upload_time_iso_8601": "2024-09-15T16:41:50.301788Z",
"url": "https://files.pythonhosted.org/packages/f2/3f/09f181013ef61ae9bded60ab22fa99a76af102733b8684d381f841bae6c1/facialmatch-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "daa06bb30d9f6f58ead78268c9fb7ab7e4bdbfcd3175f1bf79a891b85714371d",
"md5": "1db922fc884d672b5600322331b6caf4",
"sha256": "caddef20577db3423370c4cb06e4929da227caf1edc6fcc7664578ed357e3728"
},
"downloads": -1,
"filename": "facialmatch-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "1db922fc884d672b5600322331b6caf4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4085,
"upload_time": "2024-09-15T16:41:52",
"upload_time_iso_8601": "2024-09-15T16:41:52.059781Z",
"url": "https://files.pythonhosted.org/packages/da/a0/6bb30d9f6f58ead78268c9fb7ab7e4bdbfcd3175f1bf79a891b85714371d/facialmatch-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-15 16:41:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "facialmatch"
}
JSON