OrthoView Class Reference

Instances of this class represent an ortho view window in Vinci. More...

Inheritance diagram for OrthoView:

List of all members.

Public Member Functions
function	OrthoView (in connection, in target)
	Creates a new proxy for an ortho display.
function	bringToFront (in obj)
function	getOrthoDisplay (in obj, in number)
	Returns a Vinci.OrthoDisplay object, referencing the nth ortho display within the orthoview.
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	createNewOrthoView (in connection, in varargin)
	Creates a new ortho view inside Vinci and returns a handle to it.
static function	getFirstOrthoView (in connection)
	Returns an Vinci.OrthoView object refering to the first ortho view in Vinci.
static function	getAllOrthoViews (in connection)
	Returns a vector of Vinci.OrthoView objects with proxies for all ortho views in Vinci.
static function	getIdFromTarget (in connect, in target)
static function	getTargetNameQuery (in id)
static function	getTargetFromId (in connect, in id)
Public Attributes
Property	numDisplays
	An integer.
Property	orthoParts
	A string cell array.
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 an ortho view window in Vinci.

Ortho views are composed of several ortho displays. The number of ortho displays can be queried and adjusted at runtime from within Matlab.

---

Constructor & Destructor Documentation

function OrthoView	(	in	connection,
		in	target
	)

Creates a new proxy for an ortho display.

Usage:

• obj = Vinci.OrthoView(connection, target)

Parameters:

connection	An object of type Vinci.Connect. This object is used to communicate with Vinci.
target	The target name of the orthoview.

Return values:

obj	An object of type Vinci.OrthoView.

---

Member Function Documentation

function bringToFront

(

in

obj

)

static function createNewOrthoView	(	in	connection,
		in	varargin
	)		[static]

Creates a new ortho view inside Vinci and returns a handle to it.

Usage:

• orthoview = Vinci.OrthoView.createNewOrthoView(connection, 'key1', value1, ..., 'keyN', valueN)

Parameters:

connection	An object of type Vinci.Connect. This object is used to communicate with Vinci.
varargin	Additional key value pairs. Valid keys are: 'OffsetImageBuffer': The index of the image buffer, which should be displayed in the first ortho display of the ortho view. The default is 0. 'NumberRows': The number of ortho displays. The default is 4. 'DisplaySize': A 1x3 integer matrix. The size of the three parts of an ortho display in pixels. The default is [256 256 256].

Return values:

orthoview

A Vinci.OrthoView object for the newly created ortho view.

static function getAllOrthoViews

(

in

connection

)

[static]

Returns a vector of Vinci.OrthoView objects with proxies for all ortho views in Vinci.

Usage:

• orthoviews = Vinci.OrthoView.getAllOrthoViews(connection)

Parameters:

connection

A Vinci.Connect object. Used to communicate with Vinci.

Return values:

orthoviews

A 1xn vector of Vinci.OrthoView objects. One Vinci.OrthoView object for each ortho view in Vinci.

static function getFirstOrthoView

(

in

connection

)

[static]

Returns an Vinci.OrthoView object refering to the first ortho view in Vinci.

If no ortho view exists so far, a new one is created and returned.

Usage:

• orthoview = Vinci.OrthoView.getFirstOrthoView(connection)

Parameters:

connection

A Vinci.Connect object. Used to communicate with Vinci.

Return values:

orthoview

A Vinci.OrthoView object refering to the first ortho view in Vinci.

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

function getOrthoDisplay	(	in	obj,
		in	number
	)

Returns a Vinci.OrthoDisplay object, referencing the nth ortho display within the orthoview.

Usage:

• orthodisplay = obj.getOrthoDisplay(number)

Parameters:

obj	A Vinci.OrthoView object.
number	An integer. The number of the ortho display, which should be returned. Valid values lie between 0 and obj.numDisplays - 1.

Return values:

orthodisplay

An Vinci.OrthoDisplay object.

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 numDisplays

An integer.

The number of ortho displays visible in the ortho view window.

Property orthoParts

A string cell array.

A list of the parts of an orthoview, which are visible. The cell array may contain values from Vinci.Constants.Orthoparts. The order of the values is not important, as ortho parts always appear in the order transaxial, coronal, sagittal.

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:

• OrthoView.m