Watershed

Inheritance diagram

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

Classes

Watershed

class ORSModel.ors.Watershed(self)

Bases: Unmanaged

compute(self, watershedDistance: ORSModel.ors.Channel, lOutputChannelLabel: ORSModel.ors.Channel)

Creates a distance map starting from all the providedROI sources.

Parameters:

  • watershedDistance (ORSModel.ors.Channel) – the distance map generated by the Dijkstra algorithm (an Channel)

  • lOutputChannelLabel (ORSModel.ors.Channel) – a label channel, can be NULL (an Channel)

computeAdaptiveSeedsFromROI(self, roiOfMax: ORSModel.ors.ROI, euclidDistance: ORSModel.ors.Channel, aTimeStep: int, IProgress: ORSModel.ors.Progress) → ORSModel.ors.MultiROI

From providedROI containing local maxima and distance map, seeds for watershed are computed.

Parameters:
Returns:

output (ORSModel.ors.MultiROI)

getClassNameStatic() → str

getClassNameStatic

Returns:

output (str)

getNeighborCount(self) → int

Gets the number of neighbors used by theDijkstra algorithm (the connectivity).

Note

Can be 6, 18 or 26

Returns:

output (int) – the number of neighbors (an unsigned char)

getROICount(self) → int

Returns the number of ROIs that have been set as sources.

Note

A maximum of 10 ROI can be provided.

Returns:

output (int) – the number of ROIs that have been provided (an unsigned char)

getVolumeROI(self, index: int) → ORSModel.ors.ROI

Note

A maximum of 10 ROIs can be provided. The ROIs provided must be of the same shape as the input channel.

Parameters:

index (int)

Returns:

output (ORSModel.ors.ROI)

none() → Watershed
Returns:

output (Watershed)

resetVolumeROIs(self)

Empties all the sourceROI slots.

setInputChannelAndWorkingArea(self, inputChannel: ORSModel.ors.Channel, minX: int, minY: int, minZ: int, maxX: int, maxY: int, maxZ: int, currentT: int)

Note

The min and max boundaries must not describe a space bigger than the input channel.

Parameters:

  • inputChannel (ORSModel.ors.Channel)

  • minX (int)

  • minY (int)

  • minZ (int)

  • maxX (int)

  • maxY (int)

  • maxZ (int)

  • currentT (int)

setInputLabelsChannel(self, aInputLabelsChannel: ORSModel.ors.Channel)
Parameters:

aInputLabelsChannel (ORSModel.ors.Channel)

setInputMultiROI(self, anInputMultiROI: ORSModel.ors.MultiROI)
Parameters:

anInputMultiROI (ORSModel.ors.MultiROI)

setMaskROI(self, IMaskROI: ORSModel.ors.ROI)
Parameters:

IMaskROI (ORSModel.ors.ROI)

setNeighborCountTo18(self)

Sets the number of neighbors used by theDijkstra algorithm to 18 ( Neighbor distance <= sqrt(2)).

setNeighborCountTo26(self)

Sets the number of neighbors used by theDijkstra algorithm to 18 ( Neighbor distance <= sqrt(2)).

setNeighborCountTo6(self)

Sets the number of neighbors used by theDijkstra algorithm to 18 ( Neighbor distance <= sqrt(2)).

setProgressObject(self, IProgress: ORSModel.ors.Progress)
Parameters:

IProgress (ORSModel.ors.Progress)

setVolumeROI(self, index: int, aVolROI: ORSModel.ors.ROI)

Note

A maximum of 10 ROIs can be provided. The ROIs provided must be of the same shape as the input channel.

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.

isManaged(self) → bool
Returns:

output (bool)

isNone(self) → bool
Returns:

output (bool)