Skip to content
This repository was archived by the owner on Feb 26, 2025. It is now read-only.

Commit 134be2e

Browse files
authored
Update README.md
1 parent 81ff4d4 commit 134be2e

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

flatmap/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,19 +48,20 @@ As part of the workflow:
4848

4949
1. Change directory to `applications/flatview_3d_data`.
5050
2. Run `make FLATVIEW_DATA_INPUT_FILE="<path to input data>"`.
51-
3. Extra arguments to `flatplot` can be passed in `FLATPLOT_DATA_EXTRA`.
51+
3. Extra arguments to `flatplot` can be passed in the variable `FLATPLOT_DATA_EXTRA`.
5252
4. Find output image under `output/`.
5353

5454
Stand-alone:
5555

56-
1. Run `$ATLAS_ENHANCEMENT_ROOT/flatmap/code/bin/flatplot <flatmap NRRD> <data NRRD> <output prefix>`.
57-
2. Some common options are:
56+
1. The [flatplot](code/utils/flatplot.py) script can be found in `$ATLAS_ENHANCEMENT_ROOT/flatmap/code/utils/flatplot.py`.
57+
2. Run it like `flatplot <flatmap NRRD> <data NRRD> <output prefix>`.
58+
3. Some common options are:
5859
+ `--flatpix`: specify pixel resolution of output image
5960
+ `--autospan`: get value range from data, instead of [0,1]
6061
+ `--colormap`: set color map from `colorcet` as `cet:*`, from `seaborn` as `sns:*`, from `cmcrameri` as `cmc:*`, or as a comma-separated list of hexadecimal RGB colors (`#XXXXXX`)
6162
+ `--reduction`: specify aggregation function, e.g. `max`, `mean`, etc.
6263
+ `--layers`: path to layers NRRD (1-based integers), to be used with `--split` to plot each layer separately, or `--only-layer` to plot a specific layer.
63-
4. For full CLI options, run `flatplot` with no arguments.
64+
4. For full CLI options, run `flatplot --help`.
6465

6566
### Input file requirements
6667

0 commit comments

Comments
 (0)