______________________________________________________________________
+
# Face Mesh Editor
#### An Editor to manually adjust automatic Face Mesh Detections
+
______________________________________________________________________
@@ -13,13 +15,15 @@ ______________________________________________________________________
+Check the [Documentation](https://hcmlab.github.io/FaceMeshEditor/docs/)
## Features
### General
+
Image(s) Upload
-Supported formats: **jpg** and **png**
+Supported formats: **jpg** and **png**
Annotation Upload
@@ -37,61 +41,79 @@ Format: **json**
* **Redo**: Allows users to repeat a previous action. Useful for reverting to a specific state.
* **Undo**: Reverts the most recent action. Handy for correcting mistakes.
* **Reset**: Restores the system to its initial state. Useful for starting over.
+
Model Selection
* MediaPipe (Default): Works offline. This mode utilizes a pre-trained model within the system.
* Webservice (Custom): Operates online. Users can connect to a custom external service for specialized processing.
+
Delete Features
-If a displayed face lacks a trait, marking it as hidden signifies its non-existence, and eliminated points are flagged as such in the json file.
+If a displayed face lacks a trait, marking it as hidden signifies its non-existence, and eliminated points are flagged
+as such in the json file.
Image Preview
-Displays thumbnails of uploaded images. These small visual representations help users quickly identify and select the desired image.
+Displays thumbnails of uploaded images. These small visual representations help users quickly identify and select the
+desired image.
### Editor
+
Cascading Drag
-The Cascading Drag tool facilitates smooth movement of points by considering their neighboring points. When a user drags a point, the tool calculates the movement distance for nearby points using an incremental function. This real-time update ensures a responsive and intuitive interface.
+The Cascading Drag tool facilitates smooth movement of points by considering their neighboring points. When a user drags
+a point, the tool calculates the movement distance for nearby points using an incremental function. This real-time
+update ensures a responsive and intuitive interface.
Hide Tesselation
-The Hide Tesselation feature enhances focus on specific regions during annotation. Even when tesselation and their corresponding points are hidden, users can still manipulate points via cascading drag if they are selected closely enough. This allows precise adjustments while maintaining a clutter-free view.
+The Hide Tesselation feature enhances focus on specific regions during annotation. Even when tesselation and their
+corresponding points are hidden, users can still manipulate points via cascading drag if they are selected closely
+enough. This allows precise adjustments while maintaining a clutter-free view.
Zoom
-The Zoom functionality allows users to adjust the magnification level of the image. By zooming in, users can examine finer details with clarity. Conversely, zooming out provides a broader view of the entire image.
+The Zoom functionality allows users to adjust the magnification level of the image. By zooming in, users can examine
+finer details with clarity. Conversely, zooming out provides a broader view of the entire image.
Pan
-The Pan feature enables users to shift the visible portion of the image. By panning, users can explore different areas without changing the zoom level. It’s particularly useful for navigating large or detailed images.
+The Pan feature enables users to shift the visible portion of the image. By panning, users can explore different areas
+without changing the zoom level. It’s particularly useful for navigating large or detailed images.
-
## Custom Webservice API
-As a user, you have the flexibility to integrate various face mesh detection models seamlessly into our application. Whether you want to provide a pre-trained model via the webservice or create a dynamic model that continues to learn, this API empowers you to tailor face mesh detection to your specific needs.
+
+As a user, you have the flexibility to integrate various face mesh detection models seamlessly into our application.
+Whether you want to provide a pre-trained model via the webservice or create a dynamic model that continues to learn,
+this API empowers you to tailor face mesh detection to your specific needs.
### Key Endpoints
+
```
/detect
```
+
* **Method**: POST and GET
* **Input**: Form-data with a file (supported formats: jpg and png)
-* **Return**: JSON response containing detection results
-* **Description**: This endpoint allows users to submit an image for detection. The supported formats are jpg and png. The system processes the uploaded file and responds with detection information in JSON format.
+* **Return**: JSON response containing detection results
+* **Description**: This endpoint allows users to submit an image for detection. The supported formats are jpg and png.
+ The system processes the uploaded file and responds with detection information in JSON format.
```
/annotations
```
+
* **Method**: POST
* **Input**: JSON string
-* **Description**: Users can send annotation data in JSON format to this endpoint. The system processes the annotations and performs relevant actions based on the provided information.
+* **Description**: Users can send annotation data in JSON format to this endpoint. The system processes the annotations
+ and performs relevant actions based on the provided information.
From a7ef618ac12ad8a4afa89f6489e7502b153727a5 Mon Sep 17 00:00:00 2001
From: Marc-Lorenz <169900493+Marc-Lorenz@users.noreply.github.com>
Date: Wed, 16 Apr 2025 08:22:13 +0200
Subject: [PATCH 3/7] Move doc link in main README; Rename editor in api doc
---
README.md | 4 ++--
doc/remote_api.yaml | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 0f6818f..d412858 100644
--- a/README.md
+++ b/README.md
@@ -12,11 +12,11 @@ ______________________________________________________________________
[**Demo**](https://hcmlab.github.io/FaceMeshEditor/)
+Check the [Documentation](https://hcmlab.github.io/FaceMeshEditor/docs/)
+
-Check the [Documentation](https://hcmlab.github.io/FaceMeshEditor/docs/)
-
## Features
### General
diff --git a/doc/remote_api.yaml b/doc/remote_api.yaml
index ce8787e..a7cc2c8 100644
--- a/doc/remote_api.yaml
+++ b/doc/remote_api.yaml
@@ -1,6 +1,6 @@
openapi: 3.0.3
info:
- title: FaceMeshEditor remote api
+ title: Landmark Editor remote api
description: Describes the API a server should supply to work with this application
version: 1.0.0
components:
@@ -73,7 +73,7 @@ components:
Coordinate:
type: number
format: float
- description: the relative position on one axis. The api might accept points outside the image, to support points
+ description: the relative position on one axis. The api might accept points outside the image, to support points
outside the image area.
minimum: 0
maximum: 1.0
From 68439fb43190c743ad71fdf770fe80cf05921e11 Mon Sep 17 00:00:00 2001
From: Marc-Lorenz <169900493+Marc-Lorenz@users.noreply.github.com>
Date: Wed, 16 Apr 2025 09:43:13 +0200
Subject: [PATCH 4/7] Fixed main doc page layout
---
doc/adding_new_model.html | 32 +++++++-------
doc/api_doc.html | 32 +++++++-------
doc/handbook.html | 32 +++++++-------
doc/index.html | 87 +++++++++++++++++++--------------------
4 files changed, 91 insertions(+), 92 deletions(-)
diff --git a/doc/adding_new_model.html b/doc/adding_new_model.html
index b7c5c30..973d3b9 100644
--- a/doc/adding_new_model.html
+++ b/doc/adding_new_model.html
@@ -9,24 +9,24 @@
-
-
+