Spectrum

Working with Spectrum objects

The Spectrum type represents a single spectrum with associated properties. The channel data is indexed like a Vector. The property data is indexed using Symbol objects. A set of spectrum properties are defined in the library and the user can create additional ones.

In addition to the Vector-like properties, the Spectrum associates energy bins with each channel. The energy bins are continuous, non-overlapping and monotonic. Functions like energy(...) maps channel index to energies and channel(...) to make energies to channel index.

NeXLSpectrum.Spectrum — Type

Spectrum{T<:Real} <: AbstractVector{T}

Spectrum(energy::EnergyScale, data::Vector{<:Real}, props::Dict{Symbol,Any})

Construct a structure to hold spectrum data (energy scale, counts and metadata).

See NeXLSpectrum.EnergyScale or NeXLSpectrum.LinearEnergyScale

Example:

julia> spec = Spectrum(LinearEnergyScale(0.0,10.0),
                 collect(1:1024),
                 Dict{Symbol,Any}(:BeamEnergy=>10.0e3, :LiveTime=>30.0))
                                                                              ** 1024.0
                                                                       *********
                                                               *****************
                                                        ************************
                                                 *******************************
                                          **************************************
                                   *********************************************
                            ****************************************************
                     ***********************************************************
              ******************************************************************
       *************************************************************************
******************************************************************************** 10.0 keV
Spectrum[3062][10.0 keV, Unknown, 525000.0 counts]

Spectrum implements indexing using various different mechanisms. If spec is a Spectrum then

spec[123] # will return the number of counts in channel 123
spec[123:222] # will return a Vector of counts from channel 123:222
spec[134.] # will return the number of counts in the channel at energy 134.0 eV
spec[134.0:270.0] # will return a Vector of counts for channels with energies between 134.0 eV and 270.0 eV
spec[:Comment] # will return the property named :Comment

Metadata is identified by a symbol. These Symbols are used within NeXLSpectrum.

:BeamEnergy    # In eV
:Elevation     # In radians
:TakeOffAngle  # In radians (Detector position)
:Azimuthal     # In radians (Detector position)
:WorkingDistance # In cm
:LiveTime      # In seconds
:RealTime      # In seconds
:ProbeCurrent  # In nano-amps
:Name          # A string
:Owner         # A string
:StagePosition # A Dict{Symbol,Real} with entries :X, :Y, :Z, :R, :T, B: in cm and degrees
:Comment       # A string
:Composition   # A Material (known composition, not measured)
:Elements      # A collection of elements in the material
:ReferenceROIS # A collection of reference ROIs (as Vector{ReferenceROI})
:Detector      # A Detector like a BasicEDS or another EDSDetector
:Filename      # Source filename
:Coating       # A Film or Film[] (eg. 10 nm of C|Au etc.)
:AcquisitionTime # Date and time of acquisition (DateTime struct)
:Signature     # Dict{Element,Real} with the "particle signature"

Less common items:

:ImageMag	   # Magnification (assuming a 3.5" image) of the first image
:ImageZoom     # Additional zoom for second image in a two image TIFF
:Operator      # Analyst in ASPEX TIFF files
:Image1, :Image2 ... # Images associated with the spectrum
:BrukerThroughtput # Nominal throughtput setting on a Bruker detector
:DetectorSerialNumber # EDS detector serial number
:DetectorModel # Vendor model name
:DetectorThickness # Thickness of detector active area
:DeadLayerThickness # Thickness of Si dead layer on the entrance surface of the detector
:Window        # Window construction details
:DetectorSolidAngle # Collection solid angle of the X-ray detector
:ChamberPressure # Vacuum presure in the sample chamber
:ChamberAtmosphere # Nominally the composition of the residual gas in the chamber

XRF related items:

:BeamEnergy  # Accelarating voltage within X-ray tube (eV)
:XRFTubeAnode    # Element from which the X-ray tube is constructed
:ProbeCurrent  # Electron current in the X-ray tube
:XRFTubeIncidentAngle # Incident angle of electron beam in tube
:XRFTubeTakeOffAngle # Take-off angle from tube
:XRFExcitationAngle # Angle of incidence of the X-ray beam on the sample
:XRFDetectionAngle # Angle of the detector relative to the sample
:XRFExcitationPathLength # Distance from X-ray source to sample
:XRFDetectionPathLength # Distance from the sample to the X-ray detector
:XRFSampleTilt    #  Additional tilt of the sample
:XRFTubeWindow   # Construction of the tube window

Not all spectra will define all properties. Algorithms can define the NeXLCore.minproperties(ty::Type) method to specify which properties are required by an algorithm of ty::Type. Then hasminrequired and requiredbutmissing methods will determine whether a Spectrum or Dict{Symbol,Any} is suitable for an algorithm.