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 |
||
|
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 |
||
|
ID of the model holding an atlas volume |
|
type |
integer |
|
minimum |
0 |
|
additionalProperties |
False |
Result:
type |
array |
||
items |
UseCaseMessage |
||
type |
object |
||
properties |
|||
|
Use case name |
||
type |
string |
||
|
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 |
||
|
ID of the model holding an atlas volume |
|
type |
integer |
|
minimum |
0 |
|
|
Additional use case parameters |
|
|
Use case name |
|
type |
string |
|
additionalProperties |
False |
Result:
type |
object |
||||
properties |
|||||
|
Bounds |
||||
Model bounds |
|||||
type |
object |
||||
properties |
|||||
|
Top front right corner XYZ |
||||
type |
array |
||||
items |
type |
number |
|||
maxItems |
3 |
||||
minItems |
3 |
||||
|
Bottom back left corner XYZ |
||||
type |
array |
||||
items |
type |
number |
|||
maxItems |
3 |
||||
minItems |
3 |
||||
additionalProperties |
False |
||||
|
ModelInfo |
||||
Model-specific info |
|||||
type |
object |
||||
properties |
|||||
|
Transform |
||||
Model transform |
|||||
type |
object |
||||
properties |
|||||
|
Rotation XYZW |
||||
type |
array |
||||
items |
type |
number |
|||
maxItems |
4 |
||||
minItems |
4 |
||||
|
Scale XYZ |
||||
type |
array |
||||
items |
type |
number |
|||
maxItems |
3 |
||||
minItems |
3 |
||||
|
Translation XYZ |
||||
type |
array |
||||
items |
type |
number |
|||
maxItems |
3 |
||||
minItems |
3 |
||||
additionalProperties |
False |
||||
|
LoadInfo |
||||
Model load info |
|||||
type |
object |
||||
properties |
|||||
|
Loader settings |
||||
|
Loader name |
||||
type |
string |
||||
|
File path in case of file load type |
||||
type |
string |
||||
|
Model load source |
||||
type |
string |
||||
enum |
from_file, from_blob, none |
||||
additionalProperties |
False |
||||
|
Model-specific metadata |
||||
type |
object |
||||
additionalProperties |
type |
string |
|||
additionalProperties |
False |
||||
|
Wether the model is being rendered or not |
||||
type |
boolean |
||||
|
Model ID |
||||
type |
integer |
||||
minimum |
0 |
||||
|
Model type |
||||
type |
string |
||||
|
Transform |
||||
Model transform |
|||||
type |
object |
||||
properties |
|||||
|
Rotation XYZW |
||||
type |
array |
||||
items |
type |
number |
|||
maxItems |
4 |
||||
minItems |
4 |
||||
|
Scale XYZ |
||||
type |
array |
||||
items |
type |
number |
|||
maxItems |
3 |
||||
minItems |
3 |
||||
|
Translation XYZ |
||||
type |
array |
||||
items |
type |
number |
|||
maxItems |
3 |
||||
minItems |
3 |
||||
additionalProperties |
False |
||||
additionalProperties |
False |