= 3d Brain Atlas Reconstructor on-line service =

[[PageOutline(2-3,,inline)]]

== Backend services ==

=== [wiki:barServiceGetAvailableDatasets getAvailableDatasets] ===

Return AJAX data describing CAF datasets (atlases) available to the user in the service.
[wiki:barServiceGetAvailableDatasets See details].

==== Example ====
* http://service.3dbar.org/getAvailableDatasets


=== [wiki:barServiceGetCaf getCaf] ===

Return zip archive containing requested CAF dataset.
[wiki:barServiceGetCaf See details]

==== Example ====
* http://www.3dbar.org:8080/getCaf?cafDatasetName=whs_0.6.1


=== [wiki:barServiceGetCafInfo getCafInfo] ===

Return the index file of selected CAF dataset. Index file contains the list of structures 
available for reconstruction, their hierarchy and the list of slides within the given dataset.
[wiki:barServiceGetCafInfo See details].

==== Examples ====
* http://service.3dbar.org/getCafInfo?cafDatasetName=whs_0.51
* http://service.3dbar.org/getCafInfo?cafDatasetName=whs_0.51;listSlides=False;listStructures=False


=== [wiki:barServiceGetCafSlide getCafSlide] ===

Return an SVG image with CAF slide filtered using provided settings.
[wiki:barServiceGetCafSlide See details].

==== Examples ====
* http://service.3dbar.org/getCafSlide?cafDatasetName=whs_0.51;slideNumber=460
* http://service.3dbar.org/getCafSlide?cafDatasetName=whs_0.51;slideNumber=460;showMask=True;showLabels=False
* http://service.3dbar.org/getCafSlide?cafDatasetName=whs_0.51;slideNumber=460;showLabels=False
* http://service.3dbar.org/getCafSlide?cafDatasetName=sba_DB08;slideNumber=84;structureList=Cx
* http://service.3dbar.org/getCafSlide?cafDatasetName=sba_DB08;slideNumber=84;structureList=Cx,Th


=== [wiki:barServiceGetVolume getVolume] ===

Return zipped labeled NifTi volume containing neuroanatomical information from the requested CAF dataset.
[wiki:barServiceGetVolume See details]

==== Example ====
* http://www.3dbar.org:8080/getVolume?cafDatasetName=whs_0.6.1


=== [wiki:barServiceGetReconstruction getReconstruction] ===

Return a model of a given structure from selected dataset as a zip file containing the
reconstruction and a short description.
[wiki:barServiceGetReconstruction See details].

==== Examples ====
* http://service.3dbar.org/getReconstruction?cafDatasetName=whs_0.51;structureName=thalamus
* http://service.3dbar.org/getReconstruction?cafDatasetName=whs_0.51;structureName=thalamus;qualityPreset=high;outputFormat=vrml


=== [wiki:barServiceGetPreviewReconstruction getPreviewReconstruction] ===

Return a lightweight model of a given structure from selected dataset as an x3d mesh.
[wiki:barServiceGetPreviewReconstruction See details].

==== Examples ====
* http://service.3dbar.org/getPreviewReconstruction?cafDatasetName=whs_0.51;structureName=thalamus
* http://service.3dbar.org/getPreviewReconstruction?cafDatasetName=sba_DB08;structureName=Br


=== [wiki:barServiceGetThumbnail getThumbnail] ===

Return a thumbnail of the reconstruction of a given structure available via
`getReconstruction` in png format.
[wiki:barServiceGetThumbnail See details].

==== Examples ====
* http://service.3dbar.org/getThumbnail?cafDatasetName=whs_0.51;structureName=corpus-callosum
* http://service.3dbar.org/getThumbnail?cafDatasetName=whs_0.51;structureName=thalamus
* http://service.3dbar.org/getThumbnail?cafDatasetName=whs_0.51;structureName=CNS
* http://service.3dbar.org/getThumbnail?cafDatasetName=sba_DB08;structureName=FL
* http://service.3dbar.org/getThumbnail?cafDatasetName=sba_DB08;structureName=LV
* http://service.3dbar.org/getThumbnail?cafDatasetName=sba_PHT00;structureName=Brain


=== [wiki:barServiceQueryReconstruction queryReconstruction] ===

Return AJAX data describing reconstructions in the service matching the criteria.
[wiki:barServiceQueryReconstruction See details].

==== Examples ====
* http://service.3dbar.org/queryReconstruction?cafDatasetName=sba_DB08;structureList=Br;outputFormats=exportToVRML
* http://service.3dbar.org/queryReconstruction?cafDatasetName=whs_0.6.1;structureList=Brain;outputFormats=exportToVRML,exportToX3d;pipeline=whs_0.6.1-LQ;resolution=0.043,0.043
* http://service.3dbar.org/queryReconstruction?cafDatasetName=sba_DB08;structureList=Amg;switches=brainoutline;outputFormats=exportToVRML,exportToX3d,exportScreenshot


=== [wiki:barServiceGetReconstructionByKey getReconstructionByKey] ===

Return reconstruction (stored in the service) of a given service identifier. The identifier can be obtained using 'queryReconstruction' service.
[wiki:barServiceGetReconstructionByKey See details].

==== Example ====
* http://service.3dbar.org/getReconstructionByKey?id=26721


=== [wiki:barServiceGetThumbnailByKey getThumbnailByKey] ===

Return a thumbnail of reconstruction (stored in the service) of a given service identifier in png format.
[wiki:barServiceGetThumbnailByKey See details].

==== Example ====
* http://service.3dbar.org/getThumbnailByKey?id=12064



== Frontend services ==

=== [wiki:barServiceGetPreview getPreview] ===

Display a window allowing to manipulate (rotate, zoom, etc.) lightweight version of the reconstuciton.
Note that the web browser has to support [[http://en.wikipedia.org/wiki/WebGL|WebGL]] in order
to use this feature.
[wiki:barServiceGetPreview See details].

==== Examples ====
* http://service.3dbar.org/getPreview?cafDatasetName=whs_0.51&structureName=CNS
* http://service.3dbar.org/getPreview?cafDatasetName=whs_0.5&structureName=Hc
* http://service.3dbar.org/getPreview?cafDatasetName=sba_DB08&structureName=FBr


=== [wiki:barServiceGetCafInfoPage getCafInfoPage] ===

Display a window containing basic information about CAF dataset.
[wiki:barServiceGetCafInfoPage See details].

==== Examples ====
* http://service.3dbar.org/getCafInfoPage?cafDatasetName=sba_DB08



=== [wiki:barServiceQueryJob queryJob] ===

Display a window containing information about a reconstruction job of requested
identifier - and about other reconstruction jobs requested for the same CAF dataset.
[wiki:barServiceQueryJob See details].

==== Examples ====
* http://service.3dbar.org/queryJob?id=22