OrsHistogramAnalysis_b8b4e5cba81811ebbb19309c235e8fdb

author:

Dragonfly Team

contact:

https://dragonfly.comet.tech

email:

support.dragonfly@comet.tech

organization:

Comet Technologies Canada Inc.

address:

760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4

copyright:

Comet Technologies Canada Inc. All rights reserved 2023.

date:

Apr 28 2021 07:56

dragonflyVersion:

2021.3.0.1000 (D)

UUID:

b8b4e5cba81811ebbb19309c235e8fdb

Class Code

class OrsPythonPlugins.OrsHistogramAnalysis_b8b4e5cba81811ebbb19309c235e8fdb.OrsHistogramAnalysis_b8b4e5cba81811ebbb19309c235e8fdb.OrsHistogramAnalysis_b8b4e5cba81811ebbb19309c235e8fdb(*args, **kwargs)
cleanup()

Deletes the variables managed by the plugin. It is the place to remove callbacks and other references to Python objects that would prevent them to be garbage collected. This method is called during the process of deletion of the plugin. It calls for the cleanup and deletion of the forms.

convertFromUnitOfHistogramToUnitOfView(valueInUnitOfHistogram, units: DimensionUnit)

Converts the provided value, as contained in the unit of the histogram, to the unit of the view

Parameters:

  • valueInUnitOfHistogram (float) – value expressed in unit of the histogram (in physical units or not)

  • units (DimensionUnit) – value units

Return:

value in unit of the view

Rtype:

float

convertFromUnitOfMeasurementToUnitOfView(valueInUnitOfMeasurement, measurementDimensionUnit)

Converts the provided value, as contained in the unit of the measurement, to the unit of the view

Parameters:

  • valueInUnitOfMeasurement (float) – value expressed in unit of the measurement

  • measurementDimensionUnit (ORSModel.ors.DimensionUnit) – dimension unit associated to the values of the measurement

Return:

value in unit of the view

Rtype:

float

Return:

dimension unit associated to the converted value

Rtype:

ORSModel.ors.DimensionUnit

convertValueFromViewToHistogramUnits(value, units: DimensionUnit)

Converts the given on-screen value to format/units of the histogram

Parameters:

  • value (float) – value as display on screen

  • units (DimensionUnit) – value units

Return:

histogram value

Rtype:

float

convertValueInPhysicalUnitsAndFormat(value, units)

Converts the provided value, as contained in the histogram, to the physical units and formats it

Parameters:

  • value (float) – value as contained in the histogram

  • units (DimensionUnit) – value units

Return:

formatted value in physical units

Rtype:

str

getBinCount()

Gets the bin count used in the histogram

Return:

bin count

Rtype:

int

getClipboardHeader()

Gets the header to write at the beginning of the string to be copied in the clipboard

Return:

clipboard information header

Rtype:

str

classmethod getMainFormClass()

Gets the class of the main form

Returns:

output –

getRepresentationUnitDirtyStamp()

Gets the dirty stamp of the representation unit (how the combination of the unit represented by the histogram and the view are mixed)

Return:

dirty stamp of representation unit

Rtype:

int

classmethod importAllLoggingClasses()

This method is called to make any class extension available for macro playing. It should:

  1. import all class extension;

  2. return a list of classes where logging is supported.

Returns:

output (list of classes) – list of classes where logging is supported by the current plugin

refreshUIFromModel()

Calls the UI to be updated based on the implementation

setAnalyzedObject(newObjectToAnalyze: Managed, histogramGeneratorOptions=None, timestep=0)

Sets the analyzed object

Parameters:
setBinCount(binCount)

Sets the bin count used in the histogram

Parameters:

binCount (int) – bin count