DisplayGroup Class Reference

Each instance of the class DisplayGroup represents a display group within Vinci. More...

Inheritance diagram for DisplayGroup:

List of all members.

Public Member Functions
function	DisplayGroup (in connection, in target)
	Creates a new proxy object for a display group in Vinci.
function	evaluateRoi (in obj)
	Evaluates all rois in the group using the GlobalUnion operation.
function	evaluateGroup (in obj, in operation)
	Evaluates all rois in the group using the specified operation.
function	addToGroup (in obj, in do)
	Adds a display object to the end of the display group.
function	removeFromGroup (in obj, in do)
	Removes a display object from a group.
function	getGroupMembers (in obj)
	Returns a list of all display objects, which are part of the display group.
function	numItemsInGroup (in obj)
	Returns the number of display objects in the display group.
function	getPositionInGroup (in obj, in do)
	Returns the position of the display object within the group.
function	getRoiValues (in obj)
function	assignToImage (in obj, in imageTarget)
function	reinitVDObjects (in obj)
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	createNewDisplayGroup (in connection, in groupName, in orthopart, in color, in rotation, in imgTarget)
	This function is for internal use only.
static function	createNewRoi (in connection, in roiName, in roiType, in pos, in orthopart, in color, in rot, in imageTarget)
	This function is for internal use only.
static function	getIdFromTarget (in connect, in target)
static function	getTargetNameQuery (in id)
static function	getTargetFromId (in connect, in id)
Public Attributes
Property	name
	A string. The name of the display object.
Property	rotation
	A double. The rotation of the display object in radians.
Property	color
	The color of the display object.
Property	orthopart
	A string.
Property	selected
	A boolean.
Property< ReadOnly >	type
	A string.
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.
Protected Member Functions
function	getRoiCoordsAndValues (in obj)
function	getRotation (in obj)
function	setRotation (in obj, in rotation)
function	getSelected (in obj)
function	setSelected (in obj, in selected)
Static Protected Member Functions
static function	initRoi (in connection, in roiName, in roiType, in pos, in orthopart, in color, in rot)

---

Detailed Description

Each instance of the class DisplayGroup represents a display group within Vinci.

A display group groups several display objects together. These display objects can then be moved and rotated as a whole. If all objects inside a group are rois, you can evaluate the rois using complex operations suchas union, intersection or sequential differences.

---

Constructor & Destructor Documentation

function DisplayGroup	(	in	connection,
		in	target
	)

Creates a new proxy object for a display group in Vinci.

Usage:

• obj = Vinci.DisplayGroup(connection, target)

Parameters:

connection	A Vinci.Connect object. Used to communicate with Vinci.
target	A string. The target name of the display group object in Vinci.

Return values:

obj	The created proxy object of type Vinci.DisplayGroup.

See also:

Vinci.Image.createDisplayGroup

---

Member Function Documentation

function addToGroup	(	in	obj,
		in	do
	)

Adds a display object to the end of the display group.

If the display object is already part of the group, this action has no effect.

Usage:

• obj.addToGroup(do)

Parameters:

obj	A Vinci.DisplayGroup object.
do	A Vinci.DisplayObject instance. The display object is added to the end of the display group.

function assignToImage	(	in	obj,
		in	imageTarget
	)		[inherited]

static function createNewDisplayGroup	(	in	connection,
		in	groupName,
		in	orthopart,
		in	color,
		in	rotation,
		in	imgTarget
	)		[static]

This function is for internal use only.

Please use Vinci.Image.createDisplayGroup instead.

See also:

Vinci.Image.createDisplayGroup

static function createNewRoi	(	in	connection,
		in	roiName,
		in	roiType,
		in	pos,
		in	orthopart,
		in	color,
		in	rot,
		in	imageTarget
	)		[static, inherited]

This function is for internal use only.

Please use Vinci.Image.createRoiRect, Vinci.Image.createRoiPolygon and Vinci.Image.createRoiEllipse instead.

See also:

Vinci.Image.createRoiRect

Vinci.Image.createRoiEllipse

Vinci.Image.createRoiPolygon

function evaluateGroup	(	in	obj,
		in	operation
	)

Evaluates all rois in the group using the specified operation.

Available operations are global union, global intersection, global difference, sequential difference and individual evaluation. The global operations all return a struct with the fields Min, Max, Pixels, Sum, Average and StdDev. Sequential differences and individual evaluation return an array of structs with the same fields and the additional fields RoiName and RoiTarget.

Usage:

• results = obj.evaluateGroup(operation)

Parameters:

obj	The Vinci.DisplayGroup object.
operation	A string. The group operation, which should be used. One of the values from Vinci.Constants.GroupOperations.

Return values:

result

Either a struct or an array of structs, depending on the chosen group operation.

function evaluateRoi

(

in

obj

)

Evaluates all rois in the group using the GlobalUnion operation.

Usage:

• results = obj.evaluateRoi()

Parameters:

obj	The Vinci.DisplayGroup object. The rois in this group are evaluated using the GlobalUnion operation.

Return values:

statistics

A struct containing the same fields as described in Vinci.Roi.evaluateRoi.

Reimplemented from Roi.

function getGroupMembers

(

in

obj

)

Returns a list of all display objects, which are part of the display group.

Usage:

• members = obj.getGroupMembers()

Parameters:

obj	A Vinci.DisplayGroup object.

Return values:

members

A cell array of display group members. All elements in the cell array are derived from Vinci.DisplayObject.

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

function getPositionInGroup	(	in	obj,
		in	do
	)

Returns the position of the display object within the group.

Positions are 0-based. This means that the first object in the group has position 0, the second object has position 1 and so on. If the object is not part of the display group, -1 is returned.

Usage:

• pos = obj.getPositionInGroup(do)

Parameters:

obj	A Vinci.DisplayGroup object.
do	A Vinci.DisplayObject instance. The display object, for which the position is returned.

Return values:

pos	An integer. The position of the display object in the display group.

function getRoiCoordsAndValues

(

in

obj

)

[protected, inherited]

function getRoiValues

(

in

obj

)

[inherited]

function getRotation

(

in

obj

)

[protected, inherited]

Reimplemented in Measure.

function getSelected

(

in

obj

)

[protected, 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)

static function initRoi	(	in	connection,
		in	roiName,
		in	roiType,
		in	pos,
		in	orthopart,
		in	color,
		in	rot
	)		[static, protected, inherited]

function numItemsInGroup

(

in

obj

)

Returns the number of display objects in the display group.

Usage:

• numItems = obj.numItemsInGroup()

Parameters:

obj	A Vinci.DisplayGroup object.

Return values:

numItems

An integer. The number of objects in the display group.

function reinitVDObjects

(

in

obj

)

[inherited]

function removeFromGroup	(	in	obj,
		in	do
	)

Removes a display object from a group.

If the display object is not part of the group, the operation has no effect.

Usage:

• obj.removeFromGroup(do)

Parameters:

obj	A Vinci.DisplayGroup object.
do	A Vinci.DisplayObject instance. The display object is removed from the group.

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.

function setRotation	(	in	obj,
		in	rotation
	)		[protected, inherited]

Reimplemented in Measure.

function setSelected	(	in	obj,
		in	selected
	)		[protected, inherited]

Reimplemented in Measure.

---

Member Data Documentation

Property color [inherited]

The color of the display object.

Stored as a [r, g, b] triple. Color channels are stored as integers between 0 and 255. Valid colors are for example [0 255 13] or [18 23 255].

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 name [inherited]

A string. The name of the display object.

Property orthopart [inherited]

A string.

The name of the part of the ortho display, which displays the object. Find possible values in Vinci.Constants.Orthoparts.

Property rotation [inherited]

A double. The rotation of the display object in radians.

Property selected [inherited]

A boolean.

true if the object is selected and false otherwise.

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'.

Property<ReadOnly> type [inherited]

A string.

The type of the display object. You can find supported values in Vinci.Constants.DisplayObjectTypes.

---

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

• DisplayGroup.m