Changes between Version 1 and Version 2 of barServiceGetCafSlide

Timestamp:

04/01/11 16:25:21 (13 years ago)

Author:

jkowalski

Comment:

--

barServiceGetCafSlide

@@ -7 +7 @@
 Returns a SVG image with CAF slide filtered by provided settings.
 
-syntax:
+syntax::
 {{{
 getCafSlide?cafDatasetName=<dataset name>
@@ -15 +15 @@
           [;showMask=(True|False)]
 }}}
+
+==== Required arguments ====
+* cafDatasetName::
+          The name of the selected CAF dataset.
+      
+* slideNumber::
+          Number of the CAF slide according to 'slideindex' section of CAF index
+          file.
+      
+==== Optional arguments ====
+* structureList::
+          Comma-separated List of structures, if provided only structures from
+          the list are included in returned CAF slide. If not specified, the
+          returned CAF slide contains all structures.
+      
+* showLabels::
+          Indicates if labels are to be included in the generated slide. Can be set to
+          'True' or 'False'. 'True' by default.
+      
+* showMask::
+          If True, provides black & white mask of the slide and forces labels to
+          be removed. 'False' by default.
+        
+==== Examples ====
+*      http://212.87.16.231:8080/getCafSlide?cafDatasetName=whs_0.51&slideNumber=460
+*      http://212.87.16.231:8080/getCafSlide?cafDatasetName=whs_0.51&slideNumber=460&showMask=True&showLabels=False
+      http://212.87.16.231:8080/getCafSlide?cafDatasetName=whs_0.51&slideNumber=460&showLabels=False
+
+