Atlas Explorer API

This page references the loaders and entrypoints registered by the Atlas Explorer plugin.

Loaders

NRRD loader

Can load the following formats: .nrrd.

This loader does not support loading binary data using ‘upload-model’.

type	object
properties
type	Voxel type to interpret the atlas being loaded
	type	string
	enum	scalar, orientation, flatmap, layer_distance
additionalProperties	False

Entrypoints

get-available-atlas-usecases

Returns a list of available atlas visualization usecases for the given model.

Params:

type	object
properties
model_id	ID of the model holding an atlas volume
	type	integer
	minimum	0
additionalProperties	False

Result:

type	array
items	UseCaseMessage
	type	object
	properties
	name	Use case name
		type	string
	params_schema	JsonSchema
		Use case parameters schema
		type	object
	additionalProperties	False

---

visualize-atlas-usecase

Visualizes the specified use case based on the atlas data of the given model.

Params:

type	object
properties
model_id	ID of the model holding an atlas volume
	type	integer
	minimum	0
params	Additional use case parameters
use_case	Use case name
	type	string
additionalProperties	False

Result:

type	object
properties
bounds	Bounds
	Model bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
info	ModelInfo
	Model-specific info
	type	object
	properties
	base_transform	Transform
		Model transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	load_info	LoadInfo
		Model load info
		type	object
		properties
		load_parameters	Loader settings
		loader_name	Loader name
			type	string
		path	File path in case of file load type
			type	string
		source	Model load source
			type	string
			enum	from_file, from_blob, none
		additionalProperties	False
	metadata	Model-specific metadata
		type	object
		additionalProperties	type	string
	additionalProperties	False
is_visible	Wether the model is being rendered or not
	type	boolean
model_id	Model ID
	type	integer
	minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False