Instances of this class represent one MMM tool in Vinci. More...

Inheritance diagram for MMMTool:

Public Member Functions
function	MMMTool (in connection, in target)
	Creates a new proxy object for an MMM tool in Vinci.
function	coregisterHuman (in obj, in refImg, in reslImg, in varargin)
	Coregisters two human brain images.
function	coregisterRat (in obj, in refImg, in reslImg, in varargin)
	Coregisters two rat brain images.
function	sendMessageToMe (in obj, in xmlStr)
	Sends a message to Vinci's counterpart of the VinciObject and receives an answer.
function	sendMessageToTarget (in obj, in target, in xmlStr)
	Sends a message to some target and receives an answer.
function	sendMessageToMeNoAnswer (in obj, in xmlStr)
	Sends a message to the VinciObject and tells Vinci to don't send an answer.
function	sendMessageToTargetNoAnswer (in obj, in target, in xmlStr)
	Sends a message to some target and tells Vinci to don't send an answer.
function	getTargetPartNumber (in obj, in partName)
	Returns the number specified in a part of a target name.
Static Public Member Functions
static function	createNewMMMTool (in connection, in orthoview, in orthoDisplayNum)
	Creates a new MMM tool for the selected orthodisplay.
static function	getIdFromTarget (in connect, in target)
static function	getTargetNameQuery (in id)
static function	getTargetFromId (in connect, in id)
Public Attributes
Property	referenceImg
	The reference image used during coregistrations.
Property< ReadOnly >	id
Property< ReadOnly >	connection
	The Vinci.Connect object used to communicate with Vinci.
Property< ReadOnly >	target
	The target name of the Vinci.VinciObject.

Detailed Description

Instances of this class represent one MMM tool in Vinci.

The MMM Tool can be used to coregister images of various modalities.

Constructor & Destructor Documentation

function MMMTool	(	in	connection,
		in	target
	)

Creates a new proxy object for an MMM tool in Vinci.

Usage:

obj = Vinci.MMMTool(connection, target)

Parameters:

connection	An object of type Vinci.Connect. This object is used to talk to Vinci.
target	The target name of the MMM tool.

Return values:

obj	An object of type Vinci.MMMTool.

Member Function Documentation

function coregisterHuman	(	in	obj,
		in	refImg,
		in	reslImg,
		in	varargin
	)

Coregisters two human brain images.

Usage:

obj.coregisterHuman(refImg, reslImg, 'key1', value1, ..., 'keyN', valueN)

Parameters:

refImg	An object of type Vinci.Image. The reference image onto which the reslicing image is coregistered. Some schemes automatically load a fixed reference image and ignore the one specified by you. In these cases, you can supply an empty cell array {} instead.
reslImg	An object of type Vinci.Image. The reslincing image, which is coregistered onto the reference image.
varargin	Additional key-value pairs. Keys must be from the following list: 'SummaryFile': A string. The name of the file, which will store the coregistration summary. 'SchemeName': A string. The name of the coregistration scheme, which should be used. You can find valid names in Vinci.Constants.HumanSchemes. You must specify one of the options 'SchemeName' or 'CustomScheme'. 'CustomScheme': A string. A custom XML coregistration scheme. See mmm.xml in the example directory for an example. You must specify one of the options 'SchemeName' or 'CustomScheme'. 'TimeOut': An integer. Once you start a coregistration, Matlab will block until the coregistration has finished. To make sure that Matlab does not block indefinite in the case that something goes haywire, Matlab will time out after the specified number of seconds. By default, Matlab will wait for 600 seconds.

function coregisterRat	(	in	obj,
		in	refImg,
		in	reslImg,
		in	varargin
	)

Coregisters two rat brain images.

Usage:

obj.coregisterRat(refImg, reslImg, 'key1', value1, ..., 'keyN', valueN)

Parameters:

refImg	An object of type Vinci.Image. The reference image onto which the reslicing image is coregistered. Some schemes automatically load a fixed reference image and ignore the one specified by you. In these cases, you can supply an empty cell array {} instead.
reslImg	An object of type Vinci.Image. The reslincing image, which is coregistered onto the reference image.
varargin	Additional key-value pairs. Keys must be from the following list: 'SummaryFile': A string. The name of the file, which will store the coregistration summary. 'SchemeName': A string. The name of the coregistration scheme, which should be used. You can find valid names in Vinci.Constants.RatSchemes. You must specify one of the options 'SchemeName' or 'CustomScheme'. 'CustomScheme': A string. A custom XML coregistration scheme. See mmm.xml in the example directory for an example. You must specify one of the options 'SchemeName' or 'CustomScheme'. 'TimeOut': An integer. Once you start a coregistration, Matlab will block until the coregistration has finished. To make sure that Matlab does not block indefinite in the case that something goes haywire, Matlab will time out after the specified number of seconds. By default, Matlab will wait for 600 seconds. 'PreRotateAngle': A vector with 3 floats. The initial rotation of the reslicing image. The values are in radians. 'Scaling': An integer. This option sets the scaling of the predefined reference image in some coregistration schemes. Must be either 100, 95 or 90.

static function createNewMMMTool	(	in	connection,
		in	orthoview,
		in	orthoDisplayNum
	)		`[static]`

Creates a new MMM tool for the selected orthodisplay.

Usage:

mmmtool = Vinci.MMMTool.createNewMMMTool(connection, orthoview, orthoDisplayNum)

Parameters:

connection	A Vinci.Connect object. Used to communicate with Vinci.
orthoview	A Vinci.OrthoView object. The MMM tool will be created for this orthoview.
orthoDisplayNum	An integer. The number of the orthodisplay, for which the MMM tool is created. The first orthodisplay has the number 0.

Return values:

mmmtool A Vinci.MMMTool object.

static function getIdFromTarget	(	in	connect,
		in	target
	)		`[static, inherited]`

static function getTargetFromId	(	in	connect,
		in	id
	)		`[static, inherited]`

static function getTargetNameQuery ( in id ) [static, inherited]

function getTargetPartNumber	(	in	obj,
		in	partName
	)		`[inherited]`

Returns the number specified in a part of a target name.

Target names consist of a hierarchy of numbered objects, e.g. '::Project_0::Image_3'. This function returns the number to a given object.

Usage:

number = obj.getTargetPartNumber(partNumber)

Parameters:

obj	The Vinci.VinciObject instance. The target property of this object is used as target name.
partName	A substring of the target name for which the number should be returned. Examples are 'Project_' or 'Image'. The trailing _ can be left out.

Return values:

number The number extracted from the target name of the object.

Examples:

  >> obj = Vinci.VinciObject(connection, '::Project_0::Image_3');
  >> imageNumber = obj.getTargetPartNumber('Image')
  % imageNumber is 3 (as an float)

function sendMessageToMe	(	in	obj,
		in	xmlStr
	)		`[inherited]`

Sends a message to Vinci's counterpart of the VinciObject and receives an answer.

Usage:

answer = obj.sendMessageToMe(xmlStr)

Parameters:

obj	The Vinci.VinciObject instance.
xmlStr	A string. The message Matlab sends to Vinci.

Return values:

answer A string. The answer returned by Vinci.

function sendMessageToMeNoAnswer	(	in	obj,
		in	xmlStr
	)		`[inherited]`

Sends a message to the VinciObject and tells Vinci to don't send an answer.

Usage:

obj.sendMessageToMeNoAnswer(xmlStr)

Parameters:

obj	The Vinci.VinciObject instance.
xmlStr	A string. The message Matlab sends to Vinci.

function sendMessageToTarget	(	in	obj,
		in	target,
		in	xmlStr
	)		`[inherited]`

Sends a message to some target and receives an answer.

Usage:

answer = obj.sendMessageToTarget(target, xmlStr)

Parameters:

obj	The Vinci.VinciObject instance.
target	A string. The name of the target.
xmlStr	A string. The message Matlab sends to Vinci.

Return values:

answer A string. The answer returned by Vinci.

function sendMessageToTargetNoAnswer	(	in	obj,
		in	target,
		in	xmlStr
	)		`[inherited]`

Sends a message to some target and tells Vinci to don't send an answer.

Usage:

obj.sendMessageToTarget(target, xmlStr)

Parameters:

obj	The Vinci.VinciObject instance.
target	A string. The name of the target.
xmlStr	A string. The message Matlab sends to Vinci.

Member Data Documentation

Property<ReadOnly> connection [inherited]

The Vinci.Connect object used to communicate with Vinci.

This object determines, with which instance of Vinci the object will talk.

Property<ReadOnly> id [inherited]

Property referenceImg

The reference image used during coregistrations.

Property<ReadOnly> target [inherited]

The target name of the Vinci.VinciObject.

Target names are strings in the form '::', '::Project_0' or '::Project_0::Image_0'.

The documentation for this class was generated from the following file:

MMMTool.m

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation