PreProcessing Class Reference

Object to handle operation of the PreProcessing Tool. More...

#include <PreProcessing.h>

Public Member Functions
void	setProtocol (string protocol)
	Set values in the PreProcessing Tool based on the provided protocol string.
string	execute (string protocol=string())
	Set values in the PreProcessing Tool based on the provided protocol string and execute the pre-processing based on these settings.
void	setUptakeParameter (string source, string parameter, Array< string > info, Index idx=Index())
	Change the value of a parameter used for decay correction.
void	setPreferredUptakeSource (string source, Index idx=Index())
	Change the preferred source to check for decay correction parameters.
void	setUptakeSourceOrder (Array< string > sourceList, Index idx=Index())
	Change the order in which to check sources for decay correction parameters.
void	setInjectedDose (string injectedDose=string())
	Set the injected dose.
void	setWeight (string weight=string())
	Set the weight.
string	getInjectedDose (Index idx=Index())
	Get the injected dose for a given image.
string	getWeight (Index idx=Index())
	Get the weight.
void	updateUptakeParameters ()
	Update uptake information. Should be called after calls to PreProcessing::setUptakeParameter()
void	setStoreRepository (DicomRepository *rep)
	Sets the Dicom Repository of the data to be stored.

Detailed Description

Object to handle operation of the PreProcessing Tool.

This object can be used to configure and run various pre-processing steps on loaded data.

See also ScriptMaster::PreProcessingTool() to obtain this object.

Member Function Documentation

execute()

string execute

(

string

protocol = string()

)

Set values in the PreProcessing Tool based on the provided protocol string and execute the pre-processing based on these settings.

Parameters

protocol

The protocol string

Returns

A message describing the result of executing the protocol

getInjectedDose()

string getInjectedDose

(

Index

idx = Index()

)

Get the injected dose for a given image.

Parameters

idx	The index of the data. If no index is supplied the first image in the data list will be used.

Returns

The injected dose and its unit.

getWeight()

string getWeight

(

Index

idx = Index()

)

Get the weight.

Parameters

idx	The index of the data. If no index is supplied the first image in the data list will be used.

Returns

The weight and its unit.

setInjectedDose()

void setInjectedDose

(

string

injectedDose = string()

)

Set the injected dose.

Parameters

injectedDose

The injected dose, which must include a unit.

setPreferredUptakeSource()

void setPreferredUptakeSource	(	string	source,
		Index	idx = Index()
	)

Change the preferred source to check for decay correction parameters.

Parameters

source	The source of the info (DCM, Manual, or IPACS)
idx	The index of the data to modify

setProtocol()

void setProtocol

(

string

protocol

)

Set values in the PreProcessing Tool based on the provided protocol string.

Parameters

protocol

The protocol string, which is of the form "<preprocessingstep0>=<value0>|<preprocessingstep1>=<value1>|...|<preprocessingstepN>=<valueN>" An example protocol string can be generated by clicking the "Protocol" button in the PreProcessing Tool dialog.

setStoreRepository()

void setStoreRepository

(

DicomRepository *

rep

)

Sets the Dicom Repository of the data to be stored.

Parameters

rep	The Dicom repository

setUptakeParameter()

void setUptakeParameter	(	string	source,
		string	parameter,
		Array< string >	info,
		Index	idx = Index()
	)

Change the value of a parameter used for decay correction.

Parameters

source	The source of the info (DCM, Manual, or IPACS)
parameter	The name of the parameter
info	The parameter's value - either a list containing a single number or a list containing datapoint information
idx	The index of the data to modify

setUptakeSourceOrder()

void setUptakeSourceOrder	(	Array< string >	sourceList,
		Index	idx = Index()
	)

Change the order in which to check sources for decay correction parameters.

Parameters

sourceList	The list of sources (DCM, Manual, or IPACS)
idx	The index of the data to modify

setWeight()

void setWeight

(

string

weight = string()

)

Set the weight.

Parameters

weight

The weight, which must include a unit.