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

Submodules

pymcxray.FileFormat.Results.BaseResults module

BaseResults

class pymcxray.FileFormat.Results.BaseResults.BaseResults(path='', basename='MCXRay')

Bases: object

basename

filepath

path

pymcxray.FileFormat.Results.BeamParameters module

MCXRay beam parameters from results file.

class pymcxray.FileFormat.Results.BeamParameters.BeamParameters

Bases: object

acquisitionTime_s

current_A

diameter90_A

gaussianMean

gaussianSigma

incidentEnergy_keV

readFromLines(lines)

tiltAngle_deg

pymcxray.FileFormat.Results.DetectorParameters module

MCXRay detector parameters from results file.

class pymcxray.FileFormat.Results.DetectorParameters.DetectorParameters

Bases: object

angleBetweenDetectorSpecimenNormal_deg

angleBetweenDetectorXAxis_deg

beamDetectorDistance_cm

crystalDensity_g_cm3

crystalName

crystalRadius_cm

crystalThickness_cm

deadLayerThickness_A

diffusionLength_A

noiseEdsDetector_eV

readFromLines(lines)

solidAngle_deg

surfaceQualityFactor

takeoffAngleEffective_deg

takeoffAngleNormalIncidence_deg

thicknessAir_um

thicknessAlWindow_um

thicknessBeWindow_um

thicknessH2O_um

thicknessMoxtek_um

thicknessOil_um

thicknessTiWindow_um

pymcxray.FileFormat.Results.Dump module

MCXRay dump results file.

class pymcxray.FileFormat.Results.Dump.Dump

Bases: object

read(filepath)

pymcxray.FileFormat.Results.ElectronExistResults module

Read electron exit results simulated with MCXRay.

class pymcxray.FileFormat.Results.ElectronExistResults.ElectronDetector

Bases: object

azimuthalAngleRange_deg

detectElectrons(data)

energyRange_keV

maximumAzimuthalAngle_deg

maximumEnergy_keV

maximumPolarAngle_deg

minimumAzimuthalAngle_deg

minimumEnergy_keV

minimumPolarAngle_deg

polarAngleRange_deg

class pymcxray.FileFormat.Results.ElectronExistResults.ElectronExistResults(*args, **kargs)

Bases: pymcxray.FileFormat.Results.BaseResults.BaseResults

data

getEnergyDistribution(numberBins=10)

numberData

read()

pymcxray.FileFormat.Results.ElectronParameters module

MCXRay electron parameters results file.

class pymcxray.FileFormat.Results.ElectronParameters.ElectronParameters

Bases: object

backscatteredRatio

eRatio

internalRatio

meanAzimuthalAngleCollision_deg

meanDistanceBetweenCollisions_A

meanNumberCollisionPerElectrons

meanPolarAngleCollision_deg

numberSimulatedElectrons

readFromLines(lines)

skirtRatio

throughRatio

pymcxray.FileFormat.Results.ElectronResults module

Read ElectronResults MCXRay results file.

class pymcxray.FileFormat.Results.ElectronResults.ElectronResults

Bases: pymcxray.FileFormat.Results.BaseResults.BaseResults

fieldNames

fractionBackscatteredElectrons

fractionInternalElectrons

fractionSkirtedElectrons

fractionTransmittedElectrons

numberBackscatteredElectrons

numberElectronCollisions

numberInternalElectrons

numberSimulatedElectrons

numberSkirtedElectrons

numberTransmittedElectrons

read()

write_hdf5(hdf5_group)

pymcxray.FileFormat.Results.ElectronTrajectoriesResults module

Read MCXray electron trajectories results file.

class pymcxray.FileFormat.Results.ElectronTrajectoriesResults.Collision

Bases: object

collisionType

correctedX_A

correctedY_A

correctedZ_A

energy_keV

indexRegion

x_A

y_A

z_A

class pymcxray.FileFormat.Results.ElectronTrajectoriesResults.ElectronTrajectoriesResults(filepath)

Bases: object

drawXY(title='', corrected=False, x_limit=None, y_limit=None)

drawXZ(title='', corrected=False, theta_deg=0.0, colorType='colorTrajectoryType', trajectoryIndexes=None, x_limit=None, y_limit=None)

drawYZ(title='', corrected=False, x_limit=None, y_limit=None)

getElectronGunPositions_nm()

read(filepath)

write_hdf5(hdf5_group)

class pymcxray.FileFormat.Results.ElectronTrajectoriesResults.Trajectory

Bases: object

addCollision(collision)

collisions

index

trajectoryType

pymcxray.FileFormat.Results.ElectronTrajectoriesResults.run()

pymcxray.FileFormat.Results.ElectronTrajectoriesResults.runAuCThinFilm()

pymcxray.FileFormat.Results.ElectronTrajectoriesResults.runFogging()

pymcxray.FileFormat.Results.ElementParameters module

MCXRay element parameters result file.

class pymcxray.FileFormat.Results.ElementParameters.ElementParameters

Bases: object

pymcxray.FileFormat.Results.Intersections module

MCXRay intersections results file.

class pymcxray.FileFormat.Results.Intersections.Intersections

Bases: object

extractFromLines(lines)

pymcxray.FileFormat.Results.MicroscopeParameters module

MCXRay microscope parameter in results file.

class pymcxray.FileFormat.Results.MicroscopeParameters.MicroscopeParameters

Bases: object

beamParameters

detectorParameters

readFromLines(lines)

pymcxray.FileFormat.Results.ModelParameters module

MCXRay model parameters from results file.

class pymcxray.FileFormat.Results.ModelParameters.ModelParameters

Bases: object

atomCollisionModel

atomCollisionScreeningModel

atomCrossSectionModel

atomCrossSectionScreeningModel

atomElectronRangeModel

atomEnergyLossModel

atomMeanIonizationPotentialModel

atomScreeningModel

bremsstrahlungCrossSectionModel

characterisitcCrossSectionModel

readFromLines(lines)

regionEnergyLossModel

pymcxray.FileFormat.Results.Phirhoz module

MCXRay phirhoz result file.

class pymcxray.FileFormat.Results.Phirhoz.Phirhoz(symbol, shell)

Bases: object

depths_A

intensity

readFromLines(lines)

shell

symbol

values

pymcxray.FileFormat.Results.PhirhozElement module

MCXRay result file phirhoz element.

class pymcxray.FileFormat.Results.PhirhozElement.PhirhozElement

Bases: object

isIonizationShell_K

isIonizationShell_L

isIonizationShell_M

readFromLine(line)

symbol

weightFraction

pymcxray.FileFormat.Results.PhirhozEmittedCharacteristic module

Read PhirhozEmittedCharacteristic file from MCXRay.

class pymcxray.FileFormat.Results.PhirhozEmittedCharacteristic.PhirhozEmittedCharacteristic

Bases: pymcxray.FileFormat.Results.BaseResults.BaseResults

depth_A

depth_nm

fieldNames

phirhozs

read(regionID=0)

write_hdf5(hdf5_group)

pymcxray.FileFormat.Results.PhirhozEmittedCharacteristicThinFilm module

Read mcxray phirhoz thin film emitted results.

class pymcxray.FileFormat.Results.PhirhozEmittedCharacteristicThinFilm.PhirhozEmittedCharacteristicThinFilm

Bases: pymcxray.FileFormat.Results.BaseResults.BaseResults

fieldNames

getIntensity(regionID, atomicSymbol, xrayLine)

intensities

numberRegions

read()

pymcxray.FileFormat.Results.PhirhozGenerated module

MCXRay phirhoz generated result file.

class pymcxray.FileFormat.Results.PhirhozGenerated.PhirhozGenerated

Bases: object

electronParameters

getCharacteristicPhiRhoZ(regionID)

microscopeParameters

modelParameters

numberRegions

read(filepath)

readElectron(lines)

readMicroscope(lines)

readRegions(lines)

readSimulationParameters(lines)

readSolidSimulationModels(lines)

simulationParameters

pymcxray.FileFormat.Results.PhirhozGeneratedCharacteristic module

Read PhirhozGeneratedCharacteristic file from MCXRay program.

class pymcxray.FileFormat.Results.PhirhozGeneratedCharacteristic.PhirhozGeneratedCharacteristic

Bases: pymcxray.FileFormat.Results.BaseResults.BaseResults

depth_A

depth_nm

fieldNames

phirhozs

read(regionID=0)

write_hdf5(hdf5_group)

pymcxray.FileFormat.Results.PhirhozGeneratedCharacteristicThinFilm module

Read mcxray phirhoz thin film generated results.

class pymcxray.FileFormat.Results.PhirhozGeneratedCharacteristicThinFilm.PhirhozGeneratedCharacteristicThinFilm

Bases: pymcxray.FileFormat.Results.BaseResults.BaseResults

fieldNames

getIntensity(regionID, atomicSymbol, xrayLine)

get_subshells()

get_symbols()

intensities

numberRegions

read()

write_hdf5(hdf5_group)

pymcxray.FileFormat.Results.PhirhozRegion module

MCXRay phirhoz results file for a region.

class pymcxray.FileFormat.Results.PhirhozRegion.PhirhozRegion(numberEnergyWindows, numberLayersZ)

Bases: object

readBackgroundPhirhozs(lines)

readCharacteristicPhirhozs(lines)

readElements(lines)

readFromLines(lines)

readPhirhozDistributions(lines)

readRegionVolume(lines)

regionID

pymcxray.FileFormat.Results.RegionParameters module

MCXRay region parameters result file.

class pymcxray.FileFormat.Results.RegionParameters.RegionParameters

Bases: object

elements

layerThickness_A

numberElements

regionID

pymcxray.FileFormat.Results.RegionVolume module

MCXRay result file region volume.

class pymcxray.FileFormat.Results.RegionVolume.RegionVolume

Bases: object

readFromLines(lines)

regionID

pymcxray.FileFormat.Results.SimulationParameters module

MCXRay simulation parameters results file.

class pymcxray.FileFormat.Results.SimulationParameters.SimulationParameters

Bases: object

edsMaximumEnergy_keV

generalizedWalk

interpolationType

maximumLiveTime_s

numberChannels

numberElectrons

numberEnergyWindows

numberLayersX

numberLayersY

numberLayersZ

numberPhotons

readFromLines(lines)

useLiveTime_s

pymcxray.FileFormat.Results.Spectra module

MCXRay spectra result file.

class pymcxray.FileFormat.Results.Spectra.Spectra

Bases: object

getElementSpectra()

getElementSpectrum(regionID, elementName)

getRegionParameters(regionID)

getRegionSpectrum(regionID)

getSpecimenSpectrum()

numberRegions

read(filepath)

readRegion(lines)

readRegions(lines)

readSpecimen(lines)

pymcxray.FileFormat.Results.SpectraEDS module

Read MCXRay spectra EDS results file.

class pymcxray.FileFormat.Results.SpectraEDS.SpectraEDS

Bases: object

characteristicProbability

elements

numberCharateristicPeaks

numberElements

numberSimulatedPhotons

readFileObject(inputFile)

readFilepath(filepath)

readPartialSpectraReferenceSection(lines)

readRegionSpectraSection(lines)

readTestInputSection(lines)

regionID

pymcxray.FileFormat.Results.SpectraEDS.runExample()

pymcxray.FileFormat.Results.Spectrum module

MCXRay spectrum result file.

class pymcxray.FileFormat.Results.Spectrum.Spectrum

Bases: object

backgroundIntensities

characteristicIntensities

energies_keV

intensities

pymcxray.FileFormat.Results.SpectrumEDS module

Read MCXRay EDS spectrm from results file.

class pymcxray.FileFormat.Results.SpectrumEDS.SpectrumEDS(lines=None)

Bases: object

channels

countsList

enegies_keV

readLines(lines)

pymcxray.FileFormat.Results.Tags module

MCXRay tags used in output files.

exception pymcxray.FileFormat.Results.Tags.TagNotFoundError

Bases: ValueError

pymcxray.FileFormat.Results.Tags.findAllTag(tag, lines, contains=None)

pymcxray.FileFormat.Results.Tags.findTag(tag, lines)

pymcxray.FileFormat.Results.XrayIntensities module

Xray intensities result file from MCXRay.

class pymcxray.FileFormat.Results.XrayIntensities.XrayIntensities

Bases: pymcxray.FileFormat.Results.BaseResults.BaseResults

fieldNames

getAtomicNumberLineEnergySets()

getDetectedIntensity(atomicNumber, xrayLine)

getIntensity(data_type, region_id, atomic_number, xray_line)

getIntensityEmitted(atomicNumber, xrayLine, total=True)

getIntensityEmittedDetected(atomicNumber, xrayLine, total=True)

getIntensityGenerated(atomicNumber, xraySubshell, total=False)

getIntensityGeneratedDetected(atomicNumber, xraySubshell)

get_result_types()

get_xray_lines()

intensities

numberIntensities

read()

write_hdf5(hdf5_group)

pymcxray.FileFormat.Results.XraySimulatedSpectraRegion module

description

class pymcxray.FileFormat.Results.XraySimulatedSpectraRegion.XraySimulatedSpectraRegion

Bases: pymcxray.FileFormat.Results.BaseResults.BaseResults

channelNumbers

detectedIntensities

eNetPeak

energiesReference_keV

energies_keV

fieldNames

peakToBackgrpound

peakToBackgrpoundAverage

read(regionID=0)

simulatedIntensities

pymcxray.FileFormat.Results.XraySimulatedSpectraSpecimen module

description

class pymcxray.FileFormat.Results.XraySimulatedSpectraSpecimen.XraySimulatedSpectraSpecimen

Bases: pymcxray.FileFormat.Results.BaseResults.BaseResults

energies_keV

fieldNames

read()

totals

pymcxray.FileFormat.Results.XraySpectraAtomEmittedDetectedLines module

Read MCXRay XraySpectraAtomEmittedDetectedLines file.

class pymcxray.FileFormat.Results.XraySpectraAtomEmittedDetectedLines.XraySpectraAtomEmittedDetectedLines

Bases: pymcxray.FileFormat.Results.BaseResults.BaseResults

characteristics

energies_keV

fieldNames

read(regionID)

pymcxray.FileFormat.Results.XraySpectraRegionEmitted module

Read XraySpectraRegionEmitted mcxray result file.

class pymcxray.FileFormat.Results.XraySpectraRegionEmitted.XraySpectraRegionEmitted

Bases: pymcxray.FileFormat.Results.BaseResults.BaseResults

bremsstrahlungValue_1_ekeVsr(energy_keV)

bremsstrahlung_1_ekeVsr

characteristicValue_1_ekeVsr(energy_keV)

characteristic_1_ekeVsr

energies_keV

fieldnames

read(regionID=0)

totalValue_1_ekeVsr(energy_keV)

total_1_ekeVsr

pymcxray.FileFormat.Results.XraySpectraRegionEmitted.run()

pymcxray.FileFormat.Results.XraySpectraRegionsEmitted module

Read all XraySpectraRegionsEmitted mcxray result files for all regions.

class pymcxray.FileFormat.Results.XraySpectraRegionsEmitted.XraySpectraRegionsEmitted

Bases: pymcxray.FileFormat.Results.XraySpectraRegionEmitted.XraySpectraRegionEmitted

read()

write_hdf5(hdf5_group)

pymcxray.FileFormat.Results.XraySpectraRegionsEmitted.run()

pymcxray.FileFormat.Results.XraySpectraSpecimen module

Read XraySpectraSpecimen MCXRay results file.

class pymcxray.FileFormat.Results.XraySpectraSpecimen.XraySpectraSpecimen

Bases: pymcxray.FileFormat.Results.BaseResults.BaseResults

backgrounds

characteristics

energies_keV

fieldNames

read()

totals

write_hdf5(hdf5_group)

pymcxray.FileFormat.Results.XraySpectraSpecimenEmittedDetected module

Read XraySpectraSpecimenEmittedDetected MCXRay results file.

class pymcxray.FileFormat.Results.XraySpectraSpecimenEmittedDetected.XraySpectraSpecimenEmittedDetected

Bases: pymcxray.FileFormat.Results.BaseResults.BaseResults

backgrounds

characteristics

energies_keV

fieldNames

read()

totals

write_hdf5(hdf5_group)

pymcxray.FileFormat.Results.test_BaseResults module

Tests for the module BaseResults.

class pymcxray.FileFormat.Results.test_BaseResults.TestBaseResults(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module BaseResults.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_basename()

Tests for method basename.

test_init()

Tests for method init.

test_path()

Tests for method path.

pymcxray.FileFormat.Results.test_BeamParameters module

Tests for module BeamParameters.

class pymcxray.FileFormat.Results.test_BeamParameters.TestBeamParameters(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module BeamParameters.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_readFromLines()

Tests for method readFromLines.

pymcxray.FileFormat.Results.test_DetectorParameters module

Tests for module DetectorParameters.

class pymcxray.FileFormat.Results.test_DetectorParameters.TestDetectorParameters(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module DetectorParameters.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_readFromLines()

Tests for method readFromLines.

pymcxray.FileFormat.Results.test_Dump module

Tests for module Dump

class pymcxray.FileFormat.Results.test_Dump.TestDump(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module Dump.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_read()

Tests for method read.

pymcxray.FileFormat.Results.test_ElectronExistResults module

pymcxray.FileFormat.Results.test_ElectronParameters module

Tests for module ElectronParameters.

class pymcxray.FileFormat.Results.test_ElectronParameters.TestElectronParameters(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module ElectronParameters.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_readFromLines()

Tests for method readFromLines.

pymcxray.FileFormat.Results.test_ElectronParameters.getLinesAndReference()

pymcxray.FileFormat.Results.test_ElectronResults module

Tests for the module XraySpectraSpecimen.

class pymcxray.FileFormat.Results.test_ElectronResults.TestElectronResults(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module ElectronResults.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_read()

Tests for method read.

pymcxray.FileFormat.Results.test_ElementParameters module

Tests for the module ElementParameters.

class pymcxray.FileFormat.Results.test_ElementParameters.TestElementParameters(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module ElementParameters.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

pymcxray.FileFormat.Results.test_Intersections module

Tests for module Intersections.

class pymcxray.FileFormat.Results.test_Intersections.TestIntersections(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module Intersections.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_extractFromLines()

Tests for method extractFromLines.

pymcxray.FileFormat.Results.test_MicroscopeParameters module

Tests for module MicroscopeParameters.

class pymcxray.FileFormat.Results.test_MicroscopeParameters.TestMicroscopeParameters(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module MicroscopeParameters.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_readFromLines()

Tests for method readFromLines.

pymcxray.FileFormat.Results.test_MicroscopeParameters.getLinesAndReference()

pymcxray.FileFormat.Results.test_ModelParameters module

ModelParameters

class pymcxray.FileFormat.Results.test_ModelParameters.TestModelParameters(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module ModelParameters.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_readFromLines()

Tests for method readFromLines.

pymcxray.FileFormat.Results.test_ModelParameters.getLinesAndReference()

pymcxray.FileFormat.Results.test_Phirhoz module

Tests for the module Phirhoz.

class pymcxray.FileFormat.Results.test_Phirhoz.TestPhirhoz(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module Phirhoz.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_readFromLines()

Tests for method readFromLines.

pymcxray.FileFormat.Results.test_Phirhoz.getLinesAndReference(path)

pymcxray.FileFormat.Results.test_PhirhozElement module

Tests for the module PhirhozElement.

class pymcxray.FileFormat.Results.test_PhirhozElement.TestPhirhozElement(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module PhirhozElement.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_readFromLine()

Tests for method readFromLines.

pymcxray.FileFormat.Results.test_PhirhozElement.getLineAndReference()

pymcxray.FileFormat.Results.test_PhirhozEmittedCharacteristic module

Tests for the module PhirhozEmittedCharacteristic.

class pymcxray.FileFormat.Results.test_PhirhozEmittedCharacteristic.TestPhirhozEmittedCharacteristic(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module PhirhozEmittedCharacteristic.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_read()

Tests for method read.

pymcxray.FileFormat.Results.test_PhirhozEmittedCharacteristicThinFilm module

Tests for module PhirhozEmittedCharacteristicThinFilm.

class pymcxray.FileFormat.Results.test_PhirhozEmittedCharacteristicThinFilm.TestPhirhozEmittedCharacteristicThinFilm(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module PhirhozEmittedCharacteristicThinFilm.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_getIntensity()

Tests for method getIntensity.

test_read()

Tests for method read.

pymcxray.FileFormat.Results.test_PhirhozGenerated module

Tests for the module PhirhozGenerated.#

class pymcxray.FileFormat.Results.test_PhirhozGenerated.TestPhirhozGenerated(methodName='runTest')

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_read()

Tests for method read.

pymcxray.FileFormat.Results.test_PhirhozGeneratedCharacteristic module

Tests for the module PhirhozGeneratedCharacteristic.

class pymcxray.FileFormat.Results.test_PhirhozGeneratedCharacteristic.TestPhirhozGeneratedCharacteristic(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module PhirhozGeneratedCharacteristic.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_read()

Tests for method read.

pymcxray.FileFormat.Results.test_PhirhozGeneratedCharacteristicThinFilm module

Tests for module PhirhozGeneratedCharacteristicThinFilm.

class pymcxray.FileFormat.Results.test_PhirhozGeneratedCharacteristicThinFilm.TestPhirhozGeneratedCharacteristicThinFilm(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module PhirhozGeneratedCharacteristicThinFilm.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_getIntensity()

Tests for method getIntensity.

test_read()

Tests for method read.

pymcxray.FileFormat.Results.test_PhirhozRegion module

Tests for the module PhirhozRegion.

class pymcxray.FileFormat.Results.test_PhirhozRegion.TestPhirhozRegion(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module PhirhozRegion.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_readFromLines()

Tests for method readFromLines.

pymcxray.FileFormat.Results.test_PhirhozRegion.getLinesAndReference(path)

pymcxray.FileFormat.Results.test_RegionParameters module

Tests for the module RegionParameters.

class pymcxray.FileFormat.Results.test_RegionParameters.TestRegionParameters(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module RegionParameters.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

pymcxray.FileFormat.Results.test_RegionVolume module

Tests for the module RegionVolume.

class pymcxray.FileFormat.Results.test_RegionVolume.TestRegionVolume(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module RegionVolume.

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.

NOtest_readFromLines()

Tests for method readFromLines.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

pymcxray.FileFormat.Results.test_RegionVolume.getLinesAndReference()

pymcxray.FileFormat.Results.test_SimulationParameters module

Tests for the module SimulationParameters.

class pymcxray.FileFormat.Results.test_SimulationParameters.TestSimulationParameters(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module SimulationParameters.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_readFromLines()

Tests for method readFromLines.

pymcxray.FileFormat.Results.test_SimulationParameters.getLinesAndReference()

pymcxray.FileFormat.Results.test_Spectra module

Tests for the module Spectra.

class pymcxray.FileFormat.Results.test_Spectra.TestSpectra(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module Spectra.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test__extractElementHeader()

Tests for method _extractElementHeader.

test__extractRegionHeader()

Tests for method _extractRegionHeader.

test_read()

Tests for method read.

test_readRegion()

Tests for method readRegion.

test_readSpecimen()

Tests for method readSpecimen.

pymcxray.FileFormat.Results.test_SpectraEDS module

Tests for module SpectraEDS.

class pymcxray.FileFormat.Results.test_SpectraEDS.TestSpectraEDS(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module SpectraEDS.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_FindTestData()

Tests for method FindTestData.

test__extractTotalCounts()

Tests for method _extractTotalCounts.

test__isPartialSpectraReferenceSection()

Tests for method _isTestInputSection.

test__isRegionSpectraSection()

Tests for method _isRegionSpectraSection.

test__isTestInputSection()

Tests for method _isTestInputSection.

test_readPartialSpectraReferenceSection()

Tests for method readTestInputSection.

test_readRegionSpectraSection()

Tests for method readRegionSpectraSection.

test_readTestInputSection()

Tests for method readTestInputSection.

pymcxray.FileFormat.Results.test_Spectrum module

Tests for the module Spectrum

class pymcxray.FileFormat.Results.test_Spectrum.TestSpectrum(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module Spectrum.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

pymcxray.FileFormat.Results.test_Tags module

Tests for the modules Tags.

class pymcxray.FileFormat.Results.test_Tags.TestTags(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module Tags.

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.

getLines()

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_findTag()

Tests for method findTag.

pymcxray.FileFormat.Results.test_XrayIntensities module

Tests for the module XrayIntensities.

class pymcxray.FileFormat.Results.test_XrayIntensities.TestXrayIntensities(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module XrayIntensities.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_read()

Tests for method read.

pymcxray.FileFormat.Results.test_XraySimulatedSpectraRegion module

description

class pymcxray.FileFormat.Results.test_XraySimulatedSpectraRegion.TestXraySimulatedSpectraRegion(methodName='runTest')

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_read()

Tests for method read.

pymcxray.FileFormat.Results.test_XraySimulatedSpectraSpecimen module

class pymcxray.FileFormat.Results.test_XraySimulatedSpectraSpecimen.TestXraySimulatedSpectraSpecimen(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module XraySimulatedSpectraSpecimen.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_read()

Tests for method read.

pymcxray.FileFormat.Results.test_XraySpectraAtomEmittedDetectedLines module

Tests for the module XraySpectraAtomEmittedDetectedLines.

class pymcxray.FileFormat.Results.test_XraySpectraAtomEmittedDetectedLines.TestXraySpectraAtomEmittedDetectedLines(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module XraySpectraAtomEmittedDetectedLines.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_read()

Tests for method read.

pymcxray.FileFormat.Results.test_XraySpectraRegionEmitted module

pymcxray.FileFormat.Results.test_XraySpectraRegionsEmitted module

pymcxray.FileFormat.Results.test_XraySpectraSpecimen module

Tests for the module XraySpectraSpecimen.

class pymcxray.FileFormat.Results.test_XraySpectraSpecimen.TestXraySpectraSpecimen(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module XraySpectraSpecimen.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_read()

Tests for method read.

pymcxray.FileFormat.Results.test_XraySpectraSpecimenEmittedDetected module

Tests for the module XraySpectraSpecimenEmittedDetected.

class pymcxray.FileFormat.Results.test_XraySpectraSpecimenEmittedDetected.TestXraySpectraSpecimenEmittedDetected(methodName='runTest')

Bases: unittest.case.TestCase

TestCase class for the module XraySpectraSpecimenEmittedDetected.

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.

setUp()

Setup method.

tearDown()

Teardown method.

testSkeleton()

First test to check if the testcase is working with the testing framework.

test_read()

Tests for method read.

pymcxray.FileFormat.Results.tests module

Module contents