photonspectra – Figures of the photon spectra collected by the detectors

class penelopetools.api.figure.penepma.photonspectra.PhotonBremsstrahlungSpectra(results)

Bases: penelopetools.api.figure.penepma.photonspectra.PhotonSpectra

This class is a dictionary where the keys are the index of the detector which value is the spectrum figure. The first detector as a key of 1. The figure are derived from PhotonSpectrum.

When this class is instantiated, the figures are not drawn. As any other _Figure, the method load() must be called. This method creates the figures for all the spectra.

Parameters:results (_PhotonSpectra) – photon spectra results

SUFFIX = 'bremsstrahlung'

class penelopetools.api.figure.penepma.photonspectra.PhotonConvolutedSpectra(results)

Bases: penelopetools.api.figure.penepma.photonspectra.PhotonSpectra

Draws and stores all the figures of the full convoluted photon spectra. The results to draw the figures are coming from the full convoluted photon spectra results (PhotonConvolutedSpectra).

This class is a dictionary where the keys are the index of the detector which value is the spectrum figure. The first detector as a key of 1. The figure are derived from PhotonSpectrum.

When this class is instantiated, the figures are not drawn. As any other _Figure, the method load() must be called. This method creates the figures for all the spectra.

Parameters:results (_PhotonSpectra) – photon spectra results

SUFFIX = 'convol'

class penelopetools.api.figure.penepma.photonspectra.PhotonSpectra(results)

Bases: dict, penelopetools.api.figure._Figures

Draws and stores all the figures of photon spectra. The results to draw the figures are coming from the photon spectra results (_PhotonSpectra).

This class is a dictionary where the keys are the index of the detector which value is the spectrum figure. The first detector as a key of 1. The figure are derived from PhotonSpectrum.

When this class is instantiated, the figures are not drawn. As any other _Figure, the method load() must be called. This method creates the figures for all the spectra.

Parameters:results (_PhotonSpectra) – photon spectra results

SUFFIX = ''

save(path=None, suffix='', format=['png'])

Save all figures.

class penelopetools.api.figure.penepma.photonspectra.PhotonSpectrum(result, **kwargs)

Bases: penelopetools.api.figure._ProbabilityFigure

Figure of a photon spectrum collected by a detector. This class is designed to accomodate the different spectrums collected by PENEPMA (characteristic, full and convoluted).

When this class is instantiated, the spectrum figure is not drawn. As any other _Figure, the method load() must be called.

Special kind of figure designed to plot the probability result (_ProbabilityResult). Two methods for plotting the first and second probability densities data are added.

Parameters:result (_ProbabilityResult) – result of the figure