Skip to content

Commit 533deef

Browse files
committed
Add docs/settings.md
1 parent c6029c6 commit 533deef

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

docs/settings.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
2+
OMERO.iviewer settings
3+
======================
4+
5+
Max projection byes
6+
-------------------
7+
8+
OMERO limits the size of Z-projections to reduce load on the server.
9+
The limit is defined as the number of bytes of raw pixel data in a Z-stack and
10+
the OMERO.server default is equivalent to 1024 * 1024 * 256 bytes.
11+
For example, a single-channel 8-bit image (1 byte per pixel) of XYZ size
12+
1024 * 1024 * 256 is equal to the default threshold.
13+
14+
To double the limit, use::
15+
16+
$ omero config set omero.pixeldata.max_projection_bytes 536870912
17+
18+
If you wish to set a threshold for iviewer that is *lower* than for the server:
19+
20+
$ omero config set omero.web.iviewer.max_projection_bytes 268435456
21+
22+
NB: Z-projection is not supported for tiled images in OMERO
23+
(Images larger than 2048 * 2048 pixels per plane are tiled in iviewer).
24+
25+
26+
Roi color palette
27+
-----------------
28+
29+
OMERO uses Spectrum Color Picker for selecting ROI colors.
30+
The roi_color_palette option allows you to specify a grid of colors for users to choose for ROIs.
31+
Define rows with brackets, and use commas to separate values. By default, only the first color of each row is shown.
32+
A full grid is shown when the default color picker is hidden (see below)
33+
To define a color palette use::
34+
35+
$ omero config set omero.web.iviewer.roi_color_palette "[rgb(0,255,0)],[darkred,red,pink],[#0000FF]"
36+
37+
To hide the default color picker (and show a grid for the color palette), set show_palette_only to true
38+
You must define a palette and each row can display 4 colors::
39+
40+
$ omero config set omero.web.iviewer.show_palette_only true
41+
42+
43+
Enable mirror
44+
-------------
45+
46+
When working with other images (coregistering MRIs for example), it is necessary to be able to mirror an image.
47+
There is now experimental support for runtime image mirroring. To enable mirroring set enable_mirror to true.
48+
49+
$ omero config set omero.web.iviewer.enable_mirror true
50+
51+
52+
Max active channel
53+
------------------
54+
55+
By default, iviewer limits the maximum number of active channels to 10. Rendering high numbers of channels
56+
at once puts increased load on the server and it is rarely necessary to visualise more channels at once.
57+
If the iviewer is using the [image region microservice](https://github.com/glencoesoftware/omero-ms-image-region)
58+
then it will use the `max-active-channels` configured there, which is also 10 by default.
59+
60+
$ omero config set omero.web.iviewer.max_active_channels 20
61+
62+
63+
ROI page size
64+
-------------
65+
66+
The pagination page size for the ROIs list is 500 by default. Loading larger numbers will take longer.
67+
The pagination is also constrained by the underlying `omero-web` JSON API, so you need to set both these
68+
settings if you want to increase the limit.
69+
70+
$ omero config set omero.web.iviewer.roi_page_size 1000
71+
72+
$ omero config set omero.web.api.max_limit 1000

0 commit comments

Comments
 (0)