siibra.explorer.url

Module Contents

Classes

DecodedUrl

Functions

append_query_params(url, *args[, query_params])
decode_url(url[, vp_length])
encode_url(atlas, space, parc[, region, root_url, ...])
get_hash(full_string)
get_perspective_zoom(atlas, space, parc, region)
get_zoom(atlas, space, parc, region)
sanitize_id(id)

Attributes

default_root_url
max_int32
min_int32
supported_prefix

exception siibra.explorer.url.DecodeNavigationException

Common base class for all non-exit exceptions.

class siibra.explorer.url.DecodedUrl

bounding_box: siibra.locations.BoundingBox

siibra.explorer.url.append_query_params(url: str, *args, query_params={}, **kwargs)

siibra.explorer.url.decode_url(url: str, vp_length=1000)

siibra.explorer.url.encode_url(atlas: siibra.core.atlas.Atlas, space: siibra.core.space.Space, parc: siibra.core.parcellation.Parcellation, region: siibra.core.region.Region | None = None, *, root_url=default_root_url, external_url: str = None, location: siibra.locations.Point = None, feature: siibra.features.feature.Feature = None, ignore_warning=False, query_params={})

siibra.explorer.url.get_hash(full_string: str)

siibra.explorer.url.get_perspective_zoom(atlas: siibra.core.atlas.Atlas, space: siibra.core.space.Space, parc: siibra.core.parcellation.Parcellation, region: siibra.core.region.Region | None)

siibra.explorer.url.get_zoom(atlas: siibra.core.atlas.Atlas, space: siibra.core.space.Space, parc: siibra.core.parcellation.Parcellation, region: siibra.core.region.Region | None)

siibra.explorer.url.sanitize_id(id: str)

siibra.explorer.url.default_root_url = 'https://atlases.ebrains.eu/viewer/'

siibra.explorer.url.max_int32 = 2147483647

siibra.explorer.url.min_int32

siibra.explorer.url.supported_prefix = ('nifti://', 'swc://', 'precomputed://', 'deepzoom://')