wiki:barServiceQueryReconstruction

Version 3 (modified by jkowalski, 13 years ago) (diff)

--

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

Service identifier 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: [Number, Number, String],
   String: String,
   String: Boolean,
   String: String,
   String: Number,
   String: Number | null,
   String: String,
   String: String
 },
 ...]

AJAX data description

The data is provided in format: 

[{
   'groups': <groups>,
   'quality': [<xyres>, <zres>, <pipeline name>],
   'format': <format>,
   'compressed': <compressed>,
   'status': <status>,
   'cacheID': <id>,
   'size': <size>,
   'groupsID': <groups id>,
   'CAFSlideUnits': <unit>
 },
 ...]

where:

<groups>
is a string composed of reconstructed groups names separated with '_' character; if an outline is present in the reconstruction, its name precedes others and is separated with double '_' character,

Examples

friendster counter