Report Tool
Table of Contents
- Keywords
- General tags - used in output general header
- Group header elements - that do not change from display to display
- Group header elements - that may change from display to display
- ROI/VOI specifics - equal on different images or frames
- ROI/VOI specifics - different on different images or frames for thresholded ROIs
- ROI/VOI specifics - different on different images or frames (in general)
Keywords
the following keywords are defined and will be replaced by the actual values in Excel, OpenOffice or Text template files. Comparison is case-sensitive so far.
General tags - used in output general header
| Tags | Format | Description |
|---|---|---|
| $VINCIVERSION | String | version of report tool |
| $TOOLVERSION | String | full file name of autosaved project file |
| $VINCIPROJECT | String | full file name of autosaved project file |
| $PROJECTSIGNATURE | String | MD5 check sum in autosaved project file |
| $TIMESTAMP | String | date and time of report |
| $ROIWIDTHTYPE | String | +/- Planes in TruePixel mode; +/- Cuts else |
| $ROIWIDTH | Integer | number of planes/cuts used to compute ROI statistics |
Group header elements - that do not change from display to display
| Tags | Format | Description |
|---|---|---|
| $ORTHOVIEW | String | name of OrthoView |
| $ORTHODISPLAY | String | name of OrthoDisplay |
| $DISPLAYSIZE | Integer | display size |
| $SAMPLINGSIZE | Integer | sampling size of the image |
| $INTERPOLATION3D | String | 3d interpolation method (TriLinear, Next Neighbor or TruePixel) |
| $INTERPOLATION2D | String | zoom method (Pixel Reduplication, High Resolution Spline, Bilinear) |
Group header elements - that may change from display to display
| Tags | Format | Description |
|---|---|---|
| $IMAGEFILE | String | full file name of image |
| $IMAGEPATH | String | path of image |
| $IMAGEINFO | String | additional image information (e.g. "frame 1") |
| $ORIG_TIME | HH:MM:SS | absolute time when the image was taken (used in Speckle) |
| $UNITS | String | image units ("inconsistent" if not all images use the have the same data unit) |
ROI/VOI specifics - equal on different images or frames
| Tags | Format | Description |
|---|---|---|
| $ITEMNAME | String | ROI/VOI name |
| $ITEMTYPE | String | ROI type (rectangle, ellipse, polygon); VOI Type (Boid, Ellipsoid, Cuboid, Spheroid) |
| $ROIORTHOPART | String | part of OrthoDisplay on which the ROI is defined (TRANSAXIAL, CORONAL, SAGITTAL) |
| $ROIORIENTATION | Float (f1.2) | rotation angle |
| $ROIORIENTATIONUNITS | String (no blanks) | degrees |
ROI/VOI specifics - different on different images or frames for thresholded ROIs
| Tags | Format | Description |
|---|---|---|
| $PIXELS | Integer | number of pixels for the given display size (used with ROIs) |
| $VOXELS | Integer | number of voxels for the given display size (used with VOIs) |
| $PERCENTAGEAREA | Float (f1.1) | number of voxels for the given display size (used with VOIs) |
| $SURFACE | Float (g) | ROI surface [mm²] |
| $VOLUME | Float (g) | ROI volume [mm³], cut thickness is defined by the distance of planes of each individual image (if in TruePixel mode) or of the reference image (if not) in the direction vertical to the OrthoPart on which the ROI is defined (rotations taken into account) |
| $COMMENT | String | VOI computation comment: empty or [resampled]. The later means that the VOI gets computed on an image that has another geometry than the image the VOI is defined on. |
ROI/VOI specifics - different on different images or frames (in general)
| Tags | Format | Description |
|---|---|---|
| $NUMBER | Integer | running number of ROI/VOI (in the current report), Frame (TAC Report), Image (Image List Report) |
| $FRAME | Integer | image frame on which the ROI/VOI is computed |
| $PLANE | Integer | image plane on which the ROI is computed |
| $ROI_ID | Integer | Vinci-internal number of the ROI |
| $STARTTIME | Float (f1.1) | Starttime of frame (used in TAC Report) |
| $DURATION | Float (f1.1) | duration of frame (used in TAC Report) |
| $AVERAGE | Float (g) | mean in ROI/VOI statistics computation |
| $SUM | Float (g) | sum of voxels valus within the ROI/VOI; useful for further elaborate computations |
| $STDDEV | Float (g) | standard deviation of image values in the ROI/VOI |
| $STDDEVPERCENT | Float (f1.1) | standard deviation in [%] of the average value |
| $MINIMUM | Float (g) | minimum of image values in the ROI/VOI |
| $MAXIMUM | Float (g) | maximum of image values in the ROI/VOI |
| $IMAGEFILE_WOCOMMONPATH | String | image file without path if every image has the same path (used in Image List Report) |