Changes between Version 7 and Version 8 of barSoftwareCLI


Ignore:
Timestamp:
01/23/12 11:10:18 (13 years ago)
Author:
jkowalski
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • barSoftwareCLI

    v7 v8  
    99   
    1010  Usage: ./batchinterface.sh [options] <CAF index> [<structure 1> [<structure 2> ...]] 
    11   3d Brain Atlas Reconstructor ver. 0.1 Batch reconstruction interface 
    12    
     11 
     12  3d Brain Atlas Reconstructor ver.ver. 0.1 Batch reconstruction interface 
     13 
    1314  Options: 
    14   -h, --help            show this help message and exit 
    15   -g GENERATESUBSTRUCTURES, --generateSubstructures=GENERATESUBSTRUCTURES 
    16                         maximum level of substructures (in the structure tree) 
    17                         to be generated; default: 0 
    18   -d VOXELDIMENSIONS, --voxelDimensions=VOXELDIMENSIONS 
    19                         voxel size (in units defined in given dataset) in slide plane 
    20                         and in plane perpendicular to the slides, consecutively. 
    21   -e EXPORTDIR, --exportDir=EXPORTDIR 
    22                         the path to a directory for reconstructions 
    23   -p PIPELINE, --usePipeline=PIPELINE 
    24                         the path to a custom pipeline definition 
    25   -v CAMERA, --useViewport=CAMERA 
    26                         the direction vector from the center of the scene to 
    27                         the camera position 
    28   --exportToWindow, --show 
    29                         the reconstruction is displayed to the user 
    30   --composite           perform a reconstruction of the structure as a scene 
    31                         composed of the reconstructions of the basic 
    32                         substructures in the hierarchy tree (up to the maximum 
    33                         given tree depth, see -g switch) 
    34   --includeBrainOutline 
    35                         Includes additional translucent brain outline to the 
    36                         reconstructions. Applies only when exporting to VRML, 
    37                         X3D, screenshot or thumbnail. 
     15    --version             show program's version number and exit 
     16    -h, --help            show this help message and exit 
     17    -g GENERATESUBSTRUCTURES, --generateSubstructures=GENERATESUBSTRUCTURES 
     18                          maximum level of substructures (in the structure tree) 
     19                          to be generated; defaults to 0 
     20    -d VOXELDIMENSIONS, --voxelDimensions=VOXELDIMENSIONS 
     21                          voxel size [mm] (in coronal plane, along anterior- 
     22                          posterior axis) 
     23    -e EXPORTDIR, --exportDir=EXPORTDIR 
     24                          the path to a directory for reconstructions 
     25    -p PIPELINE, --usePipeline=PIPELINE 
     26                          the path to a custom pipeline definition 
     27    -a CAMERAMOVEMENTANGLES, --cameraMovementAngles=CAMERAMOVEMENTANGLES 
     28                          camera movement angles (azimuth, elevation, roll) 
     29    -b BACKGROUND, --background=BACKGROUND 
     30                          RGB background colourcomponents (within 0.0-255.0 
     31                          range) 
     32    --exportToWindow, --show 
     33                          the reconstruction is displayed to the user 
     34    --composite           perform a reconstruction of the structure as a scene 
     35                          composed of the reconstructions of the basic 
     36                          substructures in the hierarchy tree (up to the maximum 
     37                          given level) 
     38    --includeBrainOutline 
     39                          Includes additional translucent brain outline to the 
     40                          reconstructions. Applies only when exporting to VRML, 
     41                          X3D or thumbnail. 
     42    --ignoreBoundingBox   Overrides bounding box calculation - bounding 
     43                          box will be always equal to hierarchy root element 
     44                          bounding box. Volumes for all structures will always 
     45                          have the same size and origin. This feature increases 
     46                          memory usage and reconstruction time. 
    3847 
    39   Output Format Options: 
    40     --exportToX3d       exports as X3D scene 
    41     --exportToVRML      exports as VRML scene 
    42     --exportToVTKPolydata 
    43                         exports as vtkPolyData 
    44     --exportToVolume    exports as vtkStructuredPoints 
    45     --exportToNifti     exports as NIfTI file 
    46     --exportToNumpy     exports as NumPy array 
    47     --exportScreenshot  saves screenshot as an PNG image 
    48     --exportThumbnail   saves scaled screenshot as an PNG image 
     48    Output Format Options: 
     49      --exportToX3d       exports as X3D scene 
     50      --exportToVRML      exports as VRML scene 
     51      --exportToPOVRay    exports to POV-Ray 
     52      --exportToVTKPolydata 
     53                          exports as VTKpolyMesh 
     54      --exportToVolume    exports as VTKstructGrid 
     55      --exportToNiftii    exports as Niftii file 
     56      --exportToNumpy     exports as Numpy array 
     57      --exportScreenshot  saves screenshot as an PNG image 
     58      --exportThumbnail   saves scaled screenshot as an PNG image 
    4959}}} 
    5060 
     
    5767}}} 
    5868 
    59 By default, the reconstructions generated using a predefined pipeline and stored in directory parallel to the CAF dataset directory (in this example it would be `~/atlases/mouse/reconstructions/`). However, this behavior can be customized using various switches.  
     69By default, the reconstructions of requested structures generated with predefined voxel dimensions, pipeline and camera position and stored in directory parallel to the CAF dataset directory (in this example it would be `~/atlases/mouse/reconstructions/`). However, this behavior can be customized with commandline options.  
    6070 
friendster counter