Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
himynamesdave committed Jul 4, 2020
1 parent de46807 commit 5d971ee
Show file tree
Hide file tree
Showing 8 changed files with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,17 +53,17 @@ Using the script is simple. Arguments can be provided in the following format:

`python nadir-patcher.py "[PANORAMIC PHOTO / VIDEO FILE OR FOLDER PATH]" "[NADIR FILE PATH]" [PERCENTAGE SIZE] "[OUTPUT_FOLDER_PATH]"`

In the images below I'll use [this panoramic photo](samples/input/MULTISHOT_9698_000001.jpg) and [this nadir](samples/input/my_custom_nadir.png).
In the images below I'll use [this panoramic photo](/samples/input/MULTISHOT_9698_000001.jpg) and [this nadir](/samples/input/my_custom_nadir.png).

`[PERCENTAGE SIZE]` refers to the height of the nadir as a percentage of total image height. This must be specified as whole number between 1 (smallest) and 100 (covers entire image). Somewhere between 5% to 15% is what most other software tools use to generate a nadir.

![Nadir as percentage of panoramic image height](/example-nadir-percentage-of-pano.jpg)
![Nadir as percentage of panoramic image height](/readme-images/example-nadir-percentage-of-pano.jpg)

The naming convention for outputted images is as follows: [ORIGINAL FILE NAME] _ [NADIR FILE NAME] _ [PERCENTAGE SIZE OF NADIR] pc. [ORIGINAL FILE EXTENSION]. For example; MULTISHOT_9698_000001.jpg > MULTISHOT_9698_000001_nadir_12pc.jpg

And here's what the outputted file looks like looking down when rendered in a panoramic viewer:

![Example cropped output from Nadir Patcher](/example-nadir-pano-result.jpg)
![Example cropped output from Nadir Patcher](/readme-images/example-nadir-pano-result.jpg)

To help you get started here's some examples. You'll find the files used in the [`samples/`](/samples) directory of this repository.

Expand Down Expand Up @@ -117,4 +117,4 @@ We offer community support for all our software on our Campfire forum. [Ask a qu

## License

Nadir Patcher is licensed under a [GNU AGPLv3 License](https://github.com/trek-view/nadir-patcher/blob/master/LICENSE.txt).
Nadir Patcher is licensed under a [GNU AGPLv3 License](/LICENSE.txt).
File renamed without changes
File renamed without changes
Binary file removed samples/input/MULTISHOT_9698_000001.jpg
Binary file not shown.
Binary file removed samples/input/my_custom_nadir.png
Binary file not shown.
Binary file removed samples/output/MULTISHOT_9698_000001_nadir_12pc.jpg
Binary file not shown.
Binary file removed samples/output/MULTISHOT_9698_000001_nadir_5pc.jpg
Binary file not shown.
Binary file removed samples/output/MULTISHOT_9698_000001_nadir_8pc.jpg
Binary file not shown.

0 comments on commit 5d971ee

Please sign in to comment.