|
1 | | -# Dataset Settings |
2 | | -You can configure the metadata, permission, and other properties of a dataset at any time. |
| 1 | +# Dataset Settings |
3 | 2 |
|
4 | | -Note, any changes made to a dataset may influence the user experience of all users in your organization working with that dataset, e.g., removing access rights working, adding/removing layers, or setting default values for rendering the data. |
| 3 | +You can configure the metadata, permission, and other properties of a dataset at any time. To make changes, click on the **Settings** action next to a dataset in the **Datasets** tab of your dashboard. |
5 | 4 |
|
6 | | -To make changes, click on the "Settings" action next to a dataset in the "Datasets" tab of your dashboard. |
7 | | -Editing these settings requires your account to have enough access rights and permissions. [Read more about this.](../users/access_rights.md) |
| 5 | +Note that any changes made to a dataset may influence the user experience of all users in your organization working with that dataset, e.g., removing access rights, adding/removing layers, or setting default values for rendering the data. |
8 | 6 |
|
9 | | -## Data Tab |
10 | | -The *Data* tab contains the settings for correctly reading the dataset as the correct data type (e.g., `uint8`), setting up, and configuring any layers. |
| 7 | +Editing these settings requires your account to have sufficient access rights and permissions. [Read more about this.](../users/access_rights.md) |
11 | 8 |
|
12 | | -- `Name`: The name of the dataset. Datasets can have duplicate names even within the same organization. |
13 | | -- `Voxel Size`: The physical size of a voxel in the configured unit, e.g., `11, 11, 24` |
14 | | -- `Unit`: The unit of the voxel size. |
| 9 | +## Data Source Tab |
15 | 10 |
|
16 | | -For each detected layer: |
| 11 | +The `Data Source` tab contains the core settings for your dataset. |
17 | 12 |
|
18 | | -- `Bounding Box`: The position and extents of the dataset layer in voxel coordinates. The format is `x, y, z, x_size,y_size, z_size` or respectively `min_x, min_y, min_z, (max_x - min_x), (max_y - min_y), (max_z - min_z)`. |
19 | | -- `Largest Segment ID`: The highest ID that is currently used in a segmentation layer. When a user wants to annotate a new segment and clicks "Create new Segment Id" in the toolbar, the new ID is generated by incrementing the currently known largest segment id. This value is stored per annotation and is based on the corresponding property of the underlying dataset layer. If the id is not known, the user cannot generate new segment ids. However, they can still change the currently active ID to arbitrary values. Also, they can enter a largest segment id for their annotation without having to edit the dataset's value here (which they might not have the permissions for). |
| 13 | +### General Dataset Settings |
20 | 14 |
|
21 | | -The `Advanced` view lets you edit the underlying [JSON configuration](../data/concepts.md#dataset-metadata) directly. Toggle between the `Advanced` and `Simple` page in the upper right. Advanced mode is only recommended for low-level access to dataset properties and users familiar with the `datasource-properties.json` format. |
| 15 | +- **Name:** The name of the dataset. This is also the display name that will be shown in the UI. |
| 16 | +- **Dataset ID:** A unique identifier for the dataset (read-only). |
| 17 | +- **Voxel Size:** The physical size of a voxel in the configured unit (e.g., `11, 11, 24`). |
| 18 | +- **Unit:** The unit of the voxel size (e.g., `nm`). |
22 | 19 |
|
23 | | -WEBKNOSSOS automatically periodically checks and detects changes to a dataset's metadata (`datasource-properties.json`) on disk (only relevant for self-hosted instances). Before applying these suggestions, users can preview all the new settings (as JSON) and inspect just the detected difference (as JSON). |
| 20 | +### Axis Rotation |
24 | 21 |
|
25 | | - |
| 22 | +You can rotate the dataset around the X, Y, and Z axes. You can also mirror the axes. |
26 | 23 |
|
| 24 | +### Layer Settings |
27 | 25 |
|
28 | | -## Sharing & Permissions Tab |
29 | | -- `Make dataset publicly accessible`: By default, a dataset can only be accessed by users from your organization with the correct access permissions. Turning a dataset to *public* will allow anyone in the general public to view the dataset when sharing a link to the dataset without the need for a WEBKNOSSOS account. Anyone can start using this dataset to create annotations. Enable this setting if you want to share a dataset in a publication, social media, or any other public website. |
30 | | -- `Teams allowed to access this dataset`: Defines which [teams of your organization](../users/teams.md) have permission to work with this dataset. By default, no team has access, but users with *admin* and *team manager* roles can see and edit the dataset. |
31 | | -- `Sharing Link`: A web URL pointing to this dataset for easy sharing that allows any user to view your dataset. The URL contains an access token to allow people to view the dataset without a WEBKNOSSOS account. The access token is random, and therefore the URL cannot be guessed by visitors. You may also revoke the access token to create a new one. Anyone with a URL containing a revoked token will no longer have access to this dataset. |
32 | | -Read more in [the Sharing guide](../sharing/dataset_sharing.md). |
| 26 | +For each layer in the dataset, you can configure: |
33 | 27 |
|
34 | | - |
| 28 | +- **Name:** The name of the layer. |
| 29 | +- **Bounding Box:** The position and extents of the layer in voxel coordinates. The format is `x, y, z, x_size,y_size, z_size` or respectively `min_x, min_y, min_z, (max_x - min_x), (max_y - min_y), (max_z - min_z)`. |
| 30 | +- **Category:** The type of the layer, i.e. `color` for raw microscopy data and `segmentation` for segmentations. |
| 31 | +- **Largest Segment ID**: (Segmentation layer only). The highest ID that is currently used in a segmentation layer. When a user wants to annotate a new segment and clicks "Create new Segment Id" in the toolbar, the new ID is generated by incrementing the currently known largest segment id. This value is stored per annotation and is based on the corresponding property of the underlying dataset layer. If the id is not known, the user cannot generate new segment ids. However, they can still change the currently active ID to arbitrary values. Also, they can enter a largest segment id for their annotation without having to edit the dataset's value here (which they might not have the permissions for). |
35 | 32 |
|
36 | | -## Metadata Tab |
37 | | -- `Display Name`: A meaningful name for a dataset other than its (automatically assigned) technical name which is usually limited by the naming rules of file systems. It is displayed in various parts of WEBKNOSSOS. The display name may contain special characters and can also be changed without invalidating already created sharing URLs. It can also be useful when sharing datasets with outsiders while "hiding" any internal naming schemes or making it more approachable, e.g., `L. Simpson et al.: Full Neuron Segmentation` instead of `neuron_seg_v4_2022`. |
38 | | -- `Description`: A free-text field for providing more information about your datasets, e.g., authors, paper reference, descriptions, etc. Supports Markdown formatting. The description will be featured in the WEBKNOSSOS UI when opening a dataset in view mode. |
| 33 | +### Advanced View |
39 | 34 |
|
40 | | - |
| 35 | +The `Advanced` view lets you edit the underlying [JSON configuration](../data/concepts.md#dataset-metadata) directly. This is only recommended for users familiar with the `datasource-properties.json` format. |
| 36 | + |
41 | 37 |
|
42 | | -## View Configuration Tab |
43 | | -The *View configuration* tab lets you set defaults for viewing this dataset. Anytime a user opens a dataset or creates a new annotation based on this dataset, these default values will be applied. |
| 38 | +## Sharing & Permissions Tab |
| 39 | + |
| 40 | +This tab allows you to control who can access your dataset. |
44 | 41 |
|
45 | | -Defaults include: |
| 42 | +- **Make dataset publicly accessible:** By default, a dataset can only be accessed by users from your organization with the correct access permissions. Turning a dataset to *public* will allow anyone to view the dataset with a sharing link, without needing a WEBKNOSSOS account. |
| 43 | +- **Additional team access permissions for this dataset:** Defines which [teams of your organization](../users/teams.md) have permission to work with this dataset. |
| 44 | +- **Sharing Link:** A URL to share the dataset with others. You can renew the access token to invalidate the old link. |
| 45 | +- **Users with access permission to work with this dataset:** A list of all users that have access to the dataset. |
| 46 | + |
| 47 | +Read more in [the Sharing guide](../sharing/dataset_sharing.md). |
46 | 48 |
|
47 | | -- `Position`: Default position of the dataset in voxel coordinates. When opening the dataset, users will be located at this position. |
48 | | -- `Zoom`: Default zoom. |
49 | | -- `Interpolation`: Whether interpolation should be enabled by default. |
50 | | -- `Layer Configuration`: Advanced feature to control the default settings on a per-layer basis. It needs to be configured in JSON format. E.g., layer visibility & opacity, color, contrast/brightness/intensity range ("histogram sliders"), and many more. |
| 49 | + |
51 | 50 |
|
52 | | - |
| 51 | +## Metadata Tab |
53 | 52 |
|
54 | | -Alternatively, these settings can be configured in a more intuitive way by opening the dataset in view mode. Change the current view settings to the desired result and save them as the dataset's default using the "Save View Configuration as Default" button in the layer settings tab. |
| 53 | +This tab allows you to add descriptive information to your dataset. |
55 | 54 |
|
56 | | - |
| 55 | +- **Publication Date:** The date the dataset was published. This influences the dataset ordering in your dashboard. |
| 56 | +- **Description:** A free-text field for providing more information about your dataset, such as authors, paper references, etc. It supports Markdown formatting. |
57 | 57 |
|
58 | | -Of course, the defaults can all be overwritten and adjusted once a user opens the dataset in the main WEBKNOSSOS interface and makes changes to any of these settings in his viewports. |
| 58 | + |
59 | 59 |
|
60 | | -For self-hosted WEBKNOSSOS instances, there are three ways to set default *View Configuration* settings: |
| 60 | +## View Configuration Tab |
61 | 61 |
|
62 | | -- in the web UI as described above |
63 | | -- while viewing the dataset |
64 | | -- inside the `datasource_properties.json` on disk |
| 62 | +The `View Configuration` tab lets you set the default viewing parameters for this dataset. These defaults will be applied whenever a user opens the dataset for the first time. |
65 | 63 |
|
66 | | -The *View Configuration* from the web UI takes precedence over the `datasource_properties.json`. |
67 | | -You don't have to set complete *View Configurations* in either option, as WEBKNOSSOS will fill missing attributes with sensible defaults. |
| 64 | +- **Position, Zoom, and Rotation:** Set the default camera position, zoom level, and rotation. |
| 65 | +- **Rendering Options:** Configure default rendering settings like `Interpolation`, `4 Bit` rendering, and `Blend Mode`. |
| 66 | +- **Layer Configuration:** An advanced feature to control the default settings on a per-layer basis using a JSON object. You can configure properties like visibility, opacity, color, and intensity range. |
68 | 67 |
|
| 68 | +Alternatively, you can set the default view configuration from the main annotation view by clicking the "Save View Configuration as Default" button in the layer settings. |
69 | 69 |
|
70 | 70 | ## Delete Tab |
71 | 71 |
|
72 | | -Offers an option to delete a dataset and completely remove it from WEBKNOSSOS. Be careful, this cannot be undone! |
| 72 | +This tab offers an option to delete the dataset. This action is irreversible and will permanently remove the dataset from WEBKNOSSOS. |
73 | 73 |
|
74 | | -When other datasets reference layers from this dataset, WEBKNOSSOS will try to move these layers to the dataset they are referenced in, so that it can still be accessed. |
| 74 | +Deleting an dataset will not delete any annotations associated with it. |
75 | 75 |
|
76 | | - |
| 76 | + |
0 commit comments