Skip to content

Commit b9fc890

Browse files
committed
Update stitcher README.md and flag usage string
#7
1 parent a964313 commit b9fc890

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

bin/stitch/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ example list of files:
4343
The path to the player-path.json file. This contains the tracked path of the player. Defaults to "./../../output/player-path.json".
4444
- `output string`
4545
The path and filename of the resulting stitched image. Defaults to "output.png".
46+
Supported formats/file extensions: `.png`, `.jpg`, `.dzi`.
4647
- `xmax int`
4748
Right bound of the output rectangle. This coordinate is not included in the output.
4849
- `xmin int`
@@ -58,6 +59,12 @@ To output the 100x100 area that is centered at the origin use:
5859
./stitch -divide 1 -xmin -50 -xmax 50 -ymin -50 -ymax 50
5960
```
6061

62+
To output a [Deep Zoom Image (DZI)](https://en.wikipedia.org/wiki/Deep_Zoom), which can be used with [OpenSeadragon](https://openseadragon.github.io/examples/tilesource-dzi/), use:
63+
64+
``` Shell Session
65+
./stitch -output capture.dzi
66+
```
67+
6168
To start the program interactively:
6269

6370
``` Shell Session

bin/stitch/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import (
2222
var flagInputPath = flag.String("input", filepath.Join(".", "..", "..", "output"), "The source path of the image tiles to be stitched.")
2323
var flagEntitiesInputPath = flag.String("entities", filepath.Join(".", "..", "..", "output", "entities.json"), "The path to the entities.json file.")
2424
var flagPlayerPathInputPath = flag.String("player-path", filepath.Join(".", "..", "..", "output", "player-path.json"), "The path to the player-path.json file.")
25-
var flagOutputPath = flag.String("output", filepath.Join(".", "output.png"), "The path and filename of the resulting stitched image.")
25+
var flagOutputPath = flag.String("output", filepath.Join(".", "output.png"), "The path and filename of the resulting stitched image. Supported formats/file extensions: `.png`, `.jpg`, `.dzi`.")
2626
var flagScaleDivider = flag.Int("divide", 1, "A downscaling factor. 2 will produce an image with half the side lengths.")
2727
var flagBlendTileLimit = flag.Int("blend-tile-limit", 9, "Limits median blending to the n newest tiles by file modification time. If set to 0, all available tiles will be median blended.")
2828
var flagXMin = flag.Int("xmin", 0, "Left bound of the output rectangle. This coordinate is included in the output.")

0 commit comments

Comments
 (0)