Skip to content

Commit

Permalink
add docs about induvidual dataset attributes vs root attributes
Browse files Browse the repository at this point in the history
  • Loading branch information
igorpisarev committed Apr 9, 2018
1 parent 08a57ca commit 4df02d4
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,21 @@ The application expects a path to a directory structured as follows:
...
```

Root attributes are used as defaults for all channels. They can be overridden by setting channel-specific attributes.

Root attributes are used as defaults for all channels. They can be overridden by setting channel-specific attributes.<br/>
`s0`, `s1`, `s2` are standard N5 datasets that represent scale levels for each channel. `s0` corresponds to full resolution.

Example of the `attributes.json` file:
```json
{
"name":"some data",
"scales":[[1,1,1],[2,2,1],[4,4,2],[8,8,4],[16,16,9],[32,32,17]],
"pixelResolution":{"unit":"um","dimensions":[0.097,0.097,0.18]},
"affineTransform":[[1,-0.30,-0.25,0],[0,1.25,0,0],[0,0,0.85,0]]
}
```

Alternatively, scales and pixel resolution can be stored and queried as attributes of individual scale level datasets. The attribute keys for individual values are `downsamplingFactors` and `pixelResolution`. Thus, root attributes or channel group attributes are not mandatory.

### Viewer state

The changes made to the viewer state are saved automatically to `bdv-settings.xml` file in the root N5 directory:
Expand Down

0 comments on commit 4df02d4

Please sign in to comment.