OrsSimulationMcXRAY_157a2ed0808f11e986b5309c235e8fdb

author:

Dragonfly Team

contact:

https://dragonfly.comet.tech

email:

support.dragonfly@comet.tech

organization:

Comet Technologies Canada Inc.

address:

460 Ste-Catherine Ouest, suite 600, Montréal, Québec, Canada, H3B 1A7

copyright:

Comet Technologies Canada Inc. All rights reserved 2023.

date:

May 27 2019 10:52

dragonflyVersion:

4.1.0.629 (D)

UUID:

157a2ed0808f11e986b5309c235e8fdb

Class Code

class OrsPythonPlugins.OrsSimulationMcXRAY_157a2ed0808f11e986b5309c235e8fdb.OrsSimulationMcXRAY_157a2ed0808f11e986b5309c235e8fdb.OrsSimulationMcXRAY_157a2ed0808f11e986b5309c235e8fdb(*args, **kwargs)
interfacemethod addSolidSimulationScalarValues(multiROI: MultiROI, labelDetails: LabelDetails, labelIndex: int, timestep: int) → bool

Set scalar value of multiROI at labelIndex as labelDetail.

Parameters:

  • multiROI (ORSModel.ors.MultiROI) – a multiROI instance

  • labelDetails (transient LabelDetails) – a LabelDetail to be added

  • labelIndex (int) – label index to be set

  • timestep (int) – time step

Returns:

output (bool) – True if successful, otherwise False

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.

interfacemethod createSolidSimulation() → SolidSimulation

Return a new instance of SolidSimulation

Returns:

aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

interfacemethod cropSampleToClipBoxForSolidSimulation(multiROI: MultiROI, timestep: int) → MultiROI

Crop sample to clip box

Parameters:
Returns:

output (ORSModel.ors.MultiROI) – cropped structured grid

interfacemethod executeForPoints(solidSimulation: SolidSimulation, listOfPoints: List[tuple], microscope: Microscope, aProgress: Progress) → PointResultList

execute the simulation on points

Parameters:

  • solidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • listOfPoints (tuple) [count=[1, None]] – list of point coordinates

  • microscope (transient Microscope) – a microscope

  • aProgress (ORSModel.ors.Progress) – progress object

Returns:

pointResultList (transient PointResultList) – a PointResultList

interfacemethod executeForRuler(solidSimulation: SolidSimulation, listOfPoints: List[tuple], microscope: Microscope, aProgress: Progress) → Tuple[List[Channel], List[Channel], MapResult]

execute the simulation on a ruler

Parameters:

  • solidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • listOfPoints (tuple) [count=[1, None]] – list of point coordinates on a ruler

  • microscope (transient Microscope) – a microscope

  • aProgress (ORSModel.ors.Progress) – progress object

Returns:

  • listBSEChannels (ORSModel.ors.Channel) [count=[0, None]] – list of channels output bse result

  • listEDSChannels (ORSModel.ors.Channel) [count=[0, None]] – list of channels output eds result

  • rulerResult (transient MapResult) – emitted characteristic X-ray intensities

interfacemethod executeOnSurfaceOfRectangle(aSolidSimulation: SolidSimulation, chosenFace: Rectangle, microscope: Microscope, IProgress: Progress) → Tuple[List[Channel], List[Channel], MapResult]

execute the simulation on the rectangle

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • chosenFace (ORSModel.ors.Rectangle) – a rectangle

  • microscope (transient Microscope) – a microscope

  • IProgress (ORSModel.ors.Progress) – progress object

Returns:

  • listBSEChannels (ORSModel.ors.Channel) [count=[0, None]] – list of channels output bse result

  • listEDSChannels (ORSModel.ors.Channel) [count=[0, None]] – list of channels output eds result

  • arrayElementIntensities (transient MapResult) – characteristic intensity for elements

interfacemethod executeSimulation(aSolidSimulation: SolidSimulation) → None

run the simulation fo a given point

Parameters:

aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

interfacemethod exportElectronDetectorResultToCSV(pointResults: PointResultList, detectorIndex: int, outputFileName: str) → Tuple[bool, str]

Export the result of an electron detector into a csv file.

Parameters:

  • pointResults (transient PointResultList) – points results

  • detectorIndex (int) – detector index

  • outputFileName (str) – output file name

Returns:

  • succeed (bool) – succeed or not

  • error (str) – error message

interfacemethod exportXrayDetectorResultToCSV(pointResults: PointResultList, detectorIndex: int, beamEnergy: float, outputFileName: str) → Tuple[bool, str]

Export the result of a Xray detector to a csv file

Parameters:

  • pointResults (transient PointResultList) – points results

  • detectorIndex (int) – detector index

  • beamEnergy (float) – beam energy in eV

  • outputFileName (str) – output file name

Returns:

  • succeed (bool) – succeed or not

  • error (str) – error message

interfacemethod extractEDSMapsAsObjectFromMapResult(xrayDetectorIndex: int, markedElementLinesList: dict, mapResult: MapResult) → Tuple[bool, List[Channel]]

Extract EDS maps for markedElementLinesList from mapResult.

Parameters:

  • xrayDetectorIndex (int) – the index of Xray detector

  • markedElementLinesList (dict) – marked element lines list

  • mapResult (transient MapResult) – map results

Returns:

  • succeed (bool) – true if succeed

  • channelList (ORSModel.ors.Channel) [count=[0, None]] – a list of channels that needs to be published

interfacemethod getBSEResultFromSolidSimulation(aSolidSimulation: SolidSimulation, detectorIndex: int) → float

get the result of the simulation for an electron detector

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • detectorIndex (int) – a int

Returns:

bse (float) – output bse ratio, a float

getCharacteristicIntensitiesForLines(detectorIndex, markedElementLinesList)

Return elementLines (e.g. [‘Al Ka1’, ‘Cu Ka1’]) and the corresponding intensities for all the point (2D array)

getDetectorIndexFromDetectorInstanceForExecuted(detectorInstance)

Return the index for the detector in all selectedForExecuted detectors of the same type.

classmethod getMainFormClass()

Gets the class of the main form

Returns:

output –

getResultsEnergyHistogramLineData(listOfPoints, detectorInstance)

Gets the line data of the results of energy histogram and the related information.

Parameters:

listOfPoints (list of tuples (x, y, z)) – list of points to plot

Returns:

lines – list of lines

getResultsSpectrumDetectedLineData(listOfPoints, detectorInstance)

Gets the line data of the results of spectrum detected (bremsstrahlung, characteristic and total) and the related information.

Parameters:

listOfPoints (list of tuples (x, y, z)) – list of points to plot

Returns:

lines – list of lines

handleChanged(oldState, newState)

This method is called when the state of the application is changed.

Parameters:

  • oldState (str) – name of the old (previous) state

  • newState (str) – name of the new (current) state

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

publishResult(listDetectors, listBSEChannel, listEDSChannel)

Publish the result channels for BSE and EDS.

interfacemethod setSolidSimulationAccumulatorsWindowsMaximumEnergy(aSolidSimulation: SolidSimulation, accumulatorsWindowsMaximumEnergy: float) → None

Set the simulator accumulator windows maximum xRay energy

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • accumulatorsWindowsMaximumEnergy (float) – a float

interfacemethod setSolidSimulationAcquisitionTime(aSolidSimulation: SolidSimulation, acquisitionTime: float) → None

Set the simulator acquisition time

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • acquisitionTime (float) – a float

interfacemethod setSolidSimulationAtomCollisionModel(aSolidSimulation: SolidSimulation, atomCollisionModel: int) → None

Set the simulator Atomic colliusion model

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • atomCollisionModel (int) – a int

interfacemethod setSolidSimulationAtomCrossSectionModel(aSolidSimulation: SolidSimulation, atomCrossSectionModel: int) → None

Set the simulator Atomic cross section model

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • atomCrossSectionModel (int) – a int

interfacemethod setSolidSimulationAtomEnergyLossModel(aSolidSimulation: SolidSimulation, atomEnergyLossModel: int) → None

Set the simulator Atomic energy loss model

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • atomEnergyLossModel (int) – a int

interfacemethod setSolidSimulationAtomMeanIonizationPotentialModel(aSolidSimulation: SolidSimulation, atomMeanIonizationPotentialModel: int) → None

Set the simulator Atomic mean ionization potential model

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • atomMeanIonizationPotentialModel (int) – a int

interfacemethod setSolidSimulationAtomScreeningModel(aSolidSimulation: SolidSimulation, atomScreeningModel: int) → None

Set the simulator Atomic screening model

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • atomScreeningModel (int) – a int

interfacemethod setSolidSimulationBeamCurrent(aSolidSimulation: SolidSimulation, beamCurrent: float) → None

Set the simulator beam current model

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • beamCurrent (float) – a float

interfacemethod setSolidSimulationBeamEnergy(aSolidSimulation: SolidSimulation, beamEnergy: float) → None

Set the simulator beam energy model

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • beamEnergy (float) – a float

interfacemethod setSolidSimulationComputeEnergyHistogram(aSolidSimulation: SolidSimulation, computeEnergyHistogram: bool) → None

Set the simulator so that it simulate the energy histogram of backscattered electrons

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • computeEnergyHistogram (bool) – a bool

interfacemethod setSolidSimulationComputeEnergyLossDistribution(aSolidSimulation: SolidSimulation, computeEnergyLossDistribution: bool) → None

Set compute energy loss distribution or not

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • computeEnergyLossDistribution (bool) – compute energy loss distribution or not

interfacemethod setSolidSimulationComputeXRay(aSolidSimulation: SolidSimulation, computeXRay: bool) → None

Set the simulator so that it simulate the xray emission

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • computeXRay (bool) – a bool

interfacemethod setSolidSimulationElectronSourceDirection(aSolidSimulation: SolidSimulation, electronSourceDirection: Vector3) → None

Set the simulator electron source direction

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • electronSourceDirection (ORSModel.ors.Vector3) – a Vector3 instance

interfacemethod setSolidSimulationElectronSourceSize(aSolidSimulation: SolidSimulation, electronSourceSize: float) → None

Set the simulator electron source size

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • electronSourceSize (float) – a float

interfacemethod setSolidSimulationEnergyHistogramMaximumEnergy(aSolidSimulation: SolidSimulation, energyHistogramMaximumEnergy: float) → None

Set the simulator accumulator windows maximum xRay energy

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • energyHistogramMaximumEnergy (float) – a float

interfacemethod setSolidSimulationEnergyLossDistributionXSize(aSolidSimulation: SolidSimulation, energyLossDistributionXSize: int) → None

Set energy loss distribution X size

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • energyLossDistributionXSize (int) – energy loss distribution X size

interfacemethod setSolidSimulationEnergyLossDistributionXSpacing(aSolidSimulation: SolidSimulation, energyLossDistributionXSpacing: float) → None

Set energy loss distribution X spacing

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • energyLossDistributionXSpacing (float) – energy loss distribution X spacing

interfacemethod setSolidSimulationEnergyLossDistributionYSize(aSolidSimulation: SolidSimulation, energyLossDistributionYSize: int) → None

Set energy loss distribution Y size

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • energyLossDistributionYSize (int) – energy loss distribution Y size

interfacemethod setSolidSimulationEnergyLossDistributionYSpacing(aSolidSimulation: SolidSimulation, energyLossDistributionYSpacing: float) → None

Set energy loss distribution Y spacing

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • energyLossDistributionYSpacing (float) – energy loss distribution Y spacing

interfacemethod setSolidSimulationEnergyLossDistributionZSize(aSolidSimulation: SolidSimulation, energyLossDistributionZSize: int) → None

Set energy loss distribution Z size

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • energyLossDistributionZSize (int) – energy loss distribution Z size

interfacemethod setSolidSimulationEnergyLossDistributionZSpacing(aSolidSimulation: SolidSimulation, energyLossDistributionZSpacing: float) → None

Set energy loss distribution Z spacing

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • energyLossDistributionZSpacing (float) – energy loss distribution Z spacing

interfacemethod setSolidSimulationMultiROI(aSolidSimulation: SolidSimulation, multiROI: MultiROI, timestep: int) → None

Set the multiROI that will be used by the simulator

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • multiROI (ORSModel.ors.MultiROI) – a MultiROI instance

  • timestep (int) – timestep of the simulation

interfacemethod setSolidSimulationNumberEnergyHistogramBin(aSolidSimulation: SolidSimulation, numberEnergyHistogramBin: int) → None

Set the number of bins for energy histogram

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • numberEnergyHistogramBin (int) – a int

interfacemethod setSolidSimulationNumberOfThread(aSolidSimulation: SolidSimulation, numberThreadsToStart: int) → None

Set the simulator thread count time

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • numberThreadsToStart (int) – a int

interfacemethod setSolidSimulationNumberSimulatedElectronTrajectories(aSolidSimulation: SolidSimulation, numberSimulatedElectronTrajectories: int) → None

Set the simulator trajectory count

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • numberSimulatedElectronTrajectories (int) – a int

interfacemethod setSolidSimulationNumberSpectrumChannels(aSolidSimulation: SolidSimulation, channelCount: int) → None

Set the simulator number of channel for xray detector

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • channelCount (int) – a int

interfacemethod setSolidSimulationRandomSeedNumber(aSolidSimulation: SolidSimulation, numberRandomSeed: int) → None

Set the simulator trajectory count

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • numberRandomSeed (int) – a int

interfacemethod setSolidSimulationRegionEnergyLossModel(aSolidSimulation: SolidSimulation, regionEnergyLossModel: int) → None

Set the simulator region energy loss model

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • regionEnergyLossModel (int) – a int

interfacemethod setSolidSimulationXRayCSBremsstrahlungModel(aSolidSimulation: SolidSimulation, xRayCSBremsstrahlungModel: int) → None

Set the simulator xRay Collision Bremsstrahlung model

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • xRayCSBremsstrahlungModel (int) – a int

interfacemethod setSolidSimulationXRayCSCharacteristicModel(aSolidSimulation: SolidSimulation, xRayCSCharacteristicModel: int) → None

Set the simulator xRay Collision characteristic model

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • xRayCSCharacteristicModel (int) – a int

interfacemethod setSolidSimulationXRayMassAbsorptionCoefficientModel(aSolidSimulation: SolidSimulation, xRayMassAbsorptionCoefficientModel: int) → None

Set the simulator XRay mass absorption model

Parameters:

  • aSolidSimulation (transient SolidSimulation) – new SolidSimulation instance

  • xRayMassAbsorptionCoefficientModel (int) – a int