TraceBackChannelAnalyzer

Inheritance diagram

Inheritance diagram of ORSModel.ors.TraceBackChannelAnalyzer, ORSModel.ors.Unmanaged, ORSModel.ors.ORSBaseClass

Classes

TraceBackChannelAnalyzer

class ORSModel.ors.TraceBackChannelAnalyzer(self)

Bases: Unmanaged

findAllLeaves(self, aChannel: ORSModel.ors.Channel, inputROI: ORSModel.ors.ROI) → ORSModel.ors.ROI
Parameters:
Returns:

output (ORSModel.ors.ROI) –

forwardSelectionFromRoi(self, linputChannelTraceForward: ORSModel.ors.Channel, inputROI: ORSModel.ors.ROI, outputROI: ORSModel.ors.ROI)
Parameters:
forwardSelectionFromRoiToDistance(self, linputChannelTraceForward: ORSModel.ors.Channel, inputROI: ORSModel.ors.ROI, outputROI: ORSModel.ors.ROI, distance: int)
Parameters:
getClassNameStatic() → str

getClassNameStatic

Returns:

output (str) –

none() → TraceBackChannelAnalyzer
Returns:

output (TraceBackChannelAnalyzer) –

selectPointFurtherOrNearerThanMinDistance(self, linputChannelTraceBack: ORSModel.ors.Channel, indices: int, indicesSize: int, minDistance: int, outputROI: ORSModel.ors.ROI, further: bool)
Parameters:
traceBackTotraceForward(self, linputChannelTraceBack: ORSModel.ors.Channel, loutputChannelTraceForward: ORSModel.ors.Channel)
Parameters:
tracebackCPU(self, linputChannelTraceBack: ORSModel.ors.Channel, inputROI: ORSModel.ors.ROI, outputROI: ORSModel.ors.ROI, outputVoteChannel: ORSModel.ors.Channel, gatherAlgo: bool) → ORSModel.ors.ROI
Parameters:
Returns:

output (ORSModel.ors.ROI) –

tracebackPath(self, linputChannelTraceBack: ORSModel.ors.Channel, worldPosition: ORSModel.ors.Vector3, aPath: ORSModel.ors.VisualPath, pathWorldMatrix: ORSModel.ors.Matrix4x4, gatherAlgo: bool)
Parameters:

Unmanaged

class ORSModel.ors.Unmanaged

Bases: ORSBaseClass

Abstract class for objects that are not managed by the core library. Unmanaged objects are transient objects.

atomicLoad(sFilename: str) → Unmanaged

Creates an object from a file where an object was saved.

Parameters:

sFilename (str) – path of the file to load

Returns:

output (Unmanaged) – an unmanaged object, or none() if the load fails

atomicSave(self, aFilename: str) → int

Saves the object to a file.

Parameters:

aFilename (str) – path of the file to save

Returns:

output (int) – 0 if successful, otherwise an error code

createFromPythonRepresentation(aPythonRepresentation: str) → ORSModel.ors.Unmanaged

Create aUnmanaged Object from a python representation a static method.

Parameters:

aPythonRepresentation (str) –

Returns:

output (ORSModel.ors.Unmanaged) –

fromPythonRepresentation(self, aPythonRepresentation: str) → bool

Create aUnmanaged object from a Python string representation.

Parameters:

aPythonRepresentation (str) – a Python evaluable string representation (a string)

Returns:

output (bool) – true if parsing worked, false otherwise (a bool)

getClassName(self) → str

Retrieves the class name of the core object wrapped by this Interface object.

Returns:

output (str) –

getClassNameStatic() → str

getClassNameStatic

Returns:

output (str) –

getDataChecksum(self) → str
Returns:

output (str) –

getIsInstanceOf(self, pProgId: str) → bool

Queries the object to know if it is an instance of a certain class.

Parameters:

pProgId (str) –

Returns:

output (bool) –

getPythonRepresentation(self) → str

Gets a Python evaluable string representation.

Returns:

output (str) –

isNone(self) → bool

Checks if the receiver is none.

Returns:

output (bool) –

isNotNone(self) → bool

Checks if the receiver is not none.

Returns:

output (bool) –

none() → Unmanaged
Returns:

output (Unmanaged) –

ORSBaseClass

class ORSModel.ors.ORSBaseClass

An abstract class from which all objects issued from the ORS Core Library inherit.

getPythonTraceBack() → List[str]

Set the python traceback for a call from python.

Returns:

output (List[str]) –

isManaged(self) → bool
Returns:

output (bool) –

isNone(self) → bool
Returns:

output (bool) –

setPythonTraceBack(tb: List[str])

Set the python traceback for a call from python.

Parameters:

tb (List[str]) –