pymcxray.FileFormat package¶
Subpackages¶
- pymcxray.FileFormat.Results package
- Subpackages
- pymcxray.FileFormat.Results.exported package
- Submodules
- pymcxray.FileFormat.Results.exported.DataMap module
- pymcxray.FileFormat.Results.exported.XrayIntensityXY module
- pymcxray.FileFormat.Results.exported.test_DataMap module
- pymcxray.FileFormat.Results.exported.test_XrayIntensityXY module
- pymcxray.FileFormat.Results.exported.tests module
- Module contents
- pymcxray.FileFormat.Results.exported package
- Submodules
- pymcxray.FileFormat.Results.BaseResults module
- pymcxray.FileFormat.Results.BeamParameters module
- pymcxray.FileFormat.Results.DetectorParameters module
- pymcxray.FileFormat.Results.Dump module
- pymcxray.FileFormat.Results.ElectronExistResults module
- pymcxray.FileFormat.Results.ElectronParameters module
- pymcxray.FileFormat.Results.ElectronResults module
- pymcxray.FileFormat.Results.ElectronTrajectoriesResults module
- pymcxray.FileFormat.Results.ElementParameters module
- pymcxray.FileFormat.Results.Intersections module
- pymcxray.FileFormat.Results.MicroscopeParameters module
- pymcxray.FileFormat.Results.ModelParameters module
- pymcxray.FileFormat.Results.Phirhoz module
- pymcxray.FileFormat.Results.PhirhozElement module
- pymcxray.FileFormat.Results.PhirhozEmittedCharacteristic module
- pymcxray.FileFormat.Results.PhirhozEmittedCharacteristicThinFilm module
- pymcxray.FileFormat.Results.PhirhozGenerated module
- pymcxray.FileFormat.Results.PhirhozGeneratedCharacteristic module
- pymcxray.FileFormat.Results.PhirhozGeneratedCharacteristicThinFilm module
- pymcxray.FileFormat.Results.PhirhozRegion module
- pymcxray.FileFormat.Results.RegionParameters module
- pymcxray.FileFormat.Results.RegionVolume module
- pymcxray.FileFormat.Results.SimulationParameters module
- pymcxray.FileFormat.Results.Spectra module
- pymcxray.FileFormat.Results.SpectraEDS module
- pymcxray.FileFormat.Results.Spectrum module
- pymcxray.FileFormat.Results.SpectrumEDS module
- pymcxray.FileFormat.Results.Tags module
- pymcxray.FileFormat.Results.XrayIntensities module
- pymcxray.FileFormat.Results.XraySimulatedSpectraRegion module
- pymcxray.FileFormat.Results.XraySimulatedSpectraSpecimen module
- pymcxray.FileFormat.Results.XraySpectraAtomEmittedDetectedLines module
- pymcxray.FileFormat.Results.XraySpectraRegionEmitted module
- pymcxray.FileFormat.Results.XraySpectraRegionsEmitted module
- pymcxray.FileFormat.Results.XraySpectraSpecimen module
- pymcxray.FileFormat.Results.XraySpectraSpecimenEmittedDetected module
- pymcxray.FileFormat.Results.test_BaseResults module
- pymcxray.FileFormat.Results.test_BeamParameters module
- pymcxray.FileFormat.Results.test_DetectorParameters module
- pymcxray.FileFormat.Results.test_Dump module
- pymcxray.FileFormat.Results.test_ElectronExistResults module
- pymcxray.FileFormat.Results.test_ElectronParameters module
- pymcxray.FileFormat.Results.test_ElectronResults module
- pymcxray.FileFormat.Results.test_ElementParameters module
- pymcxray.FileFormat.Results.test_Intersections module
- pymcxray.FileFormat.Results.test_MicroscopeParameters module
- pymcxray.FileFormat.Results.test_ModelParameters module
- pymcxray.FileFormat.Results.test_Phirhoz module
- pymcxray.FileFormat.Results.test_PhirhozElement module
- pymcxray.FileFormat.Results.test_PhirhozEmittedCharacteristic module
- pymcxray.FileFormat.Results.test_PhirhozEmittedCharacteristicThinFilm module
- pymcxray.FileFormat.Results.test_PhirhozGenerated module
- pymcxray.FileFormat.Results.test_PhirhozGeneratedCharacteristic module
- pymcxray.FileFormat.Results.test_PhirhozGeneratedCharacteristicThinFilm module
- pymcxray.FileFormat.Results.test_PhirhozRegion module
- pymcxray.FileFormat.Results.test_RegionParameters module
- pymcxray.FileFormat.Results.test_RegionVolume module
- pymcxray.FileFormat.Results.test_SimulationParameters module
- pymcxray.FileFormat.Results.test_Spectra module
- pymcxray.FileFormat.Results.test_SpectraEDS module
- pymcxray.FileFormat.Results.test_Spectrum module
- pymcxray.FileFormat.Results.test_Tags module
- pymcxray.FileFormat.Results.test_XrayIntensities module
- pymcxray.FileFormat.Results.test_XraySimulatedSpectraRegion module
- pymcxray.FileFormat.Results.test_XraySimulatedSpectraSpecimen module
- pymcxray.FileFormat.Results.test_XraySpectraAtomEmittedDetectedLines module
- pymcxray.FileFormat.Results.test_XraySpectraRegionEmitted module
- pymcxray.FileFormat.Results.test_XraySpectraRegionsEmitted module
- pymcxray.FileFormat.Results.test_XraySpectraSpecimen module
- pymcxray.FileFormat.Results.test_XraySpectraSpecimenEmittedDetected module
- pymcxray.FileFormat.Results.tests module
- Module contents
- Subpackages
Submodules¶
pymcxray.FileFormat.Element module¶
MCXRay element input file.
pymcxray.FileFormat.ExportedSpectrum module¶
Read and write exported spectrum from McXRay.
pymcxray.FileFormat.FileReaderWriterTools module¶
description
pymcxray.FileFormat.MCXRayModel module¶
Model type used in MCXRay.
-
class
pymcxray.FileFormat.MCXRayModel.
AtomCollisionModel
(currentModel=None)[source]¶ Bases:
pymcxray.FileFormat.MCXRayModel.MCXRayModel
-
TYPE_BROWNING
= 1¶
-
TYPE_GAUVIN
= 2¶
-
TYPE_RUTHERFORD
= 0¶
-
-
class
pymcxray.FileFormat.MCXRayModel.
AtomCollisionScreeningModel
(currentModel=None)[source]¶ Bases:
pymcxray.FileFormat.MCXRayModel.MCXRayModel
-
TYPE_HENOC_MAURICE
= 0¶
-
-
class
pymcxray.FileFormat.MCXRayModel.
AtomCrossSectionModel
(currentModel=None)[source]¶ Bases:
pymcxray.FileFormat.MCXRayModel.MCXRayModel
-
TYPE_BROWNING
= 0¶
-
TYPE_GAUVIN_DROUIN
= 1¶
-
-
class
pymcxray.FileFormat.MCXRayModel.
AtomCrossSectionScreeningModel
(currentModel=None)[source]¶ Bases:
pymcxray.FileFormat.MCXRayModel.MCXRayModel
-
TYPE_HENOC_MAURICE
= 0¶
-
-
class
pymcxray.FileFormat.MCXRayModel.
AtomElectronRangeModel
(currentModel=None)[source]¶ Bases:
pymcxray.FileFormat.MCXRayModel.MCXRayModel
-
TYPE_KANAYA_OKAYAMA
= 0¶
-
-
class
pymcxray.FileFormat.MCXRayModel.
AtomEnergyLossModel
(currentModel=None)[source]¶ Bases:
pymcxray.FileFormat.MCXRayModel.MCXRayModel
-
TYPE_BETHE
= 0¶
-
-
class
pymcxray.FileFormat.MCXRayModel.
AtomMeanIonizationPotentialModel
(currentModel=None)[source]¶ Bases:
pymcxray.FileFormat.MCXRayModel.MCXRayModel
-
TYPE_JOY_LUO
= 0¶
-
-
class
pymcxray.FileFormat.MCXRayModel.
AtomScreeningModel
(currentModel=None)[source]¶ Bases:
pymcxray.FileFormat.MCXRayModel.MCXRayModel
-
TYPE_HENOC_MAURICE
= 0¶
-
-
class
pymcxray.FileFormat.MCXRayModel.
MassAbsorptionCoefficientModel
(currentModel=None)[source]¶ Bases:
pymcxray.FileFormat.MCXRayModel.MCXRayModel
-
TYPE_CHANTLER2005
= 3¶
-
TYPE_HEINRICH_DATA
= 1¶
-
TYPE_HEINRICH_PARAMETERIZATION
= 2¶
-
TYPE_HENKE
= 0¶
-
-
class
pymcxray.FileFormat.MCXRayModel.
RegionEnergyLossModel
(currentModel=None)[source]¶ Bases:
pymcxray.FileFormat.MCXRayModel.MCXRayModel
-
TYPE_BETHE
= 1¶
-
TYPE_BETHE_JOY_LUO
= 0¶
-
TYPE_BETHE_RELATIVISTIC
= 2¶
-
TYPE_JOY_LUO_KGAUVIN
= 3¶
-
TYPE_JOY_LUO_MONSEL
= 4¶
-
-
class
pymcxray.FileFormat.MCXRayModel.
SampleEnergyLossModel
(currentModel=None)[source]¶ Bases:
pymcxray.FileFormat.MCXRayModel.MCXRayModel
-
TYPE_BETHE_JOY_LUO
= 0¶
-
-
class
pymcxray.FileFormat.MCXRayModel.
SpectrumInterpolationModel
(currentModel=None)[source]¶ Bases:
pymcxray.FileFormat.MCXRayModel.MCXRayModel
-
TYPE_COPY
= 0¶
-
TYPE_LINEAR
= 1¶
-
TYPE_LINEAR_DOUBLE
= 2¶
-
TYPE_SPLINE
= 3¶
-
TYPE_SPLINE_BATCH
= 4¶
-
TYPE_SPLINE_POINT
= 5¶
-
-
class
pymcxray.FileFormat.MCXRayModel.
XRayCSBremsstrahlungModel
(currentModel=None)[source]¶ Bases:
pymcxray.FileFormat.MCXRayModel.MCXRayModel
-
TYPE_BETHE_HEITLER
= 0¶
-
TYPE_DING
= 2¶
-
TYPE_GAUVIN
= 3¶
-
TYPE_KIRKPATRICK_WIEDMAN
= 1¶
-
-
class
pymcxray.FileFormat.MCXRayModel.
XRayCSCharacteristicModel
(currentModel=None)[source]¶ Bases:
pymcxray.FileFormat.MCXRayModel.MCXRayModel
-
TYPE_BOTE2009
= 1¶
-
TYPE_CASTANI1982
= 0¶
-
pymcxray.FileFormat.MicroscopeParameters module¶
MCXRay microscope parameters input file.
-
class
pymcxray.FileFormat.MicroscopeParameters.
MicroscopeParameters
[source]¶ Bases:
object
-
beamCurrent_A
¶
-
beamDiameter_A
¶
-
beamEnergy_keV
¶
-
beamPositionX_A
¶
-
beamPositionY_A
¶
-
beamStandardDeviation_A
¶
-
beamTilt_deg
¶
-
detectorAzimuthalAngle_deg
¶
-
detectorBFHigh_rad
¶
-
detectorBFLow_rad
¶
-
detectorChannelWidth_eV
¶
-
detectorCrystalAtomSymbol
¶
-
detectorCrystalDistance_cm
¶
-
detectorCrystalRadius_cm
¶
-
detectorCrystalThickness_cm
¶
-
detectorDFHigh_rad
¶
-
detectorDFLow_rad
¶
-
detectorDeadLayer_A
¶
-
detectorDiffusionLenght_A
¶
-
detectorHAADFHigh_rad
¶
-
detectorHAADFLow_rad
¶
-
detectorNoise_eV
¶
-
detectorPitch_deg
¶
-
detectorSurfaceQuality
¶
-
detectorTOA_deg
¶
-
time_s
¶
-
version
¶
-
pymcxray.FileFormat.Models module¶
MCXRay models file.
pymcxray.FileFormat.Region module¶
MCXRay region input file.
pymcxray.FileFormat.RegionDimensions module¶
MCXRay region dimensions input file.
-
class
pymcxray.FileFormat.RegionDimensions.
RegionDimensionsBox
(parameters=None)[source]¶ Bases:
pymcxray.FileFormat.RegionDimensions.RegionDimensions
-
maximumX
¶
-
maximumY
¶
-
maximumZ
¶
-
minimumX
¶
-
minimumY
¶
-
minimumZ
¶
-
-
class
pymcxray.FileFormat.RegionDimensions.
RegionDimensionsCylinder
(parameters=None)[source]¶ Bases:
pymcxray.FileFormat.RegionDimensions.RegionDimensionsSphere
-
directionX
¶
-
directionY
¶
-
directionZ
¶
-
length
¶
-
pymcxray.FileFormat.RegionType module¶
MCXRay region type input file.
pymcxray.FileFormat.ResultsParameters module¶
MCXRay ResultsParameters input file.
pymcxray.FileFormat.SimulationInputs module¶
MCXRay simulation inputs file.
pymcxray.FileFormat.SimulationParameters module¶
MCXRay simulation parameters input file.
-
class
pymcxray.FileFormat.SimulationParameters.
SimulationParameters
[source]¶ Bases:
object
-
baseFilename
¶
-
elasticCrossSectionScalingFactor
¶
-
energyChannelWidth_eV
¶
-
energyLossScalingFactor
¶
-
numberChannels
¶
-
numberElectrons
¶
-
numberFilmsX
¶
-
numberFilmsY
¶
-
numberFilmsZ
¶
-
numberPhotons
¶
-
numberWindows
¶
-
spectrumInterpolationModel
¶
-
version
¶
-
voxelSimplification
¶
-
pymcxray.FileFormat.SnrParameters module¶
MCXRay Snr input file.
pymcxray.FileFormat.Specimen module¶
MCXRay specimen input file.
pymcxray.FileFormat.Version module¶
MCXray version information.
pymcxray.FileFormat.testUtilities module¶
Utilities used for testing this package.
pymcxray.FileFormat.test_Element module¶
Tests for module Element.
-
class
pymcxray.FileFormat.test_Element.
TestElement
(methodName='runTest')[source]¶ Bases:
unittest.case.TestCase
TestCase class for the module Element.
Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.
pymcxray.FileFormat.test_ExportedSpectrum module¶
Tests for module ExportedSpectrum.
-
class
pymcxray.FileFormat.test_ExportedSpectrum.
TestExportedSpectrum
(methodName='runTest')[source]¶ Bases:
unittest.case.TestCase
TestCase class for the module moduleName.
Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.
pymcxray.FileFormat.test_FileReaderWriterTools module¶
Tests for the module FileReaderWriterTools.
-
class
pymcxray.FileFormat.test_FileReaderWriterTools.
TestFileReaderWriterTools
(methodName='runTest')[source]¶ Bases:
unittest.case.TestCase
TestCase class for the module FileReaderWriterTools.
Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.
pymcxray.FileFormat.test_MCXRayModel module¶
Tests for module MCXRayModel.
-
class
pymcxray.FileFormat.test_MCXRayModel.
TestMCXRayModel
(methodName='runTest')[source]¶ Bases:
unittest.case.TestCase
TestCase class for the module MCXRayModel.
Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.
pymcxray.FileFormat.test_MicroscopeParameters module¶
pymcxray.FileFormat.test_Models module¶
pymcxray.FileFormat.test_Region module¶
Tests for module Region.
-
class
pymcxray.FileFormat.test_Region.
TestRegion
(methodName='runTest')[source]¶ Bases:
unittest.case.TestCase
TestCase class for the module moduleName.
Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.
pymcxray.FileFormat.test_RegionDimensions module¶
Tests for module RegionDimensions.
-
class
pymcxray.FileFormat.test_RegionDimensions.
TestRegionDimensions
(methodName='runTest')[source]¶ Bases:
unittest.case.TestCase
TestCase class for the module RegionDimensions.
Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.
-
test_RegionDimensionsCylinder_createLineOldVersion
()[source]¶ Tests for class RegionDimensionsCylinder.
-
test_RegionDimensionsCylinder_createLineWithKey
()[source]¶ Tests for class RegionDimensionsCylinder.
-
test_RegionDimensionsCylinder_extractFromLineOldVersion
()[source]¶ Tests for class RegionDimensionsCylinder.
-
test_RegionDimensionsCylinder_extractFromLinesWithKey
()[source]¶ Tests for class RegionDimensionsCylinder.
-
test_RegionDimensionsSphere_extractFromLineOldVersion
()[source]¶ Tests for class RegionDimensionsSphere.
-
pymcxray.FileFormat.test_RegionType module¶
Test for module RegionType.
-
class
pymcxray.FileFormat.test_RegionType.
TestRegionType
(methodName='runTest')[source]¶ Bases:
unittest.case.TestCase
TestCase class for the module RegionType.
Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.
pymcxray.FileFormat.test_ResultsParameters module¶
pymcxray.FileFormat.test_SimulationInputs module¶
pymcxray.FileFormat.test_SimulationParameters module¶
pymcxray.FileFormat.test_SnrParameters module¶
Tests for the module SnrParameters.
-
class
pymcxray.FileFormat.test_SnrParameters.
TestSnrParameters
(methodName='runTest')[source]¶ Bases:
unittest.case.TestCase
TestCase class for the module SnrParameters.
Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.
pymcxray.FileFormat.test_Specimen module¶
pymcxray.FileFormat.test_Version module¶
Tests for module Version.
-
class
pymcxray.FileFormat.test_Version.
TestVersion
(methodName='runTest')[source]¶ Bases:
unittest.case.TestCase
TestCase class for the module Version.
Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.