User Tools

Site Tools


jvs:fscan:manual:chapter2:roi

This is an old revision of the document!


fScan Reference Manual, Chapter 2 (CmdLineOptions): roi

ROI -- Define and manipulate Regions of Interest

usage:

Adding new ROIs

  • -roi POINT [NAME] x y z
  • -roi BLOCK [NAME] x0 y0 z0 nx ny nz
  • -roi BLOCK [NAME] x0 y0 nx ny
  • -roi BLOCK [NAME] x0 nx
  • -roi CIRCLE [NAME] x0 y0 z0 rad
  • -roi CIRCLE [NAME] x0 y0 rad
  • -roi CIRCLE [NAME] x0 y0 z0 radx rady radz
  • -roi ARROW [NAME] x0 y0 z0 x1 y1 z1
  • -roi ARROW [NAME] x0 y0 x1 y1
  • -roi ARROW [NAME] x0
  • -roi TEXT [NAME] textstring x0 y0 z0 x1 y1 z1
  • -roi TEXT [NAME] textstring x0 y0 x1 y1
  • -roi MASK datasetname
  • -roi FILE roifile
  • -roi RX refimage (not yet implemented)
  • -roi MEAN flag

Generate ROI correlations

  • -roi CORREL flag refROI binsize corrROI name thresh

Cluster ROIs

  • -roi CLUSTER refimage flag name
  • -roi MERGE refimage flag name minvalley minsize mindist

Generate ROI statistics

  • -roi STATS refimage flag showflag mode name value nlevels level0 dlevel
  • -roi STATS refimage flag showflag mode name value cycleleng cycleoff thresh

Modifying ROIs

The RX type of ROI (when implemented) creates a slice prescription ROI on the current data set based on slice orientation in REFIMAGE.

The CLUSTER type ROI assumes that the current data set is an ROI mask image (in which regions are defined by voxels with the same intensity value). The CLUSTER command uses the input mask image to create an ROI list (name=NAME) of CLUSTER type ROIs where each cluster is defined by its mask value. For each CLUSTER, the center-of-mass location and the radius along the 3 principal axes are stored. By default, the new ROI list is attached to the input mask data set.

  • REFIMAGE, find peak intensity value and voxel location.
  • FLAG: (no values yet)
  • NAME: name of ROI list. If omitted, the list is linked to input mask images.

For manipulating existing ROIs:

The ROI command can also be used to manipulate existing ROI's.

-roi CLUSTER refimage flag name

	Assumes roi mask image as input.
Create an ROI list (name=NAME) of clusters where each
  cluster is defined by its mask value. For each cluster,
  store center-of-mass and radius along principal axes.
If REFIMAGE, find peak intensity value and voxel location.
By default, ROI list is attached to input mask images. 
FLAG: (no values yet)

NAME: name of ROI list. If omitted, list is linked to 
        input mask images.

-roi MERGE refimage flag name minvalley minsize mindist

The MERGE command assumes that the current image is an ROI mask.

MERGE edits the ROI list. Merge adjacent clusters if:

1) distance bet peaks < MINDIST 
2) stat value in valley between peaks is within MINVALLEY percent of lower peak
3) smaller cluster contains fewer than MINSIZE voxels

FLAG: 2 - do not modify input mask image values when editting ROI list
 (i.e. if merging ROI clusters, change merged mask values)

NAME: name of ROI list. If omitted, list is linked to input mask images.
MINVALLEY: (default= 60% of lower peak maximum)
MINSIZE: (default= 5 voxels)
MINDIST: (default= 40 mm)

-roi STATS refimage flag showflag mode name value nlevels level0 dlevel
-roi STATS refimage flag showflag mode name value cycleleng cycleoff thresh (if flag TIMESERIES)

Calculate stats in input data by ROI

REFIMAGE - dataset to use as ROI mask(s)
FLAG - stats options (select one value 0-7; add other values)
     0 - default stats (3 = Mean,Count,StDev)
     1 - include mean
     2 - include counts, and mean
     3 - include stdev, and above
     4 - include range, and above
     5 - include ctr loc, and above
     6 - include peak val&loc, and above
     7 - include intensity weighted ctr loc, and above
   010 - TIMESERIES; calculate mean time course
   020 - calculate laterality index if available
   040 - calculate stats omitting zero values
  0100 - report ROI volumes in mm3 (voxel count X voxel volume)
  0200 - include ROI's with only zero values (usually ignored)
  0400 - WEIGHTED; weight stats by mask value
 01000 - no threshold
 02000 - CYCLES; calculate time-series stats by task cycle
 04000 - BINARYMASK; consider all non-zero voxels in mask as single ROI 
 
SHOWFLAG - Report generation flags
     1 - tab-separated columns in text output
         (default is space-separated)
     2 - comma-separated columns in text output
  0100 - save as XML text file
  0200 - save as tab-delimited text file
  0400 - plot ref time series
 01000 - save as ref time series
 02000 - generate AMPLE statistics
 04000 - ignore thresholds (default: use threshold if active)
010000 - Watch flag (?)

MODE
     0 - default: 1 if active ROI, 2 if this has glossary,
         3 if prev has glossary, 4 if prev is atlas
     1 - block ROI's (active or all)
     2 - mask values in current data
     3 - mask values in prev data set
     4 - atlas areas
     8 - threshold (can combine with 1-4)
NAME - save stats in file NAME, if specified
VAL: if > 0, only calculate for this mask value
If FLAG & 02010, time-series by CYCLE,  
  CYCLELENG: task cycle length in secs
  CYCLEOFF: first cycle offset in secs (ignore images before this)
  THRESH: mask threshold (assumes WEIGHTED and BINARYMASK)
otherwise,
  NLVLS: # threshold levels to calc separately (def=1)
  LEVEL0: first threshold level (def=0)
  DLEVEL: increment between levels (def=1)

If input is a Surface:

FLAG
  1 - surface area of AREA ROI or path length of contour ROI
  

See Also:
Create ROIs, Edit ROIs, Clusters, ROI Stats

fScan Home, fScan Manual, CmdLineOptions, Manual Help

jvs/fscan/manual/chapter2/roi.1469563382.txt.gz · Last modified: 2016/07/26 20:03 by voyvodic