Changes between Initial Version and Version 1 of barServiceQueryReconstruction

Timestamp:

03/07/12 15:58:08 (14 years ago)

Author:

jkowalski

Comment:

--

barServiceQueryReconstruction

@@ +1 @@
+=== [wiki:barServiceQueryReconstruction queryReconstruction] ===
+
+Return AJAX data describing reconstructions in the service matching the criteria.
+
+ syntax::
+{{{
+queryReconstruction?cafDatasetName=<dataset identifier>
+                   ;structureList=<structure name>
+                   ;outputFormats=<output format list>
+                  [;resolution=<resolution>]
+                  [;pipeline=<pipeline name>]
+                  [;switches=<switches list>]
+}}}
+
+==== Required arguments ====
+* cafDatasetName
+          The service identifier of the selected CAF dataset.
+
+       
+* structureName
+          Name of structure from hierarchy tree. In practice nearly all names
+          should be fine. Formally name has to point to a root node of a subtree
+          containing at least one node with representation among paths in CAF
+          slides.
+
+* outputFormats
+          Nonempty coma-separated list of reconstruction file format descriptors.
+          Allowed format descriptors are:
+            - exportToVRML:: VRML files,
+            - exportToX3d:: X3D files,
+            - exportToPOVRay:: POV-Ray files,
+            - exportToNiftii:: NIfTI files
+            - exportToVTKPolydata:: vtk polydata files,
+            - exportToNumpy:: NumPy array files,
+            - exportToVolume:: vtk structured grid files,
+            - exportScreenshot:: PNG images,
+            - exportThumbnail:: PNG thumbnails.
+
+==== Optional arguments ====
+* resolution
+          Coronal and anterior-posterior voxel size separated with a coma.
+
+* pipeline
+          Name of the pipeline the reconstructions has been generated with.
+
+* switches
+          Nonempty coma-separated list of switches:
+            - brainoutline:: match only structures containing the outline of hierarchy tree root structure; forces 'composite' switch,
+            - composite:: only scene format descriptors ('exportToVRML', 'exportToX3d', 'exportToPOVRay', 'exportScreenshot', 'exportThumbnail') in the 'outputFormats' list. 
+
+==== AJAX data type ====
+{{{
+[{
+   String: String,
+   String: String,
+   String: Boolean,
+   String: String,
+   String: String,
+   String: Number,
+   String: String,
+   String: [Number, Number, String],
+   String: Number | null   
+ },
+ ...]
+}}}
+      
+==== AJAX data description ====
+
+The data is provided in format:
+{{{
+[{
+   'CAFSlideUnits': <unit>,
+   'status': <status>,
+   'compressed': <compressed>,
+   'groups': <groups>,
+   'format': <format>,
+   'cacheID': <id>,
+   'groupsID': <groups id>,
+   'quality': [<xyres>, <zres>, <pipeline name>],
+   'size': <size>   
+ },
+ ...]
+}}}
+
+
+==== 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