vh/vtracer
1
0
Fork 0
mirror of https://github.com/visioncortex/vtracer.git synced 2025-12-06 17:15:41 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

README

Browse Source
This commit is contained in:
Chris Tsang
2024-04-20 16:14:21 +01:00
parent 3d92586e33
commit 4544ca740d
1 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -10,9 +10,9 @@
<h3> <h3>
<a href="https://www.visioncortex.org/vtracer-docs">Article</a> <a href="https://www.visioncortex.org/vtracer-docs">Article</a>
<span> | </span> <span> | </span>
<a href="https://www.visioncortex.org/vtracer/">Demo</a> <a href="https://www.visioncortex.org/vtracer/">Web App</a>
<span> | </span> <span> | </span>
<a href="https://github.com/visioncortex/vtracer/releases/tag/0.6.0">Download</a> <a href="https://github.com/visioncortex/vtracer/releases">Download</a>
</h3> </h3>
<sub>Built with 🦀 by <a href="https://www.visioncortex.org/">The Vision Cortex Research Group</a></sub> <sub>Built with 🦀 by <a href="https://www.visioncortex.org/">The Vision Cortex Research Group</a></sub>
@@ -71,9 +71,9 @@ OPTIONS:
-s, --splice_threshold <splice_threshold> Minimum angle displacement (degree) to splice a spline -s, --splice_threshold <splice_threshold> Minimum angle displacement (degree) to splice a spline
``` ```
### Install ### Downloads
You can download pre-built binaries from [Releases](https://github.com/visioncortex/vtracer/releases/tag/0.6.0). You can download pre-built binaries from [Releases](https://github.com/visioncortex/vtracer/releases).
You can also install the program from source from [crates.io/vtracer](https://crates.io/crates/vtracer): You can also install the program from source from [crates.io/vtracer](https://crates.io/crates/vtracer):
@@ -81,6 +81,8 @@ You can also install the program from source from [crates.io/vtracer](https://cr
cargo install vtracer cargo install vtracer
``` ```
> You are strongly advised to not download from any other third-party sources
### Usage ### Usage
```sh ```sh
@@ -105,7 +107,7 @@ pip install vtracer
## In the wild ## In the wild
VTracer is used by the following projects (feel free to add yours!): VTracer is used by the following products (open a PR to add yours):
<table> <table>
<tbody> <tbody>
@@ -118,12 +120,18 @@ VTracer is used by the following projects (feel free to add yours!):
</tbody> </tbody>
</table> </table>
## Anecdotes ## Citations
VTracer has since been cited in a few academic papers. Please kindly let us know if you have cited our work:
+ [Framework to Vectorize Digital Artworks for Physical Fabrication based on Geometric Stylization Techniques](https://www.researchgate.net/publication/374448489_Framework_to_Vectorize_Digital_Artworks_for_Physical_Fabrication_based_on_Geometric_Stylization_Techniques)
+ [Image Vectorization: a Review](https://arxiv.org/pdf/2306.06441.pdf)
+ [StarVector: Generating Scalable Vector Graphics Code from Images](https://arxiv.org/abs/2312.11556)
## How did VTracer come about?
> The following content is an excerpt from my [unpublished memoir](https://github.com/visioncortex/memoir). > The following content is an excerpt from my [unpublished memoir](https://github.com/visioncortex/memoir).
### How / when / where did VTracer come about?
At my teenage, two open source projects in the vector graphics space inspired me the most: Potrace and Anti-Grain Geometry (AGG). At my teenage, two open source projects in the vector graphics space inspired me the most: Potrace and Anti-Grain Geometry (AGG).
Many years later, in 2020, I was developing a video processing engine. And it became evident that it requires way more investment to be commercially viable. So before abandoning the project, I wanted to publish *something* as open-source for posterity. At that time, I already developed a prototype vector graphics tracer. It can convert high-resolution scans of hand-drawn blueprints into vectors. But it can only process black and white images, and can only output polygons, not splines. Many years later, in 2020, I was developing a video processing engine. And it became evident that it requires way more investment to be commercially viable. So before abandoning the project, I wanted to publish *something* as open-source for posterity. At that time, I already developed a prototype vector graphics tracer. It can convert high-resolution scans of hand-drawn blueprints into vectors. But it can only process black and white images, and can only output polygons, not splines.