OpenCMISS-Iron Python Bindings API Documentation
iron.DataProjection Class Reference
Inheritance diagram for iron.DataProjection:
Collaboration diagram for iron.DataProjection:

Public Member Functions

def __init__ (self)
 
def AbsoluteToleranceGet (self)
 
def AbsoluteToleranceSet (self, absoluteTolerance)
 
def CreateFinish (self)
 
def CreateStart (self, dataProjectionUserNumber, dataPoints, mesh)
 
def DataPointsPositionEvaluate (self, field, fieldVariableType)
 
def DataPointsProjectionEvaluate (self, projectionField)
 
def Destroy (self)
 
def ElementSet (self, dataPointNumber, elementNumber)
 
def Finalise (self)
 
def LabelGet (self)
 
def LabelSet (self, label)
 
def MaximumIterationUpdateGet (self)
 
def MaximumIterationUpdateSet (self, maximumIterationUpdate)
 
def MaximumNumberOfIterationsGet (self)
 
def MaximumNumberOfIterationsSet (self, maximumNumberOfIterations)
 
def NumberOfClosestElementsGet (self)
 
def NumberOfClosestElementsSet (self, numberOfClosestElements)
 
def ProjectionCandidatesSet (self, candidateElements, localFaceLineNumbers)
 
def ProjectionTypeGet (self)
 
def ProjectionTypeSet (self, projectionType)
 
def RelativeToleranceGet (self)
 
def RelativeToleranceSet (self, relativeTolerance)
 
def ResultDistanceGet (self, dataPointUserNumber)
 
def ResultElementFaceNumberGet (self, dataPointUserNumber)
 
def ResultElementLineNumberGet (self, dataPointUserNumber)
 
def ResultElementNumberGet (self, dataPointUserNumber)
 
def ResultExitTagGet (self, dataPointUserNumber)
 
def ResultProjectionVectorGet (self, dataPointUserNumber, projectionVectorSize)
 
def ResultXiGet (self, dataPointUserNumber, ProjectionXiSize)
 
def ResultXiSet (self, dataPointUserNumber, ProjectionXi)
 
def StartingXiGet (self, startingXiSize)
 
def StartingXiSet (self, startingXi)
 

Public Attributes

 cmiss_type
 

Properties

 maximumNumberOfIterations = property(MaximumNumberOfIterationsGet, MaximumNumberOfIterationsSet, None, )
 
 absoluteTolerance = property(AbsoluteToleranceGet, AbsoluteToleranceSet, None, )
 
 label = property(LabelGet, LabelSet, None, )
 
 maximumIterationUpdate = property(MaximumIterationUpdateGet, MaximumIterationUpdateSet, None, )
 
 numberOfClosestElements = property(NumberOfClosestElementsGet, NumberOfClosestElementsSet, None, )
 
 projectionType = property(ProjectionTypeGet, ProjectionTypeSet, None, )
 
 startingXi = property(StartingXiGet, StartingXiSet, None, )
 
 relativeTolerance = property(RelativeToleranceGet, RelativeToleranceSet, None, )
 

Detailed Description

Contains information about a data projection.

Definition at line 1497 of file iron.py.

Constructor & Destructor Documentation

def iron.DataProjection.__init__ (   self)
Initialise a null cmfe_DataProjectionType

Definition at line 1501 of file iron.py.

Member Function Documentation

def iron.DataProjection.AbsoluteToleranceGet (   self)
Returns the absolute tolerance of data projection identified an object.

:returns: absoluteTolerance. On exit, the absolute tolerance of the specified data projection
:rtype: float

Definition at line 1506 of file iron.py.

def iron.DataProjection.AbsoluteToleranceSet (   self,
  absoluteTolerance 
)
Sets/changes the absolute tolerance of data projection identified an object.

:param absoluteTolerance: the absolute tolerance to set
:type absoluteTolerance: float
:rtype: None

Definition at line 1516 of file iron.py.

def iron.DataProjection.CreateFinish (   self)
Finishes the creation of a new data projection identified by an object.

:rtype: None

Definition at line 1527 of file iron.py.

def iron.DataProjection.CreateStart (   self,
  dataProjectionUserNumber,
  dataPoints,
  mesh 
)
Starts the creation of a new data projection for a data projection identified by an object.

:param dataProjectionUserNumber: The data projection user number.
:type dataProjectionUserNumber: int
:param dataPoints: The data points to be projected
:type dataPoints: DataPoints
:param mesh: The mesh where data points is projected on
:type mesh: Mesh
:rtype: None

Definition at line 1536 of file iron.py.

def iron.DataProjection.DataPointsPositionEvaluate (   self,
  field,
  fieldVariableType 
)
Evaluate the data points position in a field based on data projection, identified by object

:param field: The field to interpolate
:type field: Field
:param fieldVariableType: The field variable type to be interpolated
:type fieldVariableType: int
:rtype: None

Definition at line 1551 of file iron.py.

def iron.DataProjection.DataPointsProjectionEvaluate (   self,
  projectionField 
)
Evaluate a data projection identified by an object.

:param projectionField: The field data points is projected on
:type projectionField: Field
:rtype: None

Definition at line 1564 of file iron.py.

def iron.DataProjection.Destroy (   self)
Destroys a data projection identified by an object.

:rtype: None

Definition at line 1575 of file iron.py.

def iron.DataProjection.ElementSet (   self,
  dataPointNumber,
  elementNumber 
)
Sets/changes the starting xi of data projection identified an object.

:param dataPointNumber: The data point number to set xi position for
:type dataPointNumber: int
:param elementNumber: the element number to set
:type elementNumber: int
:rtype: None

Definition at line 1584 of file iron.py.

def iron.DataProjection.Finalise (   self)
Finalises a cmfe_DataProjectionType object.

:rtype: None

Definition at line 1597 of file iron.py.

def iron.DataProjection.LabelGet (   self)
Gets the character string label of a data projection identified an object.

:returns: label. the label to get
:rtype: string

Definition at line 1606 of file iron.py.

def iron.DataProjection.LabelSet (   self,
  label 
)
Sets/changes the character string label of a data projection identified an object.

:param label: the label to set
:type label: string
:rtype: None

Definition at line 1616 of file iron.py.

def iron.DataProjection.MaximumIterationUpdateGet (   self)
Returns the relative tolerance of data projection identified an object.

:returns: maximumIterationUpdate. On exit, the maximum iteration update of the specified data projection
:rtype: float

Definition at line 1627 of file iron.py.

def iron.DataProjection.MaximumIterationUpdateSet (   self,
  maximumIterationUpdate 
)
Sets/changes the relative tolerance of data projection identified an object.

:param maximumIterationUpdate: the maximum iteration update to set
:type maximumIterationUpdate: float
:rtype: None

Definition at line 1637 of file iron.py.

def iron.DataProjection.MaximumNumberOfIterationsGet (   self)
Returns the maximum number of iterations of data projection identified an object.

:returns: maximumNumberOfIterations. On exit, the maximum number of iterations of the specified data projection
:rtype: int

Definition at line 1648 of file iron.py.

def iron.DataProjection.MaximumNumberOfIterationsSet (   self,
  maximumNumberOfIterations 
)
Sets/changes the maximum number of iterations of data projection identified an object.

:param maximumNumberOfIterations: the maximum number of iterations to set
:type maximumNumberOfIterations: int
:rtype: None

Definition at line 1658 of file iron.py.

def iron.DataProjection.NumberOfClosestElementsGet (   self)
Returns the number of closest elements of data projection identified an object.

:returns: numberOfClosestElements. On exit, the number of closest elements of the specified data projection
:rtype: int

Definition at line 1669 of file iron.py.

def iron.DataProjection.NumberOfClosestElementsSet (   self,
  numberOfClosestElements 
)
Sets/changes the number of closest elements of data projection identified an object.

:param numberOfClosestElements: the number of closest elements to set
:type numberOfClosestElements: int
:rtype: None

Definition at line 1679 of file iron.py.

def iron.DataProjection.ProjectionCandidatesSet (   self,
  candidateElements,
  localFaceLineNumbers 
)
Evaluate the data points position in a field based on data projection, identified by object

:param candidateElements: The candidate element for the projection
:type candidateElements: Array of ints
:param localFaceLineNumbers: The local face/line number for the candidate elements
:type localFaceLineNumbers: Array of ints
:rtype: None

Definition at line 1690 of file iron.py.

def iron.DataProjection.ProjectionTypeGet (   self)
Returns the projection type of data projection identified an object.

:returns: projectionType. On exit, the projection type of the specified data projection
:rtype: int

Definition at line 1703 of file iron.py.

def iron.DataProjection.ProjectionTypeSet (   self,
  projectionType 
)
Sets/changes the projection type of data projection identified an object.

:param projectionType: the projection type to set
:type projectionType: int
:rtype: None

Definition at line 1713 of file iron.py.

def iron.DataProjection.RelativeToleranceGet (   self)
Returns the relative tolerance of data projection identified an object.

:returns: relativeTolerance. On exit, the absolute relative tolerance of the specified data projection
:rtype: float

Definition at line 1724 of file iron.py.

def iron.DataProjection.RelativeToleranceSet (   self,
  relativeTolerance 
)
Sets/changes the relative tolerance of data projection identified an object.

:param relativeTolerance: the absolute relative tolerance to set
:type relativeTolerance: float
:rtype: None

Definition at line 1734 of file iron.py.

def iron.DataProjection.ResultDistanceGet (   self,
  dataPointUserNumber 
)
Returns the projection distance for a data point in a set of data points identified by an object.

:param dataPointUserNumber: The user number of the data points to get attributes for.
:type dataPointUserNumber: int
:returns: ProjectionDistance. The projection distance for the data point.
:rtype: float

Definition at line 1745 of file iron.py.

def iron.DataProjection.ResultElementFaceNumberGet (   self,
  dataPointUserNumber 
)
Returns the projection element face number for a data point in a set of data points identified by an object.

:param dataPointUserNumber: The user number of the data points to get attributes for.
:type dataPointUserNumber: int
:returns: ProjectionElementFaceNumber. The projection element face number for the data point.
:rtype: int

Definition at line 1757 of file iron.py.

def iron.DataProjection.ResultElementLineNumberGet (   self,
  dataPointUserNumber 
)
Returns the projection element line number for a data point in a set of data points identified by an object.

:param dataPointUserNumber: The user number of the data points to get attributes for.
:type dataPointUserNumber: int
:returns: ProjectionElementLineNumber. The projection element line number for the data point.
:rtype: int

Definition at line 1769 of file iron.py.

def iron.DataProjection.ResultElementNumberGet (   self,
  dataPointUserNumber 
)
Returns the projection element number for a data point in a set of data points identified by an object.

:param dataPointUserNumber: The user number of the data points to get attributes for.
:type dataPointUserNumber: int
:returns: ProjectionElementNumber. The projection element number for the data point.
:rtype: int

Definition at line 1781 of file iron.py.

def iron.DataProjection.ResultExitTagGet (   self,
  dataPointUserNumber 
)
Returns the projection exit tag for a data point in a set of data points identified by an object.

:param dataPointUserNumber: The user number of the data points to get attributes for.
:type dataPointUserNumber: int
:returns: ProjectionExitTag. The projection exit tag for the data point.
:rtype: int

Definition at line 1793 of file iron.py.

def iron.DataProjection.ResultProjectionVectorGet (   self,
  dataPointUserNumber,
  projectionVectorSize 
)
Returns the projection vector for a data point in a set of data points identified by an object.

:param dataPointUserNumber: The user number of the data points to get attributes for.
:type dataPointUserNumber: int
:param projectionVectorSize: Size of projectionVector to allocate.
:returns: projectionVector. The projection vector for the data point.
:rtype: Array of floats

Definition at line 1805 of file iron.py.

def iron.DataProjection.ResultXiGet (   self,
  dataPointUserNumber,
  ProjectionXiSize 
)
Returns the projection xi for a data point in a set of data points identified by an object.

:param dataPointUserNumber: The user number of the data points to get attributes for.
:type dataPointUserNumber: int
:param ProjectionXiSize: Size of ProjectionXi to allocate.
:returns: ProjectionXi. The projection xi for the data point.
:rtype: Array of floats

Definition at line 1818 of file iron.py.

def iron.DataProjection.ResultXiSet (   self,
  dataPointUserNumber,
  ProjectionXi 
)
Sets the projection xi for a data point in a set of data points identified by an object.

:param dataPointUserNumber: The user number of the data points to set attributes for
:type dataPointUserNumber: int
:param ProjectionXi: On return, the projection xi for the data point.
:type ProjectionXi: Array of floats
:rtype: None

Definition at line 1831 of file iron.py.

def iron.DataProjection.StartingXiGet (   self,
  startingXiSize 
)
Returns the starting xi of data projection identified an object.

:param startingXiSize: Size of startingXi to allocate.
:returns: startingXi. On exit, the absolute starting xi of the specified data projection
:rtype: Array of floats

Definition at line 1844 of file iron.py.

def iron.DataProjection.StartingXiSet (   self,
  startingXi 
)
Sets/changes the starting xi of data projection identified an object.

:param startingXi: the absolute starting xi to set
:type startingXi: Array of floats
:rtype: None

Definition at line 1855 of file iron.py.

Member Data Documentation

iron.DataProjection.cmiss_type

Definition at line 1504 of file iron.py.

Property Documentation

iron.DataProjection.absoluteTolerance = property(AbsoluteToleranceGet, AbsoluteToleranceSet, None, )
static

Definition at line 1868 of file iron.py.

iron.DataProjection.label = property(LabelGet, LabelSet, None, )
static

Definition at line 1870 of file iron.py.

iron.DataProjection.maximumIterationUpdate = property(MaximumIterationUpdateGet, MaximumIterationUpdateSet, None, )
static

Definition at line 1872 of file iron.py.

iron.DataProjection.maximumNumberOfIterations = property(MaximumNumberOfIterationsGet, MaximumNumberOfIterationsSet, None, )
static

Definition at line 1866 of file iron.py.

iron.DataProjection.numberOfClosestElements = property(NumberOfClosestElementsGet, NumberOfClosestElementsSet, None, )
static

Definition at line 1874 of file iron.py.

iron.DataProjection.projectionType = property(ProjectionTypeGet, ProjectionTypeSet, None, )
static

Definition at line 1876 of file iron.py.

iron.DataProjection.relativeTolerance = property(RelativeToleranceGet, RelativeToleranceSet, None, )
static

Definition at line 1880 of file iron.py.

iron.DataProjection.startingXi = property(StartingXiGet, StartingXiSet, None, )
static

Definition at line 1878 of file iron.py.