Equistitch

Equistitch is utility for breaking 360 degree equirectangular panoramas into perspective projected cubemaps, tiles and making the transformation back.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

This is small utility tool made to process 360 degree images. It can be used as component of the data pipeline in ML recognition from 360 degree images.

There can be other use-cases as well if you need to process perspective fixed images and then stitch them back.

You could also generate cubemaps for 3D engines using this tool.

(back to top)

Built With

• Rust

(back to top)

Getting Started

Equistitch is very simple program. Only single file src/main.rs

To use either build from sources or download binary.

Prerequisites

You just need Rust toolkit installed. Check out also binary releases

Installation from sources

1. Install rust toolkit (https://www.rust-lang.org/tools/install)
2. Clone the repo

   git clone https://github.com/emblica/equistitch.git

3. Build

   cargo build --release

4. Equistitch will be built at target/release/equistitch

(back to top)

Usage

Show help

equistitch -h

Equirectangular image to cubemap faces:

equistitch split --input example.png --cubemap-faces-output cube/

Equirectangular image to tiles:

equistitch split --input example.png --tiles-output tiles/

Cubemap faces to equirectangular image:

equistitch stitch --input-dir cube/ --output exa_stitch_from_cubemap.png

Tiles to equirectangular image:

equistitch stitch --input-dir tiles/ -t --output exa_stitch_from_tiles.png

(back to top)

Roadmap

Unix principle is strong in this one. Equistitch does single task and it does it well, there is not planned roadmap currently.

Bug fixes and performance updates are possible.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Emblica - @emblicacom - [email protected]

Project Link: https://github.com/emblica/equistitch

(back to top)