Dataset
Central object for accessing one NimbusImage dataset.
nimbusimage.dataset.Dataset
Access point for a single NimbusImage dataset.
Metadata is fetched lazily on first access to any property.
info_url()
URL for the dataset info page.
view_url(xy=None, z=None, time=None, layer=None, unroll_xy=None, unroll_z=None, unroll_t=None)
URL for the dataset image viewer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
xy
|
int | None
|
XY position to navigate to. |
None
|
z
|
int | None
|
Z-slice to navigate to. |
None
|
time
|
int | None
|
Time point to navigate to. |
None
|
layer
|
str | None
|
Layer mode ('single', 'multiple', 'unroll'). |
None
|
unroll_xy
|
bool | None
|
Unroll XY dimension. |
None
|
unroll_z
|
bool | None
|
Unroll Z dimension. |
None
|
unroll_t
|
bool | None
|
Unroll time dimension. |
None
|
Returns:
| Type | Description |
|---|---|
str
|
URL string for the image viewer. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If no dataset view exists for this dataset. |
configuration_url()
URL for this dataset's configuration page.
open(xy=None, z=None, time=None, **kwargs)
Open the dataset viewer in the default browser.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
xy, z, time
|
Navigate to this position. |
required | |
**kwargs
|
Additional args passed to view_url(). |
{}
|
Returns:
| Type | Description |
|---|---|
str
|
The URL that was opened. |