DataManager Class Reference

Description

Object for managing and querying all image data and meta-information in VivoQuant.

This object can be used to query meta-information from an image, including the DICOM header. It can also be used to open/append new images into VQ and remove/unload images that are currently loaded.

Image data are indexed starting at zero. See also VQ.dataManager() to obtain this object.

Public Member Functions
bool	openDat (int type, Array< string > fileNames, bool forcePlanar=false, bool embedSliceDefault=false)
	Load a new image into VivoQuant from a list of filenames.
bool	openDat (int type, ImageTreeNode *node, bool embedSliceDefault=false)
	Loads a single image into the DataManager, after it has already been processed into an ImageTreeNode from elsewhere.
bool	openDat (int startType, QList< ImageTreeNode * > &list, bool embedSliceDefault=false)
	Loads several images into the DataManager, after they have already been processed into ImageTreeNodes from elsewhere.
int	numROIs ()
	Get number of regions of interest currently specified, including background Always greater than 1.
int	getDimX (Index idx)
	Get the number of sagittal slices ("X" dimension) in an image.
int	getDimX (int i)
	Get the number of sagittal slices ("X" dimension) in an image.
int	getDimY (Index idx)
	Get the number of coronal slices ("Y" dimension) in an image.
int	getDimY (int i)
	Get the number of coronal slices ("Y" dimension) in an image.
int	getDimZ (Index idx)
	Get the number of transverse/axial slices ("Z" dimension) in an image.
int	getDimZ (int i)
	Get the number of transverse/axial slices ("Z" dimension) in an image.
int	getDim (int id, Index idx)
	Get number of slices in an image along specified dimension.
int	getDim (int id, int i)
	Get number of slices in an image along specified dimension.
int	getSize (Index idx)
	Get total number of voxels in an image.
int	getSize (int i)
	Get total number of voxels in an image.
float	getValue (int x, int y, int z, Index idx)
	Return the raw pixel value at provided voxel/pixel location.
float	getValue (int x, int y, int z, int i)
	Return the raw pixel value at provided voxel/pixel location.
float	updateAndGetMin (Index idx)
	Get minimum raw voxel/pixel value of an image.
float	updateAndGetMin (int i)
	Get minimum raw voxel/pixel value of an image.
float	updateAndGetMax (Index idx)
	Get maximum raw voxel/pixel value of an image.
float	updateAndGetMax (int i)
	Get maximum raw voxel/pixel value of an image.
void	setDynamicActive (Index idx, int activeId)
	Set the activated index for dynamic data.
int	getDynamicActive (Index idx)
	Get the activated child index for dynamic data.
bool	copyAsNewSeries (Index idx)
	Copy a given data set timepoint from a dynamic collapsed data set.
float	getMinCached (Index idx)
	Get the cached min intensity value of an image.
float	getMinCached (int i)
	Get the cached min intensity value of an image.
float	getMaxCached (Index idx)
	Get the cached max intensity value of an image.
float	getMaxCached (int i)
	Get the cached max intensity value of an image.
void	setMinMaxCache (Index idx, float min, float max)
	Set the cached min/max intensity value of an image.
void	setMinMaxCache (int i, float min, float max)
	Set the cached min/max intensity value of an image.
float	getLevelCached (Index idx)
	Get the cached window level itensity value of an image.
float	getLevelCached (int i)
	Get the cached window level itensity value of an image.
float	getWidthCached (Index idx)
	Get the cached window width itensity value of an image.
float	getWidthCached (int i)
	Get the cached window width itensity value of an image.
void	setLevelWidthCache (Index idx, float level, float width)
	Set the cached window level/width intensity value of an image.
void	setLevelWidthCache (int i, float level, float width)
	Set the cached window level/width intensity value of an image.
bool	isPlanar (Index idx)
	Check if a given data set is planar or not.
bool	isPlanar (int i)
	Check if a given data set is planar or not.
string	getDataTypeString (Index idx)
	Get a string containing the data type of a given data set.
string	getDataTypeString (int i)
	Get a string containing the data type of a given data set.
float	voxelSizeDim (int dim, Index idx)
	Get the voxel size of a given data set for a given dimension.
float	voxelSizeDim (int dim, int i)
	Get the voxel size of a given data set for a given dimension.
double	voxelSizeX (Index idx)
	Get the X voxel size of a given data set.
double	voxelSizeX (int i)
	Get the X voxel size of a given data set.
double	voxelSizeY (Index idx)
	Get the Y voxel size of a given data set.
double	voxelSizeY (int i)
	Get the Y voxel size of a given data set.
double	voxelSizeXY (Index idx)
	Get the XY voxel size of a given data set.
double	voxelSizeXY (int i)
	Get the XY voxel size of a given data set.
double	voxelSizeZ (Index idx)
	Get the Z voxel size of a given data set.
double	voxelSizeZ (int i)
	Get the Z voxel size of a given data set.
string	getDesc (Index idx, string key, string privateCreator=string())
	Get a DICOM tag value from a given data set.
string	getDesc (int i, string key, string privateCreator=string(), bool useLeafIndexing=true)
	Get a DICOM tag value from a given data set.
void	setDesc (Index idx, string key, string val, string privateCreator=string())
	Set a DICOM tag value to a given data set.
void	setDesc (int i, string key, string val, string privateCreator=string(), bool useLeafIndexing=true)
	Set a DICOM tag value to a given data set.
double	getSUL (Index idx)
	Get the SUL value of a given data set.
double	getSUL (int i=0)
	Get the SUL value of a given data set.
string	getDcmString (Index idx, string key, string privateCreator=string())
	Get a DICOM tag string value from a given data set.
string	getDcmString (int i, string key, string privateCreator=string())
	Get a DICOM tag string value from a given data set.
string	getSOPUID (Index idx)
	Get the SOP UID of a given data set.
string	getSOPUID (int i)
	Get the SOP UID of a given data set.
string	getSeriesUID (Index idx)
	Get the Series ID of a given data set.
string	getSeriesUID (int i)
	Get the Series ID of a given data set.
string	getStudyUID (Index idx)
	Get the Study ID of a given data set.
string	getStudyUID (int i)
	Get the Study ID of a given data set.
void	setUniqueStudyID (Index idx)
	Set a unique Study ID to a given data set.
void	setUniqueStudyID (int i)
	Set a unique Study ID to a given data set.
void	setUniqueStudyID (Index idx, string id)
	Set the given unique Study ID to a given data set.
void	setUniqueStudyID (int i, string id)
	Set the given unique Study ID to a given data set.
Index	getParentImageIndex (DcmDataset *childImageHeader)
	Finds the index in the DataManager for a possible parent image to a dependent DICOM, for example the original image an RTSTRUCT would have been drawn on. We can match on either of the following:
string	getDataDetailsString (Index idx)
	Return a string with image details (original vs loaded for current voxel sizes, dimensions, and direction cosines matrix.).
string	getDataDetailsString (int i=0)
	Return a string with image details (original vs loaded for current voxel sizes, dimensions, and direction cosines matrix.).
string	getHeaderSummary (Index idx)
	Return a string with the header summary ( modality, patient name, and series description).
string	getHeaderSummary (int i=0)
	Return a string with the header summary ( modality, patient name, and series description).
int	size ()
	Return number of data in first level.
int	count (Index parent=Index())
	Return number of dynamic data set contained at given index.
int	maxVis ()
	Return the maximum number size that can be visualized.
bool	hasValid (Index idx)
	Check if the Data Manager holds valid data at the given index.
void	setPaletteParameters (Index idx, float param1, float param2)
	Set the palette values for the given data in Data Manager This function independent of the palette type.
void	setPaletteFromTo (Index idx, float from, float to)
	Set the palette "from" and "to" value for the given data in Data Manager.
void	setPaletteFrom (Index idx, float from)
	Set the palette "from" value for the given data in Data Manager.
void	setPaletteTo (Index idx, float to)
	Set the palette "to" value for the given data in Data Manager.
void	setPaletteLevel (Index idx, float level)
	Set the palette "level" value for the given data in Data Manager.
void	setPaletteWidth (Index idx, float width)
	Set the palette "width" value for the given data in Data Manager.
void	setPalette (Index idx, string name)
	Set the palette for the given data in Data Manager.
void	invertPalette (Index idx)
	Invert the palette for the given data in Data Manager.
void	saveDataPaletteParameter (string name)
	Save palette parameter to disk.
void	loadDataPaletteParameter (string name)
	load palette parameter from file
float	getPaletteFrom (Index idx)
	Get the palette "from" value for the given data in Data Manager.
float	getPaletteTo (Index idx)
	Get the palette "to" value for the given data in Data Manager.
float	getPaletteLevel (Index idx)
	Get the palette window "level" value for the given data in Data Manager.
float	getPaletteWidth (Index idx)
	Get the palette window "width" value for the given data in Data Manager.
string	getPaletteName (Index idx)
	Get the palette name for the given data in Data Manager.
bool	isPaletteInverted (Index idx)
	Get the inverted status of the palette for the given data in Data Manager.
void	unloadData (Index idx, int num=1)
	Unloads data.
void	unloadData (Array< Index > indices)
	Unloads a list of data.
void	swapData (Index a, Index b)
	Swap the position of two data set in the Data Manager.
void	moveData (Array< Index > list, int dst)
	Move data set in the Data Manager.
bool	mergeData (Array< Index > list, bool quiet=true)
	Create a collapsed data set with the selected data.
void	removeTag (Index idx, string key, string privateCreator=string())
	Remove a DICOM tag or sequence item from a given data set.
void	removeTag (int i, string key, string privateCreator=string(), bool useLeafIndexing=true)
	Remove a DICOM tag or sequence item from a given data set.
void	stackData (Array< int > &list, bool quiet=true)
	Create and append an image using multiple single-slice images and unload the images it was created from.
void	stackDataMultiple (QList< Variant > &list, bool quiet=true)
	Create and append images using multiple single-slice images and unload the images they were created from.
unsigned int	getTotalKiloBytesLoaded ()
	Get the entire size of the data loaded in the data manager in kilobytes.
void	notifyDataChange (int i)
	Emits data change notifications for the given index.
void	notifyOptEnabled (int i, bool b)
	Notifies that an option has been enabled or disabled.

Static Public Member Functions
static QList< DcmTag > &	getCustomRestrictedTagList ()
	Get the custom restricted tags list, if defined on this system.
static QVector< QVector< double > >	getReferenceIOP ()
	Get the reference ImageOrientationPatient (IOP). This will be set by the first image loaded by VQ.
static string	getReferenceIOPStr ()
	Utility to get the reference ImageOrientationPatient (IOP) formatted for use in DICOM headers.
static vivoquant::dataImgOrientation	getViewOrientation ()
	Get the view orientation setting. This is set on startup and should not be changed during the VivoQuant session.
static void	setViewOrientation (vivoquant::dataImgOrientation value)
	Set the view orientation for this session. Typically this value should be set on startup from local settings instead.

Protected Member Functions
void	prepImagesForInternalUse (ImageTreeNode *node)
	Carry out transforms on an image node as necessary to ensure and image matches the voxel sizes, dimensions, and orientations. This may add image derivations to the DICOM header.
void	determineLoadingParameters (ImageTreeNode *node, double &finalVoxelSizeXY, double &finalVoxelSizeZ, std::array< unsigned, 3 > &finalDims, bool &resampleToReference)
	Determine the voxel sizes and dimensions needed to match an image node to the reference image. Depending on user settings, it may be necessary to upsample the reference image to match a larger appended image.

Protected Attributes
QVector< TPointAndMode >	m_paths
	list of annotation graphs

Member Function Documentation

copyAsNewSeries()

bool copyAsNewSeries

(

Index

idx

)

Copy a given data set timepoint from a dynamic collapsed data set.

Parameters

idx	Index of data (see VQ.index())

count()

int count

(

Index

parent = Index()

)

Return number of dynamic data set contained at given index.

Parameters

parent

Index of data (see VQ.index())

determineLoadingParameters()

void determineLoadingParameters ( ImageTreeNode * node, double & finalVoxelSizeXY, double & finalVoxelSizeZ, std::array< unsigned, 3 > & finalDims, bool & resampleToReference )

protected

Determine the voxel sizes and dimensions needed to match an image node to the reference image. Depending on user settings, it may be necessary to upsample the reference image to match a larger appended image.

Parameters

	node	the image node
[out]	finalVoxelSizeXY	voxel sizes in the transverse directions
[out]	finalVoxelSizeZ	voxel sizes along the slice axis
[out]	finalDims	the number of voxels along the new image dimensions
[out]	resampleToReference

getCustomRestrictedTagList()

QList< DcmTag > & getCustomRestrictedTagList ( )

static

Get the custom restricted tags list, if defined on this system.

Returns

The restricted tags list, or an empty list if this setting is not defined.

getDataDetailsString() [1/2]

string getDataDetailsString

(

Index

idx

)

Return a string with image details (original vs loaded for current voxel sizes, dimensions, and direction cosines matrix.).

Parameters

idx	Index of data (see VQ.index())

getDataDetailsString() [2/2]

string getDataDetailsString ( int i = 0 )

inline

Return a string with image details (original vs loaded for current voxel sizes, dimensions, and direction cosines matrix.).

Parameters

i	Index of the leaf in the data manager

getDataTypeString() [1/2]

string getDataTypeString

(

Index

idx

)

Get a string containing the data type of a given data set.

Parameters

idx	Index of data (see VQ.index())

Note

The index parameter is optional. If not specified, it will return the value for the first data set

getDataTypeString() [2/2]

string getDataTypeString ( int i )

inline

Get a string containing the data type of a given data set.

Parameters

i	Index of the leaf in the data manager

Note

The index parameter is optional. If not specified, it will return the value for the first data set

getDcmString() [1/2]

string getDcmString	(	Index	idx,
		string	key,
		string	privateCreator = string() )

Get a DICOM tag string value from a given data set.

Parameters

idx	Index of data (see VQ.index())
key	The matching dicom string
privateCreator	The private creator string for private tag context

Note

For all non-dynamic tags, use the top level parent index, only dynamic tags should be used with child index.

getDcmString() [2/2]

string getDcmString ( int i, string key, string privateCreator = string() )

inline

Get a DICOM tag string value from a given data set.

Parameters

i	Index of the leaf in the data manager
key	The matching dicom string
privateCreator	The private creator string for private tag context

Note

For all non-dynamic tags, use the top level parent index, only dynamic tags should be used with child index.

getDesc() [1/2]

string getDesc	(	Index	idx,
		string	key,
		string	privateCreator = string() )

Get a DICOM tag value from a given data set.

Parameters

idx	Index of data (see VQ.index())
key	The tag/key
privateCreator	The private creator string for private tag context

Returns

The tag value

Note

For all non-dynamic tags, use the top level parent index, only dynamic tags should be used with child index.

getDesc() [2/2]

string getDesc ( int i, string key, string privateCreator = string(), bool useLeafIndexing = true )

inline

Get a DICOM tag value from a given data set.

Parameters

i	Index of the leaf in the data manager
key	The tag/key
privateCreator	The private creator string for private tag context
useLeafIndexing	turn off to have i able to refer to the parent of dynamic children

Returns

The tag value

Note

For all non-dynamic tags, use the top level parent index, only dynamic tags should be used with child index.

getDim() [1/2]

int getDim	(	int	id,
		Index	idx )

Get number of slices in an image along specified dimension.

Parameters

id	Plane/dimension to query: 0=Sagittal, 1=Coronal, 2=Transverse/Axial
idx	Index of data (see VQ.index())

Returns

Dimension size, zero if no data are loaded at position i

Note

The index parameter is optional. If not specified, it will return the value for the first data set

getDim() [2/2]

int getDim ( int id, int i )

inline

Get number of slices in an image along specified dimension.

Parameters

id	Plane/dimension to query: 0=Sagittal, 1=Coronal, 2=Transverse/Axial
i	Index of the leaf in the data manager

Returns

Dimension size, zero if no data are loaded at position i

Note

The index parameter is optional. If not specified, it will return the value for the first data set

getDimX() [1/2]

int getDimX

(

Index

idx

)

Get the number of sagittal slices ("X" dimension) in an image.

Parameters

idx	Index of data (see VQ.index())

Returns

Number of sagittal slices, zero if no data are loaded at position i

Note

The index parameter is optional. If not specified, it will return the value for the first data set

getDimX() [2/2]

int getDimX ( int i )

inline

Get the number of sagittal slices ("X" dimension) in an image.

Parameters

i	Index of the leaf in the data manager

Returns

Number of sagittal slices, zero if no data are loaded at position i

Note

The index parameter is optional. If not specified, it will return the value for the first data set

getDimY() [1/2]

int getDimY

(

Index

idx

)

Get the number of coronal slices ("Y" dimension) in an image.

Parameters

idx	Index of data (see VQ.index())

Returns

Number of coronal slices, zero if no data are loaded at position i

Note

The index parameter is optional. If not specified, it will return the value for the first data set

getDimY() [2/2]

int getDimY ( int i )

inline

Get the number of coronal slices ("Y" dimension) in an image.

Parameters

i	Index of the leaf in the data manager

Returns

Number of coronal slices, zero if no data are loaded at position i

Note

The index parameter is optional. If not specified, it will return the value for the first data set

getDimZ() [1/2]

int getDimZ

(

Index

idx

)

Get the number of transverse/axial slices ("Z" dimension) in an image.

Parameters

idx	Index of data (see VQ.index())

Returns

Number of transverse/axial slices, zero if no data are loaded at position i

Note

The index parameter is optional. If not specified, it will return the value for the first data set

getDimZ() [2/2]

int getDimZ ( int i )

inline

Get the number of transverse/axial slices ("Z" dimension) in an image.

Parameters

i	Index of the leaf in the data manager

Returns

Number of transverse/axial slices, zero if no data are loaded at position i

Note

The index parameter is optional. If not specified, it will return the value for the first data set

getDynamicActive()

int getDynamicActive

(

Index

idx

)

Get the activated child index for dynamic data.

Parameters

idx	Index of data (see VQ.index())

Returns

Child index if any, -1 otherwise

getHeaderSummary() [1/2]

string getHeaderSummary

(

Index

idx

)

Return a string with the header summary ( modality, patient name, and series description).

Parameters

idx	Index of data (see VQ.index())

getHeaderSummary() [2/2]

string getHeaderSummary ( int i = 0 )

inline

Return a string with the header summary ( modality, patient name, and series description).

Parameters

i	Index of the leaf in the data manager

getLevelCached() [1/2]

float getLevelCached

(

Index

idx

)

Get the cached window level itensity value of an image.

Parameters

idx	Index of data (see VQ.index())

getLevelCached() [2/2]

float getLevelCached ( int i )

inline

Get the cached window level itensity value of an image.

Parameters

i	Index of the leaf in the data manager

getMaxCached() [1/2]

float getMaxCached

(

Index

idx

)

Get the cached max intensity value of an image.

Parameters

idx	Index of data (see VQ.index())

Note

The index parameter is optional. If not specified, it will return the value for the first data set

getMaxCached() [2/2]

float getMaxCached ( int i )

inline

Get the cached max intensity value of an image.

Parameters

i	Index of the leaf in the data manager

getMinCached() [1/2]

float getMinCached

(

Index

idx

)

Get the cached min intensity value of an image.

Parameters

idx	Index of data (see VQ.index())

Note

The index parameter is optional. If not specified, it will return the value for the first data set

getMinCached() [2/2]

float getMinCached ( int i )

inline

Get the cached min intensity value of an image.

Parameters

i	Index of the leaf in the data manager

getPaletteFrom()

float getPaletteFrom

(

Index

idx

)

Get the palette "from" value for the given data in Data Manager.

Parameters

idx	Index of data (see VQ.index())

getPaletteLevel()

float getPaletteLevel

(

Index

idx

)

Get the palette window "level" value for the given data in Data Manager.

Parameters

idx	Index of data (see VQ.index())

getPaletteName()

string getPaletteName

(

Index

idx

)

Get the palette name for the given data in Data Manager.

Parameters

idx	Index of data (see VQ.index())

getPaletteTo()

float getPaletteTo

(

Index

idx

)

Get the palette "to" value for the given data in Data Manager.

Parameters

idx	Index of data (see VQ.index())

getPaletteWidth()

float getPaletteWidth

(

Index

idx

)

Get the palette window "width" value for the given data in Data Manager.

Parameters

idx	Index of data (see VQ.index())

getParentImageIndex()

Index getParentImageIndex

(

DcmDataset *

childImageHeader

)

Finds the index in the DataManager for a possible parent image to a dependent DICOM, for example the original image an RTSTRUCT would have been drawn on. We can match on either of the following:

1. ReferencedSOPInstanceUID child string including a SOPInstanceUID parent string
2. Same study ID

Parameters

childImageHeader

the DICOM header for the child image

Returns

-1 if image not found, otherwise the index of a matching image in the DataManager.

getReferenceIOP()

QVector< QVector< double > > getReferenceIOP ( )

static

Get the reference ImageOrientationPatient (IOP). This will be set by the first image loaded by VQ.

The IOP are direction cosines that orient the image in space, with a right-hand-rule defined coordinate system.

Returns

a QVector<QVector<double>> with the ImageOrientationPatient value

getReferenceIOPStr()

string getReferenceIOPStr ( )

static

Utility to get the reference ImageOrientationPatient (IOP) formatted for use in DICOM headers.

Returns

a string with the correctly formatted IOP string

getSeriesUID() [1/2]

string getSeriesUID

(

Index

idx

)

Get the Series ID of a given data set.

Parameters

idx	Index of data (see VQ.index())

getSeriesUID() [2/2]

string getSeriesUID ( int i )

inline

Get the Series ID of a given data set.

Parameters

i	Index of the leaf in the data manager

getSize() [1/2]

int getSize

(

Index

idx

)

Get total number of voxels in an image.

Parameters

idx	Index of data (see VQ.index())

Returns

Dimension size, zero if no data are loaded at position i

Note

The index parameter is optional. If not specified, it will return the value for the first data set

getSize() [2/2]

int getSize ( int i )

inline

Get total number of voxels in an image.

Parameters

i	Index of the leaf in the data manager

Returns

Dimension size, zero if no data are loaded at position i

Note

The index parameter is optional. If not specified, it will return the value for the first data set

getSOPUID() [1/2]

string getSOPUID

(

Index

idx

)

Get the SOP UID of a given data set.

Parameters

idx	Index of data (see VQ.index())

getSOPUID() [2/2]

string getSOPUID ( int i )

inline

Get the SOP UID of a given data set.

Parameters

i	Index of the leaf in the data manager

getStudyUID() [1/2]

string getStudyUID

(

Index

idx

)

Get the Study ID of a given data set.

Parameters

idx	Index of data (see VQ.index())

getStudyUID() [2/2]

string getStudyUID ( int i )

inline

Get the Study ID of a given data set.

Parameters

i	Index of the leaf in the data manager

getSUL() [1/2]

double getSUL

(

Index

idx

)

Get the SUL value of a given data set.

Parameters

idx	Index of data (see VQ.index())

getSUL() [2/2]

double getSUL ( int i = 0 )

inline

Get the SUL value of a given data set.

Parameters

i	Index of the leaf in the data manager

getTotalKiloBytesLoaded()

unsigned int getTotalKiloBytesLoaded

(

)

Get the entire size of the data loaded in the data manager in kilobytes.

Returns

Number of kilobytes

getValue() [1/2]

float getValue	(	int	x,
		int	y,
		int	z,
		Index	idx )

Return the raw pixel value at provided voxel/pixel location.

Parameters

x	Sagittal slice index
y	Coronal slice index
z	Transverse/Axial slice index
idx	Index of data (see VQ.index())

Returns

Dimension size, zero if no data are loaded at the given index position

getValue() [2/2]

float getValue ( int x, int y, int z, int i )

inline

Return the raw pixel value at provided voxel/pixel location.

Parameters

x	Sagittal slice index
y	Coronal slice index
z	Transverse/Axial slice index
i	Index of the leaf in the data manager

Returns

Dimension size, zero if no data are loaded at the given index position

getViewOrientation()

vivoquant::dataImgOrientation getViewOrientation ( )

static

Get the view orientation setting. This is set on startup and should not be changed during the VivoQuant session.

Returns

The image orientation setting

getWidthCached() [1/2]

float getWidthCached

(

Index

idx

)

Get the cached window width itensity value of an image.

Parameters

idx	Index of data (see VQ.index())

getWidthCached() [2/2]

float getWidthCached ( int i )

inline

Get the cached window width itensity value of an image.

Parameters

i	Index of the leaf in the data manager

hasValid()

bool hasValid ( Index idx )

inline

Check if the Data Manager holds valid data at the given index.

Parameters

idx	Index of data (see VQ.index())

invertPalette()

void invertPalette

(

Index

idx

)

Invert the palette for the given data in Data Manager.

Parameters

idx	Index of data (see VQ.index())

isPaletteInverted()

bool isPaletteInverted

(

Index

idx

)

Get the inverted status of the palette for the given data in Data Manager.

Parameters

idx	Index of data (see VQ.index())

isPlanar() [1/2]

bool isPlanar

(

Index

idx

)

Check if a given data set is planar or not.

Parameters

idx	Index of data (see VQ.index())

Note

The index parameter is optional. If not specified, it will return the value for the first data set

isPlanar() [2/2]

bool isPlanar ( int i )

inline

Check if a given data set is planar or not.

Parameters

i	Index of the leaf in the data manager

Note

The index parameter is optional. If not specified, it will return the value for the first data set

loadDataPaletteParameter()

void loadDataPaletteParameter

(

string

name

)

load palette parameter from file

Parameters

name	Path and file name of the parameter file (*.txt)

mergeData()

bool mergeData	(	Array< Index >	list,
		bool	quiet = true )

Create a collapsed data set with the selected data.

Parameters

list	List of data index to be grouped (see VQ.index())
quiet	If true (default), no message boxes are shown

moveData()

void moveData	(	Array< Index >	list,
		int	dst )

Move data set in the Data Manager.

Parameters

list	List of data indices to move (see VQ.index())
dst	Position of the parent destination to move them to

Note

When using dynamic data, only parent index can be moved and used as a destination.

notifyDataChange()

void notifyDataChange

(

int

i

)

Emits data change notifications for the given index.

If the index is within the visible range, emits updateDataPointers() to refresh dependent state. Always emits dataChanged(i) to notify observers of the change.

Parameters

i	Index of the updated data element.

notifyOptEnabled()

void notifyOptEnabled	(	int	i,
		bool	b )

Notifies that an option has been enabled or disabled.

Emits the optEnabled(int, bool) signal to inform listeners that the option at index i has changed its enabled state to b.

Parameters

i	The index of the option.
b	True if the option is enabled, false if disabled.

numROIs()

int numROIs

(

)

Get number of regions of interest currently specified, including background Always greater than 1.

Returns

Number of ROIs

openDat() [1/3]

bool openDat	(	int	startType,
		QList< ImageTreeNode * > &	list,
		bool	embedSliceDefault = false )

Loads several images into the DataManager, after they have already been processed into ImageTreeNodes from elsewhere.

Parameters

startType
list
embedSliceDefault

Returns

true

openDat() [2/3]

bool openDat	(	int	type,
		Array< string >	fileNames,
		bool	forcePlanar = false,
		bool	embedSliceDefault = false )

Load a new image into VivoQuant from a list of filenames.

Parameters

type	Position where image will be loaded into the list. 0=Reference, 1=Input 1, etc.
fileNames	Array of filenames containing full paths or path relative to current working directory where VQ was started from
forcePlanar	(Optional) Indicates whether image should be forced into "Planar" mode upon loading
embedSliceDefault	(Optional) Indicates whether default values for embed slice (embedded in the center of the reference data) should be used or a dialog prompt will appear to define it. Only applies for plannar data.

Returns

true if data is loaded successfully, otherwise returns false

openDat() [3/3]

bool openDat	(	int	type,
		ImageTreeNode *	node,
		bool	embedSliceDefault = false )

Loads a single image into the DataManager, after it has already been processed into an ImageTreeNode from elsewhere.

Parameters

type
node
embedSliceDefault

Returns

true

prepImagesForInternalUse()

void prepImagesForInternalUse ( ImageTreeNode * node )

protected

Carry out transforms on an image node as necessary to ensure and image matches the voxel sizes, dimensions, and orientations. This may add image derivations to the DICOM header.

Parameters

node	the image node

removeTag() [1/2]

void removeTag	(	Index	idx,
		string	key,
		string	privateCreator = string() )

Remove a DICOM tag or sequence item from a given data set.

Parameters

idx	Index of data (see VQ.index())
key	The tag/key
privateCreator	If the tag is private to be sure you get a match another vendor you can add the private creator string

removeTag() [2/2]

void removeTag ( int i, string key, string privateCreator = string(), bool useLeafIndexing = true )

inline

Remove a DICOM tag or sequence item from a given data set.

Parameters

i	Index of the leaf in the data manager
key	The tag/key
privateCreator	If the tag is private to be sure you get a match another vendor you can add the private creator string
useLeafIndexing	turn off to have i able to refer to the parent of dynamic children

saveDataPaletteParameter()

void saveDataPaletteParameter

(

string

name

)

Save palette parameter to disk.

Parameters

name	Path and file name of the parameter file (*.txt)

setDesc() [1/2]

void setDesc	(	Index	idx,
		string	key,
		string	val,
		string	privateCreator = string() )

Set a DICOM tag value to a given data set.

Parameters

idx	Index of data (see VQ.index())
key	The tag/key
val	The value
privateCreator	The private creator string for private tag context

Note

For all non-dynamic tags, use the top level parent index, only dynamic tags should be used with child index.

setDesc() [2/2]

void setDesc ( int i, string key, string val, string privateCreator = string(), bool useLeafIndexing = true )

inline

Set a DICOM tag value to a given data set.

Parameters

i	Index of the leaf in the data manager
key	The tag/key
val	The value
privateCreator	The private creator string for private tag context
useLeafIndexing	turn off to have i able to refer to the parent of dynamic children

Note

For all non-dynamic tags, use the top level parent index, only dynamic tags should be used with child index.

setDynamicActive()

void setDynamicActive	(	Index	idx,
		int	activeId )

Set the activated index for dynamic data.

Parameters

idx	Index of data (see VQ.index())
activeId	indicate the number of child to be displayed.

setLevelWidthCache() [1/2]

void setLevelWidthCache	(	Index	idx,
		float	level,
		float	width )

Set the cached window level/width intensity value of an image.

Parameters

idx	Index of data (see VQ.index())
level	Window level or center
width	Window width

setLevelWidthCache() [2/2]

void setLevelWidthCache ( int i, float level, float width )

inline

Set the cached window level/width intensity value of an image.

Parameters

i	Index of the leaf in the data manager
level	Window level or center
width	Window width

setMinMaxCache() [1/2]

void setMinMaxCache	(	Index	idx,
		float	min,
		float	max )

Set the cached min/max intensity value of an image.

Parameters

idx	Index of data (see VQ.index())
min	Minimum intensity value
max	Maximum intensity value

setMinMaxCache() [2/2]

void setMinMaxCache ( int i, float min, float max )

inline

Set the cached min/max intensity value of an image.

Parameters

i	Index of the leaf in the data manager
min	Minimum intensity value
max	Maximum intensity value

setPalette()

void setPalette	(	Index	idx,
		string	name )

Set the palette for the given data in Data Manager.

Parameters

idx	Index of data (see VQ.index())
name	Name of the palette

setPaletteFrom()

void setPaletteFrom	(	Index	idx,
		float	from )

Set the palette "from" value for the given data in Data Manager.

Parameters

idx	Index of data (see VQ.index())
from	From parameter value from 0-1.0

setPaletteFromTo()

void setPaletteFromTo	(	Index	idx,
		float	from,
		float	to )

Set the palette "from" and "to" value for the given data in Data Manager.

Parameters

idx	Index of data (see VQ.index())
from	From parameter value from 0-1.0
to	for right parameter from 0-1.0

setPaletteLevel()

void setPaletteLevel	(	Index	idx,
		float	level )

Set the palette "level" value for the given data in Data Manager.

Parameters

idx	Index of data (see VQ.index())
level	Level parameter value from 0-1.0

setPaletteParameters()

void setPaletteParameters	(	Index	idx,
		float	param1,
		float	param2 )

Set the palette values for the given data in Data Manager This function independent of the palette type.

Parameters

idx	Index of data (see VQ.index())
param1	First parameter value from 0-1.0
param2	Second parameter value from 0-1.0

Note

If the palette type is Min/Max the param1 and param2 are expected to be from and to respectively. If the palette type is Window Width/Level the param1 and param2 are expected to be width and level respectively.

setPaletteTo()

void setPaletteTo	(	Index	idx,
		float	to )

Set the palette "to" value for the given data in Data Manager.

Parameters

idx	Index of data (see VQ.index())
to	To parameter value from 0-1.0

setPaletteWidth()

void setPaletteWidth	(	Index	idx,
		float	width )

Set the palette "width" value for the given data in Data Manager.

Parameters

idx	Index of data (see VQ.index())
width	Width parameter value from 0-1.0

setUniqueStudyID() [1/4]

void setUniqueStudyID

(

Index

idx

)

Set a unique Study ID to a given data set.

Parameters

idx	Index of data (see VQ.index())

setUniqueStudyID() [2/4]

void setUniqueStudyID	(	Index	idx,
		string	id )

Set the given unique Study ID to a given data set.

Parameters

idx	Index of data (see VQ.index())
id	The Study ID to set

Deprecated

Use setDesc instead. Duplicate functionality

Deprecated

Use setDesc instead. Duplicate functionality

setUniqueStudyID() [3/4]

void setUniqueStudyID ( int i )

inline

Set a unique Study ID to a given data set.

Parameters

i	Index of the leaf in the data manager

setUniqueStudyID() [4/4]

void setUniqueStudyID ( int i, string id )

inline

Set the given unique Study ID to a given data set.

Parameters

i	Index of the leaf in the data manager
id	The Study ID to set

Deprecated

Use setDesc instead. Duplicate functionality

Deprecated

Use setDesc instead. Duplicate functionality

setViewOrientation()

void setViewOrientation ( vivoquant::dataImgOrientation value )

static

Set the view orientation for this session. Typically this value should be set on startup from local settings instead.

Parameters

value

the view orientation enum value to use. If 'Unset' is passed, it will be ignored.

stackData()

void stackData	(	Array< int > &	list,
		bool	quiet = true )

Create and append an image using multiple single-slice images and unload the images it was created from.

Parameters

list	The indices of the data to be stacked
quiet	(optional) If true, warnings are displayed in a UI popup, if false they are printed to the debug output.

stackDataMultiple()

void stackDataMultiple	(	QList< Variant > &	list,
		bool	quiet = true )

Create and append images using multiple single-slice images and unload the images they were created from.

Parameters

list	A list of lists, where each list contains indices of data that will be stacked into one image
quiet	(optional) If true, warnings are displayed in a UI popup, if false they are printed to the debug output.

swapData()

void swapData	(	Index	a,
		Index	b )

Swap the position of two data set in the Data Manager.

Parameters

a	Frist data index to swap (see VQ.index())
b	Second data index to swap (see VQ.index())

Note

When using dynamic data, only parent index can be swapped

unloadData() [1/2]

void unloadData

(

Array< Index >

indices

)

Unloads a list of data.

Parameters

indices

A list containing the indices to unload (see VQ.index())

unloadData() [2/2]

void unloadData	(	Index	idx,
		int	num = 1 )

Unloads data.

Parameters

idx	Index at which to start unloading (see VQ.index())
num	Number of consecutive datasets to unload at the same level, starting with and including idx

updateAndGetMax() [1/2]

float updateAndGetMax

(

Index

idx

)

Get maximum raw voxel/pixel value of an image.

Parameters

idx	Index of data (see VQ.index())

Returns

Maximum or NaN if no image exists at provided index, in native data units

Note

The index parameter is optional. If not specified, it will return the value for the first data set

updateAndGetMax() [2/2]

float updateAndGetMax ( int i )

inline

Get maximum raw voxel/pixel value of an image.

Parameters

i	Index of the leaf in the data manager

Returns

Maximum or NaN if no image exists at provided index, in native data units

updateAndGetMin() [1/2]

float updateAndGetMin

(

Index

idx

)

Get minimum raw voxel/pixel value of an image.

Parameters

idx	Index of data (see VQ.index())

Returns

Minimum or NaN if no image exists at provided index, in native data units

Note

The index parameter is optional. If not specified, it will return the value for the first data set

updateAndGetMin() [2/2]

float updateAndGetMin ( int i )

inline

Get minimum raw voxel/pixel value of an image.

Parameters

i	Index of the leaf in the data manager

Returns

Minimum or NaN if no image exists at provided index, in native data units

voxelSizeDim() [1/2]

float voxelSizeDim	(	int	dim,
		Index	idx )

Get the voxel size of a given data set for a given dimension.

Parameters

dim	the Dimension (x:0, y:1, z:2)
idx	Index of data (see VQ.index())

Note

The index parameter is optional. If not specified, it will return the value for the first data set

voxelSizeDim() [2/2]

float voxelSizeDim ( int dim, int i )

inline

Get the voxel size of a given data set for a given dimension.

Parameters

dim	the Dimension (x:0, y:1, z:2)
i	Index of the leaf in the data manager

Note

The index parameter is optional. If not specified, it will return the value for the first data set

voxelSizeX() [1/2]

double voxelSizeX

(

Index

idx

)

Get the X voxel size of a given data set.

Parameters

idx	Index of data (see VQ.index())

Note

The index parameter is optional. If not specified, it will return the value for the first data set

voxelSizeX() [2/2]

double voxelSizeX ( int i )

inline

Get the X voxel size of a given data set.

Parameters

i	Index of the leaf in the data manager

Note

The index parameter is optional. If not specified, it will return the value for the first data set

voxelSizeXY() [1/2]

double voxelSizeXY

(

Index

idx

)

Get the XY voxel size of a given data set.

Parameters

idx	Index of data (see VQ.index())

Note

The index parameter is optional. If not specified, it will return the value for the first data set

voxelSizeXY() [2/2]

double voxelSizeXY ( int i )

inline

Get the XY voxel size of a given data set.

Parameters

i	Index of the leaf in the data manager

Note

The index parameter is optional. If not specified, it will return the value for the first data set

voxelSizeY() [1/2]

double voxelSizeY

(

Index

idx

)

Get the Y voxel size of a given data set.

Parameters

idx	Index of data (see VQ.index())

Note

The index parameter is optional. If not specified, it will return the value for the first data set

voxelSizeY() [2/2]

double voxelSizeY ( int i )

inline

Get the Y voxel size of a given data set.

Parameters

i	Index of the leaf in the data manager

Note

The index parameter is optional. If not specified, it will return the value for the first data set

voxelSizeZ() [1/2]

double voxelSizeZ

(

Index

idx

)

Get the Z voxel size of a given data set.

Parameters

idx	Index of data (see VQ.index())

Note

The index parameter is optional. If not specified, it will return the value for the first data set

voxelSizeZ() [2/2]

double voxelSizeZ ( int i )

inline

Get the Z voxel size of a given data set.

Parameters

i	Index of the leaf in the data manager

Note

The index parameter is optional. If not specified, it will return the value for the first data set