Profile Class Reference

Instances of this class represent profiles within Vinci. More...

Inheritance diagram for Profile:

List of all members.

Public Member Functions
function	Profile (in connection, in target)
	Creates a new proxy object for an profile in Vinci.
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	createNewProfile (in connection, in profileName, in geometry, in orthopart, in color, in rotation, in showMarkers, in imgTarget, in measure)
static function	createProfileCall (in profileName, in geometry, in orthopart, in color, in rotation, in showMarkers, in imgTarget, in measure)
	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	width
	The width of the profile, stored as a float number in display coordinates.
Property	geometry
	The geometry of the measure.
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	getRotation (in obj)
function	setRotation (in obj, in rotation)
function	getSelected (in obj)
function	setSelected (in obj, in selected)

---

Detailed Description

Instances of this class represent profiles within Vinci.

Profiles can be used to generate graph diagrams of the intensity characteristics along the profile line.

---

Constructor & Destructor Documentation

function Profile	(	in	connection,
		in	target
	)

Creates a new proxy object for an profile in Vinci.

No new profile is created by Vinci. Instead, the object attaches to an already existing profile.

Usage:

• obj = Vinci.Profile(connection, target)

Parameters:

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

Return values:

obj	The created proxy object of type Vinci.Profile.

---

Member Function Documentation

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

static function createNewProfile	(	in	connection,
		in	profileName,
		in	geometry,
		in	orthopart,
		in	color,
		in	rotation,
		in	showMarkers,
		in	imgTarget,
		in	measure
	)		[static]

static function createProfileCall	(	in	profileName,
		in	geometry,
		in	orthopart,
		in	color,
		in	rotation,
		in	showMarkers,
		in	imgTarget,
		in	measure
	)		[static]

This function is for internal use only.

Please use Vinci.Image.createProfile instead.

See also:

Vinci.Image.createProfile

static function getIdFromTarget	(	in	connect,
		in	target
	)		[static, 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)

function reinitVDObjects

(

in

obj

)

[inherited]

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 geometry

The geometry of the measure.

The geometry is given by a struct with the fields head and tail. Both fields are structs with the fields x and y. The coordinates are given in display coordinates.

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.

Property width

The width of the profile, stored as a float number in display coordinates.

A profile with a width of 1 is as wide as an ortho display. For each location on the profile line, all values, which are located on a line perpendicular to the profile and which are not farther away from the profile than width / 2 display coordinates are taken into consideration when calculating the profile values.

---

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

• Profile.m