vision6D


Namevision6D JSON
Version 0.5.1 PyPI version JSON
download
home_pagehttps://github.com/ykzzyk/vision6D
Summary3D-to-2D visualization and annotation desktop app for 6D pose estimation related tasks. This python-based application is designed to work on Windows and Linux (Ubuntu-tested).
upload_time2024-09-21 17:44:12
maintainerNone
docs_urlNone
authorNone
requires_python>=3.6
licenseGNU GENERAL Public License
keywords 6d pose estimation registration segmentation tool
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1 align="center">
  <br>
  <a href=""><img src="https://github.com/user-attachments/assets/77a97754-8a34-44e9-b22a-a506842699a2" alt="Vision6D" width="300"></a>
  <br>
  VISION6D
  <br>
</h1>

<h4 align="center">VISION6D: 3D-to-2D visualization and annotation desktop app for 6D pose estimation related tasks. This python-based application is designed to work on Windows and Linux (Ubuntu-tested).</h4>

<p align="center">
  <a href="https://github.com/InteractiveGL/vision6D/releases">
    <img src="https://img.shields.io/github/v/release/InteractiveGL/vision6D"
         alt="github_release">
  </a>
  <!-- <a href="https://github.com/InteractiveGL/vision6D/blob/main/LICENSE">
    <img src="https://img.shields.io/github/license/InteractiveGL/vision6D"
         alt="github_license">
  </a> -->
  <a href="https://github.com/InteractiveGL/vision6D/blob/main/LICENSE">
    <img src="https://img.shields.io/github/last-commit/InteractiveGL/vision6D/main"
         alt="github_commit">
  </a>
  <a href="https://github.com/InteractiveGL/vision6D/">
    <img src="https://img.shields.io/github/downloads/InteractiveGL/vision6D/total"
         alt="github_downloads">
  </a>
  <a href="https://github.com/InteractiveGL/vision6D/graphs/contributors">
    <img src="https://img.shields.io/github/contributors/InteractiveGL/vision6D"
         alt="github_contributes">
  </a>
  <a href="https://github.com/InteractiveGL/vision6D">
    <img src="https://img.shields.io/github/stars/InteractiveGL/vision6D"
         alt="github_stars">
  </a>
</p>

<p align="center">
  <a href="#key-features">Key Features</a> •
  <a href="#how-to-use">How To Use</a> •
  <a href="#examples">Examples</a> •
  <a href="#download">Download</a> •
  <a href="#emailware">Emailware</a> •
  <a href="#credits">Credits</a> •
  <a href="#license">License</a>
</p>

![screenshot](https://github.com/user-attachments/assets/a3697ff5-1270-4da6-9273-a1f2ae1e19be)


## Key Features

* LivePreview - Make changes, See changes
  - Instantly see what your pose annotation in Vision6D as you move the 3D objects!
* Provide built-in [NOCS](https://arxiv.org/abs/1901.02970) color representation for the 3D meshes
  - color the meshes with NOCS.
* Load the textures for the 3D meshes
  - color the meshes with their own textures.
* Segmentation Mask/Bounding Box Drawing
  - create a segmentation mask in Vision6D on top of the provided 2D image.
* Real-time rendering results
  - renders the annotated results.
* Cross platform
  - Windows and Linux (Ubuntu-tested) ready (highly recommend to use with a mouse).

## How To Use

To clone and run this application, you'll need [Git](https://git-scm.com) and [Python](https://www.python.org/) installed on your computer. From your command line:

```bash
# (Optional) Create a conda environment
$ conda create -n vision6D python=3.10

# Clone this repository
$ git clone https://github.com/InteractiveGL/vision6D.git

# Go into the repository
$ cd vision6D

# Install dependencies
$ pip install .

# Run the app
$ Vision6D
```

## Examples
Note that when fisrt load the application, it may take some time. Once it load successfully, the interactive experience will be smooth.

**PnP resgitration of the benchvise**
<p float="left">
  <img src="https://github.com/user-attachments/assets/e1968f74-dcdd-4c01-a3dc-69c54b97dc84" alt="screenshot 1" width="45%" style="margin-right: 20px;" />
  <img src="https://github.com/user-attachments/assets/2fb62058-b5d1-4adf-851d-036065735fcd" alt="screenshot 2" width="45%" />
</p>

**Set a ground-truth pose for visualization of the benchvise (ground-truth pose is obtained from the public 6D pose dataset Linemod)**
<p float="left">
  <img src="https://github.com/user-attachments/assets/da9c1eb8-abbd-4045-bc54-200bef15452d" alt="screenshot 1" width="45%" style="margin-right: 20px;" />
  <img src="https://github.com/user-attachments/assets/9f6fed68-0c45-4969-b0e4-62bfc6efc255" alt="screenshot 2" width="45%" />
</p>

**Free-hand registration of the benchvise**
<p>
  <img src="https://github.com/user-attachments/assets/0b5468bb-3fdc-4932-8821-da253d33d722" alt="screenshot" width="92%" />
</p>

**Draw a segmentation mask on the duck in this scene**
<p float="left">
  <img src="https://github.com/user-attachments/assets/fe1e71a0-edab-46c0-84d0-e9e5296c4841" alt="screenshot 1" width="45%" style="margin-right: 20px;" />
  <img src="https://github.com/user-attachments/assets/76b7bfcc-df15-4bfd-a4e0-e5348e559ac3" alt="screenshot 2" width="45%" />
</p>

**Draw a bounding box around the duck in this scene**
<p float="left">
  <img src="https://github.com/user-attachments/assets/fcf2b64d-3d3f-4b8a-8b57-19a5b3e7117e" alt="screenshot 1" width="45%" style="margin-right: 20px;" />
  <img src="https://github.com/user-attachments/assets/7e3a8f39-e54a-463a-a1e9-1f4bc266c2ac" alt="screenshot 2" width="45%" />
</p>

**Render the benchwise mesh**
<p float="left">
  <img src="https://github.com/user-attachments/assets/1fb83ebe-68e3-469c-b704-53cbbc7570d8" alt="screenshot 1" width="45%" style="margin-right: 20px;" />
  <img src="https://github.com/user-attachments/assets/2cb28dc9-65af-4037-bcfa-e6ea5907e253" alt="screenshot 2" width="45%" />
</p>

## Download

You can [download](https://github.com/InteractiveGL/vision6D/releases/tag/0.3.9) the latest installable version of Vision6D for Windows, macOS and Linux.

## Emailware

Vision6D is an [emailware](https://en.wiktionary.org/wiki/emailware). Meaning, if you liked using this app or it has helped you in any way, I'd like you send me an email at <yike.zhang@vanderbilt.edu> about anything you'd want to say about this software. I'd really appreciate it! Alternatively, you can also submit an issue regarding using this software, I'll answer it as soon as I see it!

## Credits

This software uses the following open source packages:

- [Pyvista](https://docs.pyvista.org)
- [VTK](https://vtk.org/)
- [PyQt5](https://www.riverbankcomputing.com/static/Docs/PyQt5/)
- [pyvistaqt](https://github.com/pyvista/pyvistaqt)
- [NumPy](https://numpy.org/)

## License

GNU

---

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ykzzyk/vision6D",
    "name": "vision6D",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "6D, pose estimation, registration, segmentation, tool",
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/fa/69/775f7e6d1195c00dd3f7f20c8630a03767c9a314b4bbd83328feaef76583/vision6d-0.5.1.tar.gz",
    "platform": "any",
    "description": "<h1 align=\"center\">\n  <br>\n  <a href=\"\"><img src=\"https://github.com/user-attachments/assets/77a97754-8a34-44e9-b22a-a506842699a2\" alt=\"Vision6D\" width=\"300\"></a>\n  <br>\n  VISION6D\n  <br>\n</h1>\n\n<h4 align=\"center\">VISION6D: 3D-to-2D visualization and annotation desktop app for 6D pose estimation related tasks. This python-based application is designed to work on Windows and Linux (Ubuntu-tested).</h4>\n\n<p align=\"center\">\n  <a href=\"https://github.com/InteractiveGL/vision6D/releases\">\n    <img src=\"https://img.shields.io/github/v/release/InteractiveGL/vision6D\"\n         alt=\"github_release\">\n  </a>\n  <!-- <a href=\"https://github.com/InteractiveGL/vision6D/blob/main/LICENSE\">\n    <img src=\"https://img.shields.io/github/license/InteractiveGL/vision6D\"\n         alt=\"github_license\">\n  </a> -->\n  <a href=\"https://github.com/InteractiveGL/vision6D/blob/main/LICENSE\">\n    <img src=\"https://img.shields.io/github/last-commit/InteractiveGL/vision6D/main\"\n         alt=\"github_commit\">\n  </a>\n  <a href=\"https://github.com/InteractiveGL/vision6D/\">\n    <img src=\"https://img.shields.io/github/downloads/InteractiveGL/vision6D/total\"\n         alt=\"github_downloads\">\n  </a>\n  <a href=\"https://github.com/InteractiveGL/vision6D/graphs/contributors\">\n    <img src=\"https://img.shields.io/github/contributors/InteractiveGL/vision6D\"\n         alt=\"github_contributes\">\n  </a>\n  <a href=\"https://github.com/InteractiveGL/vision6D\">\n    <img src=\"https://img.shields.io/github/stars/InteractiveGL/vision6D\"\n         alt=\"github_stars\">\n  </a>\n</p>\n\n<p align=\"center\">\n  <a href=\"#key-features\">Key Features</a> \u2022\n  <a href=\"#how-to-use\">How To Use</a> \u2022\n  <a href=\"#examples\">Examples</a> \u2022\n  <a href=\"#download\">Download</a> \u2022\n  <a href=\"#emailware\">Emailware</a> \u2022\n  <a href=\"#credits\">Credits</a> \u2022\n  <a href=\"#license\">License</a>\n</p>\n\n![screenshot](https://github.com/user-attachments/assets/a3697ff5-1270-4da6-9273-a1f2ae1e19be)\n\n\n## Key Features\n\n* LivePreview - Make changes, See changes\n  - Instantly see what your pose annotation in Vision6D as you move the 3D objects!\n* Provide built-in [NOCS](https://arxiv.org/abs/1901.02970) color representation for the 3D meshes\n  - color the meshes with NOCS.\n* Load the textures for the 3D meshes\n  - color the meshes with their own textures.\n* Segmentation Mask/Bounding Box Drawing\n  - create a segmentation mask in Vision6D on top of the provided 2D image.\n* Real-time rendering results\n  - renders the annotated results.\n* Cross platform\n  - Windows and Linux (Ubuntu-tested) ready (highly recommend to use with a mouse).\n\n## How To Use\n\nTo clone and run this application, you'll need [Git](https://git-scm.com) and [Python](https://www.python.org/) installed on your computer. From your command line:\n\n```bash\n# (Optional) Create a conda environment\n$ conda create -n vision6D python=3.10\n\n# Clone this repository\n$ git clone https://github.com/InteractiveGL/vision6D.git\n\n# Go into the repository\n$ cd vision6D\n\n# Install dependencies\n$ pip install .\n\n# Run the app\n$ Vision6D\n```\n\n## Examples\nNote that when fisrt load the application, it may take some time. Once it load successfully, the interactive experience will be smooth.\n\n**PnP resgitration of the benchvise**\n<p float=\"left\">\n  <img src=\"https://github.com/user-attachments/assets/e1968f74-dcdd-4c01-a3dc-69c54b97dc84\" alt=\"screenshot 1\" width=\"45%\" style=\"margin-right: 20px;\" />\n  <img src=\"https://github.com/user-attachments/assets/2fb62058-b5d1-4adf-851d-036065735fcd\" alt=\"screenshot 2\" width=\"45%\" />\n</p>\n\n**Set a ground-truth pose for visualization of the benchvise (ground-truth pose is obtained from the public 6D pose dataset Linemod)**\n<p float=\"left\">\n  <img src=\"https://github.com/user-attachments/assets/da9c1eb8-abbd-4045-bc54-200bef15452d\" alt=\"screenshot 1\" width=\"45%\" style=\"margin-right: 20px;\" />\n  <img src=\"https://github.com/user-attachments/assets/9f6fed68-0c45-4969-b0e4-62bfc6efc255\" alt=\"screenshot 2\" width=\"45%\" />\n</p>\n\n**Free-hand registration of the benchvise**\n<p>\n  <img src=\"https://github.com/user-attachments/assets/0b5468bb-3fdc-4932-8821-da253d33d722\" alt=\"screenshot\" width=\"92%\" />\n</p>\n\n**Draw a segmentation mask on the duck in this scene**\n<p float=\"left\">\n  <img src=\"https://github.com/user-attachments/assets/fe1e71a0-edab-46c0-84d0-e9e5296c4841\" alt=\"screenshot 1\" width=\"45%\" style=\"margin-right: 20px;\" />\n  <img src=\"https://github.com/user-attachments/assets/76b7bfcc-df15-4bfd-a4e0-e5348e559ac3\" alt=\"screenshot 2\" width=\"45%\" />\n</p>\n\n**Draw a bounding box around the duck in this scene**\n<p float=\"left\">\n  <img src=\"https://github.com/user-attachments/assets/fcf2b64d-3d3f-4b8a-8b57-19a5b3e7117e\" alt=\"screenshot 1\" width=\"45%\" style=\"margin-right: 20px;\" />\n  <img src=\"https://github.com/user-attachments/assets/7e3a8f39-e54a-463a-a1e9-1f4bc266c2ac\" alt=\"screenshot 2\" width=\"45%\" />\n</p>\n\n**Render the benchwise mesh**\n<p float=\"left\">\n  <img src=\"https://github.com/user-attachments/assets/1fb83ebe-68e3-469c-b704-53cbbc7570d8\" alt=\"screenshot 1\" width=\"45%\" style=\"margin-right: 20px;\" />\n  <img src=\"https://github.com/user-attachments/assets/2cb28dc9-65af-4037-bcfa-e6ea5907e253\" alt=\"screenshot 2\" width=\"45%\" />\n</p>\n\n## Download\n\nYou can [download](https://github.com/InteractiveGL/vision6D/releases/tag/0.3.9) the latest installable version of Vision6D for Windows, macOS and Linux.\n\n## Emailware\n\nVision6D is an [emailware](https://en.wiktionary.org/wiki/emailware). Meaning, if you liked using this app or it has helped you in any way, I'd like you send me an email at <yike.zhang@vanderbilt.edu> about anything you'd want to say about this software. I'd really appreciate it! Alternatively, you can also submit an issue regarding using this software, I'll answer it as soon as I see it!\n\n## Credits\n\nThis software uses the following open source packages:\n\n- [Pyvista](https://docs.pyvista.org)\n- [VTK](https://vtk.org/)\n- [PyQt5](https://www.riverbankcomputing.com/static/Docs/PyQt5/)\n- [pyvistaqt](https://github.com/pyvista/pyvistaqt)\n- [NumPy](https://numpy.org/)\n\n## License\n\nGNU\n\n---\n",
    "bugtrack_url": null,
    "license": "GNU GENERAL Public License",
    "summary": "3D-to-2D visualization and annotation desktop app for 6D pose estimation related tasks. This python-based application is designed to work on Windows and Linux (Ubuntu-tested).",
    "version": "0.5.1",
    "project_urls": {
        "Documentation": "https://vision6d.readthedocs.io/en/latest/",
        "Homepage": "https://github.com/ykzzyk/vision6D"
    },
    "split_keywords": [
        "6d",
        " pose estimation",
        " registration",
        " segmentation",
        " tool"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "124d6fb796406573b2bf1af60e15fc5584801f5ce65fb530e652bdc1f99d4953",
                "md5": "ed8c0eb0d2ca94f7b87aa3d7f3208180",
                "sha256": "89f655d472f457ad095c190f8a3c36549bc0fbc12acac3409b73fa09da702dab"
            },
            "downloads": -1,
            "filename": "vision6D-0.5.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ed8c0eb0d2ca94f7b87aa3d7f3208180",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.6",
            "size": 328637,
            "upload_time": "2024-09-21T17:44:10",
            "upload_time_iso_8601": "2024-09-21T17:44:10.680417Z",
            "url": "https://files.pythonhosted.org/packages/12/4d/6fb796406573b2bf1af60e15fc5584801f5ce65fb530e652bdc1f99d4953/vision6D-0.5.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fa69775f7e6d1195c00dd3f7f20c8630a03767c9a314b4bbd83328feaef76583",
                "md5": "268d73f3946a5f0964e7370ffe30a9a0",
                "sha256": "5cd9c2c9b829bf164916a850ce7094ebadd622e10bf4e6d72f280614b82d7cf3"
            },
            "downloads": -1,
            "filename": "vision6d-0.5.1.tar.gz",
            "has_sig": false,
            "md5_digest": "268d73f3946a5f0964e7370ffe30a9a0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 316240,
            "upload_time": "2024-09-21T17:44:12",
            "upload_time_iso_8601": "2024-09-21T17:44:12.434611Z",
            "url": "https://files.pythonhosted.org/packages/fa/69/775f7e6d1195c00dd3f7f20c8630a03767c9a314b4bbd83328feaef76583/vision6d-0.5.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-21 17:44:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ykzzyk",
    "github_project": "vision6D",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "vision6d"
}
        
Elapsed time: 0.58614s