HistogramAnalyzer

Inheritance diagram

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

Classes

HistogramAnalyzer

class ORSModel.ors.HistogramAnalyzer(self)

Bases: Unmanaged

fillHistogram1DFromChannel(self, IHistogramData: ORSModel.ors.HistogramData, IChannel1: ORSModel.ors.Channel, tChannel: int, IROI: ORSModel.ors.ROI, tROI: int)
Parameters:

  • IHistogramData (ORSModel.ors.HistogramData) – the 1D histogram to fill (an HistogramData)

  • IChannel1 (ORSModel.ors.Channel) – the channel (an Channel)

  • tChannel (int) – the t index of the channel (an unsigned int)

  • IROI (ORSModel.ors.ROI) – the ROI specifying what channel voxels to include (an ROI). If this parameter is given as nullptr, all channel voxels will be used.

  • tROI (int) – the t index of the ROI (an unsigned int)

fillHistogram1DFromChannelSubset(self, IHistogramData: ORSModel.ors.HistogramData, IChannel1: ORSModel.ors.Channel, tChannel: int, xmin: int, ymin: int, zmin: int, xmax: int, ymax: int, zmax: int)

Fill a 1D histogram from the channel values, over a subset of the volume.

Parameters:

  • IHistogramData (ORSModel.ors.HistogramData) – the 1D histogram to fill (an HistogramData)

  • IChannel1 (ORSModel.ors.Channel) – the channel (an Channel)

  • tChannel (int) – the t index of the channel (an unsigned int)

  • xmin (int) – the minimal x index of the channel to use (an unsigned int)

  • ymin (int) – the minimal y index of the channel to use (an unsigned int)

  • zmin (int) – the minimal z index of the channel to use (an unsigned int)

  • xmax (int) – the maximal x index of the channel to use (an unsigned int)

  • ymax (int) – the maximal y index of the channel to use (an unsigned int)

  • zmax (int) – the maximal z index of the channel to use (an unsigned int)

fillHistogram1DFromCollection(self, IHistogramData: ORSModel.ors.HistogramData, ICollection1: ORSModel.ors.SequenceableCollection, IFilterCollection: ORSModel.ors.SequenceableCollection, IArrayBinIndexes: ORSModel.ors.ArrayUnsignedLONGLONG)
Parameters:
fillHistogram1DFromCollectionSubset(self, IHistogramData: ORSModel.ors.HistogramData, ICollection1: ORSModel.ors.SequenceableCollection, indexStart: int, indexEnd: int)

Fill a 1D histogram from the collection values, over a subset of the collection.

Parameters:

  • IHistogramData (ORSModel.ors.HistogramData) – the 1D histogram to fill (an HistogramData)

  • ICollection1 (ORSModel.ors.SequenceableCollection) – the collection (a SequenceableCollection)

  • indexStart (int) – the first index of the collection to use (an uint64_t)

  • indexEnd (int) – the last index of the collection to use (an uint64_t)

fillHistogram2DFromChannels(self, IHistogramData: ORSModel.ors.HistogramData, IChannel1: ORSModel.ors.Channel, IChannel2: ORSModel.ors.Channel, tChannel1: int, tChannel2: int, IROI: ORSModel.ors.ROI, tROI: int, IProgress: ORSModel.ors.Progress)
Parameters:

  • IHistogramData (ORSModel.ors.HistogramData) – the 2D histogram to fill (an HistogramData)

  • IChannel1 (ORSModel.ors.Channel) – the channel of the first dimension (an Channel)

  • IChannel2 (ORSModel.ors.Channel) – the channel of the second dimension (an Channel)

  • tChannel1 (int) – the t index of the channel of the first dimension (an unsigned int)

  • tChannel2 (int) – the t index of the channel of the second dimension (an unsigned int)

  • IROI (ORSModel.ors.ROI) – the ROI specifying what channel voxels to include (an ROI). If this parameter is given as nullptr, all channel voxels will be used.

  • tROI (int) – the t index of the ROI (an unsigned int)

  • IProgress (ORSModel.ors.Progress) –

fillHistogram2DFromChannelsSubset(self, IHistogramData: ORSModel.ors.HistogramData, IChannel1: ORSModel.ors.Channel, IChannel2: ORSModel.ors.Channel, tChannel: int, xmin: int, ymin: int, zmin: int, xmax: int, ymax: int, zmax: int)

Fill a 2D histogram from the channels values, over a subset of the volume.

Parameters:

  • IHistogramData (ORSModel.ors.HistogramData) – the 2D histogram to fill (an HistogramData)

  • IChannel1 (ORSModel.ors.Channel) – the channel of the first dimension (an Channel)

  • IChannel2 (ORSModel.ors.Channel) – the channel of the second dimension (an Channel)

  • tChannel (int) – the t index of the channels (an unsigned int)

  • xmin (int) – the minimal x index of the channels to use (an unsigned int)

  • ymin (int) – the minimal y index of the channels to use (an unsigned int)

  • zmin (int) – the minimal z index of the channels to use (an unsigned int)

  • xmax (int) – the maximal x index of the channels to use (an unsigned int)

  • ymax (int) – the maximal y index of the channels to use (an unsigned int)

  • zmax (int) – the maximal z index of the channels to use (an unsigned int)

fillHistogram2DFromCollections(self, IHistogramData: ORSModel.ors.HistogramData, ICollection1: ORSModel.ors.SequenceableCollection, ICollection2: ORSModel.ors.SequenceableCollection, IFilterCollection: ORSModel.ors.SequenceableCollection, IArrayBinIndexes: ORSModel.ors.ArrayUnsignedLONGLONG)
Parameters:
fillHistogram2DFromCollectionsSubset(self, IHistogramData: ORSModel.ors.HistogramData, ICollection1: ORSModel.ors.SequenceableCollection, ICollection2: ORSModel.ors.SequenceableCollection, indexStart: int, indexEnd: int)

Fill a 2D histogram from the collections values, over a subset of the collection.

Parameters:

  • IHistogramData (ORSModel.ors.HistogramData) – the 2D histogram to fill (an HistogramData)

  • ICollection1 (ORSModel.ors.SequenceableCollection) – the collection of the first dimension (a SequenceableCollection)

  • ICollection2 (ORSModel.ors.SequenceableCollection) – the collection of the second dimension (a SequenceableCollection)

  • indexStart (int) – the first index of the collections to use (an uint64_t)

  • indexEnd (int) – the last index of the collections to use (an uint64_t)

getClassNameStatic() → str

getClassNameStatic

Returns:

output (str) –

getOtsuThreshold(self, IHistogramData: ORSModel.ors.HistogramData, dimension: int) → float

Computes the Otsu threshold value along a dimension.

Parameters:

  • IHistogramData (ORSModel.ors.HistogramData) – the ND histogram (an HistogramData)

  • dimension (int) – the dimension along which the threshold is computed (an unsigned int)

Returns:

output (float) –

mapHistogram2DLabels(self, IHistogramData: ORSModel.ors.HistogramData, ILMRHistogramLabels: ORSModel.ors.MultiROI, IChannel1: ORSModel.ors.Channel, IChannel2: ORSModel.ors.Channel, tChannel1: int, tChannel2: int, IROI: ORSModel.ors.ROI, tROI: int, ILMROutput: ORSModel.ors.MultiROI, tLMR: int)
Parameters:

  • IHistogramData (ORSModel.ors.HistogramData) – the 2D histogram (an HistogramData)

  • ILMRHistogramLabels (ORSModel.ors.MultiROI) – the LMR of labels (histogram classification) (an MultiROI)

  • IChannel1 (ORSModel.ors.Channel) – the channel of the first dimension (an Channel)

  • IChannel2 (ORSModel.ors.Channel) – the channel of the second dimension (an Channel)

  • tChannel1 (int) – the t index of the channel of the first dimension (an unsigned int)

  • tChannel2 (int) – the t index of the channel of the second dimension (an unsigned int)

  • IROI (ORSModel.ors.ROI) – the ROI specifying what channel voxels to include (an ROI). If this parameter is given as nullptr, all channel voxels will be used.

  • tROI (int) – the t index of the ROI (an unsigned int)

  • ILMROutput (ORSModel.ors.MultiROI) – the LMR receiving the labels (volume segmentation) (an MultiROI)

  • tLMR (int) – the t index of the LMR (an unsigned int)

none() → HistogramAnalyzer
Returns:

output (HistogramAnalyzer) –

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]) –