Description

Named values accepted and returned by VQS functions.

Each enumeration below is available in a script as VQ.<EnumName>, and each of its keys as VQ.<EnumName>.<Key>, for example VQ.DICOMImageFormat.SF.

An enumeration key is only a name for its integer value, so VQ.Plane.Transverse is exactly 2. Functions accept either form, values returned by functions are plain numbers, and the integer values will not change. Existing scripts that pass integers keep working; new scripts should prefer the named form because it is self-explanatory.

var ctl = VQ.controller();
ctl.setActive(1, false);                   // integer form, still supported
ctl.setActive(VQ.DataID.Input1, false);    // same call, recommended form

If a script must also run on a VivoQuant version older than an enumeration's "Since" version, use the integer form for that enumeration.

Enumerations
enum	DICOMImageFormat { MFModule = 0 , MFGroup = 1 , SF = 2 }
	VivoQuant's supported DICOM formats. More...
enum	TimePointsSettings { AllTimePoints = 0 , CurrentTimePoint = 1 }
	Options to save specified timepoints. More...
enum	TimepointFilesSettings { SingleFileForAllTimepoints = 0 , OneFilePerTimepoint = 1 }
	Options to save timepoints separately. More...
enum	DataID { Reference = 0 , Input1 = 1 , Input2 = 2 }
	Data slot shown in the slice view. More...
enum class	CropView { NONE = 0 , DASHED = 1 , FILLED = 2 }
	Crop range display style. More...
enum	Plane { Sagittal = 0 , Coronal = 1 , Transverse = 2 }
	Plane of a slice view. More...

Enumeration Type Documentation

◆ CropView

enum class CropView

strong

Crop range display style.

See also: VQ.controller().getCropStyle(), VQ.controller().setCropStyle()

Enumerator
NONE	Crop range not shown.
DASHED	Crop range shown as a dashed outline.
FILLED	Crop range shown filled.

◆ DataID

enum DataID

Data slot shown in the slice view.

See also: VQ.controller().getActive(), VQ.controller().setActive(), VQ.controller().getIntensity(), VQ.controller().setIntensity()

Enumerator
Reference	Reference data
Input1	Input1 data
Input2	Input2 data

◆ DICOMImageFormat

enum DICOMImageFormat

VivoQuant's supported DICOM formats.

See also: VQ.storeData(), VQ.storeAsDICOM()

Enumerator
MFModule	Volumetric data in a single file
MFGroup	Volumetric data in a single file, with per-slice information
SF	Single frame data (one slice of an image volume per file)

◆ Plane

enum Plane

Plane of a slice view.

See also: VQ.controller().getMax(), VQ.controller().getPos(), VQ.controller().setPos()

Enumerator
Sagittal	Sagittal plane.
Coronal	Coronal plane.
Transverse	Transverse plane.

◆ TimepointFilesSettings

enum TimepointFilesSettings

Options to save timepoints separately.

See also: VQ.storeDataByTimepoint(), VQ.storeAsDICOMByTimepoint()

Enumerator
SingleFileForAllTimepoints	Save all timepoints in a single file
OneFilePerTimepoint	Save each timepoint in its own file

◆ TimePointsSettings

enum TimePointsSettings

Options to save specified timepoints.

See also: VQ.storeDataByTimepoint(), VQ.storeAsDICOMByTimepoint()

Enumerator
AllTimePoints	Save all timepoints in the image data
CurrentTimePoint	Save the current timepoint only