iron.CoordinateSystem Class Reference

Inheritance diagram for iron.CoordinateSystem:

Collaboration diagram for iron.CoordinateSystem:

Public Member Functions
def	__init__ (self)
def	CreateFinish (self)
def	CreateStart (self, coordinateSystemUserNumber)
def	Destroy (self)
def	DimensionGet (self)
def	DimensionSet (self, coordinateSystemDimension)
def	Finalise (self)
def	FocusGet (self)
def	FocusSet (self, focus)
def	OrientationGet (self, orientationSizes)
def	OrientationSet (self, orientation)
def	OriginGet (self, originSize)
def	OriginSet (self, origin)
def	RadialInterpolationGet (self)
def	RadialInterpolationSet (self, radialInterpolationType)
def	TypeGet (self)
def	TypeSet (self, coordinateSystemType)

Public Attributes
	cmiss_type

Properties
	origin = property(OriginGet, OriginSet, None, )
	radialInterpolation = property(RadialInterpolationGet, RadialInterpolationSet, None, )
	orientation = property(OrientationGet, OrientationSet, None, )
	focus = property(FocusGet, FocusSet, None, )
	type = property(TypeGet, TypeSet, None, )
	dimension = property(DimensionGet, DimensionSet, None, )

Detailed Description

Contains information on a coordinate system.

Definition at line 1132 of file iron.py.

Constructor & Destructor Documentation

def iron.CoordinateSystem.__init__

(

self

)

Initialise a null cmfe_CoordinateSystemType

Definition at line 1136 of file iron.py.

Member Function Documentation

def iron.CoordinateSystem.CreateFinish

(

self

)

Finishes the creation of a coordinate system identified by an object.

:rtype: None

Definition at line 1141 of file iron.py.

def iron.CoordinateSystem.CreateStart	(		self,
			coordinateSystemUserNumber
	)

Starts the creation of a coordinate system identified by an object.

:param coordinateSystemUserNumber: The user number of the coordinate system to start creating.
:type coordinateSystemUserNumber: int
:rtype: None

Definition at line 1150 of file iron.py.

def iron.CoordinateSystem.Destroy

(

self

)

Destroys a coordinate system identified by an object.

:rtype: None

Definition at line 1161 of file iron.py.

def iron.CoordinateSystem.DimensionGet

(

self

)

Returns the dimension of a coordinate system identified by an object.

:returns: coordinateSystemDimension. The dimension of the coordinate system.
:rtype: int

Definition at line 1170 of file iron.py.

def iron.CoordinateSystem.DimensionSet	(		self,
			coordinateSystemDimension
	)

Sets/changes the dimension of a coordinate system identified by an object.

:param coordinateSystemDimension: The dimension of the coordinate system to set.
:type coordinateSystemDimension: int
:rtype: None

Definition at line 1180 of file iron.py.

def iron.CoordinateSystem.Finalise

(

self

)

Finalises a cmfe_CoordinateSystemType object.

:rtype: None

Definition at line 1191 of file iron.py.

def iron.CoordinateSystem.FocusGet

(

self

)

Returns the focus of a coordinate system identified by an object.

:returns: focus. The focus of the coordinate system.
:rtype: float

Definition at line 1200 of file iron.py.

def iron.CoordinateSystem.FocusSet	(		self,
			focus
	)

Sets/changes the focus of a coordinate system identified by an object.

:param focus: The focus of the coordinate system to set.
:type focus: float
:rtype: None

Definition at line 1210 of file iron.py.

def iron.CoordinateSystem.OrientationGet	(		self,
			orientationSizes
	)

Returns the orientation of a coordinate system identified by an object.

:param orientationSizes: Tuple of dimensions of orientation to allocate, with length 2.
:returns: orientation. The orientation of the coordinate system.
:rtype: 2d array of floats

Definition at line 1221 of file iron.py.

def iron.CoordinateSystem.OrientationSet	(		self,
			orientation
	)

Sets/changes the orientation of a coordinate system identified by an object.

:param orientation: The orientation of the coordinate system to set.
:type orientation: 2d array of floats
:rtype: None

Definition at line 1232 of file iron.py.

def iron.CoordinateSystem.OriginGet	(		self,
			originSize
	)

Returns the origin of a coordinate system identified by an object.

:param originSize: Size of origin to allocate.
:returns: origin. The origin of the coordinate system.
:rtype: Array of floats

Definition at line 1243 of file iron.py.

def iron.CoordinateSystem.OriginSet	(		self,
			origin
	)

Sets/changes the origin of a coordinate system identified by an object.

:param origin: The origin of the coordinate system to set.
:type origin: Array of floats
:rtype: None

Definition at line 1254 of file iron.py.

def iron.CoordinateSystem.RadialInterpolationGet

(

self

)

Returns the radial interpolation type of a coordinate system identified by an object.

:returns: radialInterpolationType. The radial interpolation type of the coordinate system. Will be a value from the CoordinateRadialInterpolations enum.
:rtype: int

Definition at line 1265 of file iron.py.

def iron.CoordinateSystem.RadialInterpolationSet	(		self,
			radialInterpolationType
	)

Sets/changes the radial interpolation type of a coordinate system identified by an object.

:param radialInterpolationType: The radial interpolation type of the coordinate system to set. Must be a value from the CoordinateRadialInterpolations enum.
:type radialInterpolationType: int
:rtype: None

Definition at line 1275 of file iron.py.

def iron.CoordinateSystem.TypeGet

(

self

)

Returns the type of a coordinate system identified by an object.

:returns: coordinateSystemType. The type of the coordinate system. Will be a value from the CoordinateSystemTypes enum.
:rtype: int

Definition at line 1286 of file iron.py.

def iron.CoordinateSystem.TypeSet	(		self,
			coordinateSystemType
	)

Sets/changes the type of a coordinate system identified by an object.

:param coordinateSystemType: The type of the coordinate system to set. Must be a value from the CoordinateSystemTypes enum.
:type coordinateSystemType: int
:rtype: None

Definition at line 1296 of file iron.py.

Member Data Documentation

iron.CoordinateSystem.cmiss_type

Definition at line 1139 of file iron.py.

Property Documentation

iron.CoordinateSystem.dimension = property(DimensionGet, DimensionSet, None, )

static

Definition at line 1317 of file iron.py.

iron.CoordinateSystem.focus = property(FocusGet, FocusSet, None, )

static

Definition at line 1313 of file iron.py.

iron.CoordinateSystem.orientation = property(OrientationGet, OrientationSet, None, )

static

Definition at line 1311 of file iron.py.

iron.CoordinateSystem.origin = property(OriginGet, OriginSet, None, )

static

Definition at line 1307 of file iron.py.

iron.CoordinateSystem.radialInterpolation = property(RadialInterpolationGet, RadialInterpolationSet, None, )

static

Definition at line 1309 of file iron.py.

iron.CoordinateSystem.type = property(TypeGet, TypeSet, None, )

static

Definition at line 1315 of file iron.py.