Class Registration

Represents the spatial registration matrix between two frames of reference.

Inheritance
System.Object
SerializableObject
ApiDataObject
Registration
Implements
System.Xml.Serialization.IXmlSerializable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: VMS.TPS.Common.Model.API
Assembly: VMS.TPS.Common.Model.API.dll
Syntax
public class Registration : ApiDataObject, IXmlSerializable

Properties

CreationDateTime

The date when this object was created.

Declaration
public DateTime? CreationDateTime { get; }
Property Value
Type Description
System.Nullable<System.DateTime>

RegisteredFOR

The frame of reference UID of the registered coordinate system.

Declaration
public string RegisteredFOR { get; }
Property Value
Type Description
System.String

SourceFOR

The frame of reference UID of the source coordinate system.

Declaration
public string SourceFOR { get; }
Property Value
Type Description
System.String

Status

The current approval status of the registration.

Declaration
public RegistrationApprovalStatus Status { get; }
Property Value
Type Description
RegistrationApprovalStatus

StatusDateTime

The approval status date and time.

Declaration
public DateTime? StatusDateTime { get; }
Property Value
Type Description
System.Nullable<System.DateTime>

StatusUserDisplayName

Full user name of user who changed the approval status.

Declaration
public string StatusUserDisplayName { get; }
Property Value
Type Description
System.String

StatusUserName

User ID of the user who changed the approval status.

Declaration
public string StatusUserName { get; }
Property Value
Type Description
System.String

TransformationMatrix

The elements of the 4x4 transformation matrix.

Declaration
public double[, ] TransformationMatrix { get; }
Property Value
Type Description
System.Double[,]

UID

The SOP Instance UID of this registration object.

Declaration
public string UID { get; }
Property Value
Type Description
System.String

Methods

InverseTransformPoint(VVector)

Transforms a point in the inverse direction, that is, from the coordinate system of the RegisteredFOR to the coordinate system of the SourceFOR.

Declaration
public VVector InverseTransformPoint(VVector pt)
Parameters
Type Name Description
VVector pt

Point in the RegisteredFOR coordinate system.
Returns
Type Description
VVector

Given point transformed to the SourceFOR.

TransformPoint(VVector)

Transforms a point from the SourceFOR coordinate system to the RegisteredFOR coordinate system.

Declaration
public VVector TransformPoint(VVector pt)
Parameters
Type Name Description
VVector pt

Point in the SourceFOR coordinate system.
Returns
Type Description
VVector

Given point transformed to the RegisteredFOR.

WriteXml(XmlWriter)

Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see System.Xml.Serialization.XmlSerializer.

Declaration
public override void WriteXml(XmlWriter writer)
Parameters
Type Name Description
System.Xml.XmlWriter writer

The System.Xml.XmlWriter stream, to which the object is serialized.
Overrides

Implements

System.Xml.Serialization.IXmlSerializable