gov.nist.microanalysis.EPQLibrary
Class SpectrumProperties

java.lang.Object
  gov.nist.microanalysis.EPQLibrary.SpectrumProperties

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SpectrumProperties
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

A generic class for capturing numerical and textual properties of spectra in a file independent format.

Copyright: Pursuant to title 17 Section 105 of the United States Code this software is not subject to copyright protection and is in the public domain

Company: National Institute of Standards and Technology

Version:

1.0

Author:

Nicholas W. M. Ritchie

See Also:

Serialized Form

Nested Class Summary

static class

SpectrumProperties.PropertyId Represents a tag by which individual properties can be identified.

Field Summary

static SpectrumProperties.PropertyId	AcquisitionTime AcquisitionTime - The time at which the spectrum was aquired.
static SpectrumProperties.PropertyId	ActiveLayer ActiveLayer - Thickness of the detector active layer in micrometers.
static SpectrumProperties.PropertyId	AFA_DAvg AFA_DAvg - The average particle diameter as measured by ASPEX AFA.
static SpectrumProperties.PropertyId	AlumimumWindow AlumimumWindow - Thickness of the aluminum window in nanometers.
static SpectrumProperties.PropertyId	AluminumLayer AluminumLayerThickness - The thickness (in nanometers) of the aluminum layer coating the surface of the detector.
static SpectrumProperties.PropertyId	Analyst Analyst - The instrument operator who collected the spectrum.
static int	ArrayType ArrayType - This property is most naturally represented as an double[]
static SpectrumProperties.PropertyId	ASPEX_BeamX ASPEX_BeamX - The location of the beam on the image during the EDS acquisition
static SpectrumProperties.PropertyId	ASPEX_BeamY ASPEX_BeamY - The location of the beam on the image during the EDS acquisition
static SpectrumProperties.PropertyId	Azimuth Azimuth - The azimuthal angle of the detector (from x-axis counterclockwise)
static SpectrumProperties.PropertyId	BackgroundCorrected BackgroundCorrected - Has this spectral data been background corrected?
static SpectrumProperties.PropertyId	BeamEnergy BeamEnergy - The energy of the electron probe in kiloelectron volts.
static SpectrumProperties.PropertyId	BerylliumWindow BerylliumWindow - The thickness of the detector window in micrometers (µm).
static int	Boolean Boolean - This property type is most naturally represented as a boolean value ('true' or 'false')
static SpectrumProperties.PropertyId	BoronNitrideWindow BoronNitrideWindow - The thickness of the detector window in micrometers (µm).
static SpectrumProperties.PropertyId	CarbonLayer CarbonLayer - Estimated thickness (in nanometers) of the carbon layer coating the surface of the sample.
static SpectrumProperties.PropertyId	ClientName ClientName - The name of the client for whom the analysis was performed.
static SpectrumProperties.PropertyId	ClientNumber ClientNumber - A field (sometimes a number) provided by a client that the client uses to identify the sample.
static SpectrumProperties.PropertyId	CollectionAngle CollectionAngle - Collection semi-angle of scattered beam in mR
static SpectrumProperties.PropertyId	Composition Composition - A string describing the composition (as implemented by Composition.toComposition and Composition.parseCompositon) The Composition string should reflect the composition of the sample as determined by an reliable independent method such as wet chemistry.
static int	CompositionType CompositionType - This property type is most naturally represented as an Composition object.
static SpectrumProperties.PropertyId	ConvergenceAngle ConvergenceAngle - Convergence semi-angle of incident beam in milliRadians [RN] (EMSA)
static SpectrumProperties.PropertyId	DeadLayer DeadLayer - The thickness of the dead layer at the surface of the detector in micrometers.
static SpectrumProperties.PropertyId	DetectorArea DetectorArea - The active surface area of the detector in square millimeters.
static SpectrumProperties.PropertyId	DetectorDescription A user-friendly description of the EDS detector (supposed to uniquely specify a detector)
static SpectrumProperties.PropertyId	DetectorDistance DetectorDistance - The distance from the sample-beam point to the detector in millimeters.
static SpectrumProperties.PropertyId	DetectorThickness DetectorThickness - The thickness of the active detector in millimeters.
static SpectrumProperties.PropertyId	DetectorTilt DetectorTilt - The angle between the detector normal and the a vector between the sample and the detector.
static SpectrumProperties.PropertyId	DetectorType DetectorType - Type of X-ray Detector, Allowed values are (EDSDET in DTSA) SIBEW = Si(Li) with Be Window SIUTW = Si(Li) with Ultra Thin Window SIWLS = Si(Li) Windowless GEBEW = Ge with Be Window GEUTW = Ge with Ultra Thin Window GEWLS = Ge Windowless
static SpectrumProperties.PropertyId	DiamondWindow DiamondWindow - The thickness of the detector window in micrometers (µm).
static SpectrumProperties.PropertyId	DuaneHunt DuaneHunt - The location of the Duane-Hunt limit (in keV)
static SpectrumProperties.PropertyId	DwellTime DwellTime - Dwell time/channel for serial data collection in msec
static SpectrumProperties.PropertyId	ElementN ElementN - The n-th element.
static SpectrumProperties.PropertyId	Elevation Elevation - The elevation of the detector above the plane defined by the normal to the beam.
static SpectrumProperties.PropertyId	EmissionCurrent EmissionCurrent - The emission current in microamps.
static SpectrumProperties.PropertyId	EnergyOffset EnergyOffset - The zero offset for converting channels to energies.
static SpectrumProperties.PropertyId	EnergyScale EnergyScale - The linear scale factor for converting channels into energies (in eV).
static SpectrumProperties.PropertyId	FaradayBegin FaradayBegin - A measurement of the full probe current taken before the spectrum was acquired.
static SpectrumProperties.PropertyId	FaradayEnd FaradayEnd - A measurement of the full probe current taken after the spectrum was acquired.","nA)
static SpectrumProperties.PropertyId	FastChannelCounts FastChannelCounts
static SpectrumProperties.PropertyId	GoldLayer GoldLayerThickness - The thickness (in micrometers) of the gold layer coating the surface of the detector.
static SpectrumProperties.PropertyId	HydroCarbonWindow HydroCarbonWindow - The thickness of the detector window in micrometers (µm).
static SpectrumProperties.PropertyId	IceThickness IceThickness - Estimated thickness (in micrometers) of the ice layer covering the window of the detector.
static int	ImageType ImageType - This property type is most naturally represented as an Image.
static SpectrumProperties.PropertyId	Instrument Instument - The instrument on which the spectum was collected.
static SpectrumProperties.PropertyId	IntegrationTime IntegrationTime - Integration time per spectrum for parallel data collection in milliseconds [RN] (DTSA)
static SpectrumProperties.PropertyId	IsDerived IsDerived - Was this spectrum derived from another spectrum's data?
static SpectrumProperties.PropertyId	IsEdited IsEdited - Has the spectrum data been edited.
static SpectrumProperties.PropertyId	IsResidualSpectrum IsResidualSpectrum - Is this the a residual spectrum?
static SpectrumProperties.PropertyId	IsROISpectrum IsROISpectrum - Is this a ROI spectrum?
static SpectrumProperties.PropertyId	IsStandard IsStandard - Is this spectrum a standard?
static SpectrumProperties.PropertyId	IsTemporary IsTemporary - Is the spectrum of ephemeral use? Temporary spectra are never saved to the database.
static SpectrumProperties.PropertyId	IsTheoreticallyGenerated IsTheoreticallyGenerated - Was this spectrum generated rather than measured?
static SpectrumProperties.PropertyId	KRatios KRatios - Describes the results of a fit of reference spectra as a set of k-ratios.
static SpectrumProperties.PropertyId	LiveTime LiveTime - The amount of time during which the detector was available to process x-ray events.
static SpectrumProperties.PropertyId	LLD LLD
static SpectrumProperties.PropertyId	MacroImage MacroImage - Associates a macro-view Image with a spectrum.
static SpectrumProperties.PropertyId	Magnification Magnification - The magnification at which the image was acquired.
static SpectrumProperties.PropertyId	MagnificationZoom MagnificationZoom - The zoom factor for the micro-image.
static SpectrumProperties.PropertyId	MediumChannelCounts MediumChannelCounts
static SpectrumProperties.PropertyId	MicroanalyticalComposition MicroanalyticalComposition - A string describing the composition (as implemented by Composition.toComposition and Composition.parseCompositon) The composition reported in the MicroanalyticalComposition string is the result of a microanalytical measurement and a compitent standard-based or standardless analysis of the resulting spectrum.
static SpectrumProperties.PropertyId	MicroImage MicroImage - Associates a microscopic-view Image with a spectrum.
static SpectrumProperties.PropertyId	MoxtekWindow MoxtekWindow - The thickness of the detector window in micrometers (µm).
static SpectrumProperties.PropertyId	MylarWindow MylarWindow - The thickness of the detector window in micrometers (µm).
static SpectrumProperties.PropertyId	NumberOfChannels NumberOfChannels - The number of channels of count data.
static int	Numeric Numeric - This property type is most naturally representated as a double precision floating point number.
static SpectrumProperties.PropertyId	OperatingMode OperatingMode - Operating Mode, allowed values are [5CS]: (DTSA) IMAGE = Imaging Mode DIFFR = Diffraction Mode SCIMG = Scanning Imaging Mode SCDIF = Scanning Diffraction Mode "IMAGE", "DIFFR", "SCIMG", "SCDIF"
static SpectrumProperties.PropertyId	ParaleneWindow ParaleneWindow - The thickness of the detector window in micrometers (µm).
static SpectrumProperties.PropertyId	ProbeArea ProbeArea - As define by DTSA
static SpectrumProperties.PropertyId	ProjectNumber ProjectNumber - A field (sometimes a number) identifying the project with which this sample is associated.
static SpectrumProperties.PropertyId	PulseProcessorSetting PulseProcessorSetting
static SpectrumProperties.PropertyId	PulseProcessorType PulseProcessorType
static SpectrumProperties.PropertyId	PulseProcessTime PulseProcessTime
static SpectrumProperties.PropertyId	PyroleneWindow PyroleneWindow - The thickness of the detector window in micrometers (µm).
static SpectrumProperties.PropertyId	QuantumEfficiency QuantumEfficiency - The efficiency of the detector for measuring x-rays.
static SpectrumProperties.PropertyId	RealTime RealTime - The acquisition time (as per clock on wall or equivalent.)
static SpectrumProperties.PropertyId	Resolution Resolution - The measured detector resolution at the energy specified by ResolutionLine.
static SpectrumProperties.PropertyId	ResolutionLine ResolutionLine - The energy of the line at which the resolution of the detector was measured.
static SpectrumProperties.PropertyId	SampleNumber SampleNumber - A field (sometimes a number) identifying the sample.
static SpectrumProperties.PropertyId	SampleSurfaceNormal SampleSurfaceNormal - A normal on the surface of the sample at the point at which electron beam strikes.
static SpectrumProperties.PropertyId	SignalType SignalType - As specified in the EMSA file format.
static SpectrumProperties.PropertyId	SiliconNitrideWindow SiliconNitrideWindow - The thickness of the detector window in micrometers (µm).
static SpectrumProperties.PropertyId	SlowChannelCounts SlowChannelCounts
static SpectrumProperties.PropertyId	Software Software - What software package was used to acquire the spectrum.
static SpectrumProperties.PropertyId	SolidAngle SolidAngle - Collection solid angle of detector in sR
static SpectrumProperties.PropertyId	SourceFile SourceFile - The name of the file from which the spectrum was extracted.
static SpectrumProperties.PropertyId	SourceFileId SourceFileId - The file name and integer index detailing where the spectrum was found.
static SpectrumProperties.PropertyId	SpecimenDensity SpecimenDensity -
static SpectrumProperties.PropertyId	SpecimenDesc SpecimenDesc - A user friendly description of the specimen
static SpectrumProperties.PropertyId	SpecimenId SpecimenId - A short name for the specimen
static SpectrumProperties.PropertyId	SpecimenThickness SpecimenThickness - Specimen thickness in nanometers [RN] (DTSA)
static SpectrumProperties.PropertyId	SpectrumClass SpectrumClass - A user defined descriptor identifying a class of similar spectra or sample types.
static SpectrumProperties.PropertyId	SpectrumComment SpectrumComment - A user-friendly comment describing the data contained within this spectrum object.
static SpectrumProperties.PropertyId	SpectrumType SpectrumType - As defined by DTSA
static SpectrumProperties.PropertyId	SpotSize SpotSize - The spot size as defined by the ASPEX software.
static SpectrumProperties.PropertyId	StageBank StageBank - The bank stage coordinate in degrees
static SpectrumProperties.PropertyId	StageRotation StageRotation - The rotation stage coordinate in degrees
static SpectrumProperties.PropertyId	StageTilt StageTilt - The tilt stage coordinate in degrees
static SpectrumProperties.PropertyId	TakeOffAngle TakeOffAngle - The angle at which the beam comes off of the sample.
static int	Textual Textual - This property type is most naturally represented as text.
static int	Timestamp Timestamp - This property type is most naturally represented as a date and time.
static int	Unknown Unknown - This property type is undefined or the type unrecognized.
static SpectrumProperties.PropertyId	ValenceN ValenceN - The valence associated with the n-th element.
static SpectrumProperties.PropertyId	WeightFractionN WeightFractionN - The weight fraction associated with the n-th element.
static SpectrumProperties.PropertyId	WindowType WindowType - A descriptive name for the window type.
static SpectrumProperties.PropertyId	WorkingDistance WorkingDistance - The distance between the pole piece and the sample as implied by the objective current necessary to bring the beam into focus (in mm).
static SpectrumProperties.PropertyId	XPosition XPosition - The x stage coordinate in millimeters.
static SpectrumProperties.PropertyId	XRayDetectorOrientation Orientation of a normal to the surface of the EDS detector (out-of-the-face of the detector)
static SpectrumProperties.PropertyId	XRayDetectorPosition The physical location of the x-ray detector relative to the beam axis.
static SpectrumProperties.PropertyId	XUnits
static SpectrumProperties.PropertyId	YPosition YPosition - The y stage coordinate in millimeters.
static SpectrumProperties.PropertyId	YUnits
static SpectrumProperties.PropertyId	ZPosition ZPosition - The z stage coordinate in millimeters.

Constructor Summary

SpectrumProperties()
SpectrumProperties - Construct an empty SpectrumProperties object.

SpectrumProperties(SpectrumProperties parentProps)
SpectrumProperties - Construct a SpectrumProperties object that is a duplicate of the parentProps object.

Method Summary

void	addAll(SpectrumProperties props) addAll - All all the properties from props into this SpectrumProperties object overwriting duplicate elements in this.
void	clear() clear - Clears the defintion of all properties.
void	clear(SpectrumProperties.PropertyId[] props) clear - Clear the specified properties identified by this list of PropertyId objects from this SpectrumProperties.
void	clearAllBut(SpectrumProperties.PropertyId[] props) clearAllBut - Clears all the SpectrumProperties.PropertyId objects in the SpectrumProperties object except the ones listed.
java.lang.Object	clone()
boolean	equals(java.lang.Object obj)
static SpectrumProperties.PropertyId	findPreDefinedPropertyId(java.lang.String propertyName)
double[]	getArrayProperty(SpectrumProperties.PropertyId pid) getArrayProperty - Gets the values contained within the specified array property
double[]	getArrayWithDefault(SpectrumProperties.PropertyId pid, double[] def) getArrayProperty - Gets the values contained within the specified array property if it exists or otherwise returns the values in def.
boolean	getBooleanProperty(SpectrumProperties.PropertyId pid) getBooleanProperty - Returns the boolean value associated with the named property.
boolean	getBooleanWithDefault(SpectrumProperties.PropertyId pid, boolean def) getBooleanWithDefault - Similar to the getBooleanProperty method except it returns the default value instead of throwing an exception if the named property is not defined.
Composition	getCompositionProperty(SpectrumProperties.PropertyId pid) getCompositionProperty - Get the Composition object associated with the specified PropertyId
Composition	getCompositionWithDefault(SpectrumProperties.PropertyId pid, Composition comp) getCompositionWithDefault - Get the Composition associated with the specified PropertyId.
java.awt.Image	getImageProperty(SpectrumProperties.PropertyId pid) getImageProperty - Get an image associated with a spectrum.
double	getNumericProperty(SpectrumProperties.PropertyId pid) getNumericProperty - Gets the numerical value of the specified property (pid).
double	getNumericWithDefault(SpectrumProperties.PropertyId pid, double def) getNumericWithDefault - Similar to getNumericProperty except that instead of throwing an Exception, the default value (def) is returned if getNumericProperty would throw an exception.
java.util.Set	getPropertySet() getPropertySet - Returns a list of the PropertyId objects associated with all the properties available for this spectrum.
int	getPropertyType(SpectrumProperties.PropertyId pid) getPropertyType - Gets the actual property type associated with this property (in contrast with what PropertyId.getPropertyType says).
java.lang.String	getTextProperty(SpectrumProperties.PropertyId pid) getTextProperty - Get the textual property identified by the specified pid.
java.lang.String	getTextWithDefault(SpectrumProperties.PropertyId pid, java.lang.String def) getTextWithDefault - Similar to getTextProperty except instead of throwing an exception, this version returns the default value (def) if the property is not defined.
java.util.Date	getTimestampProperty(SpectrumProperties.PropertyId pid) getTimestampProperty - Gets the date and time associated with the specified property.
java.util.Date	getTimestampWithDefault(SpectrumProperties.PropertyId pid, java.util.Date def) getTimestampWithDefault - Similar to getTimestampProperty except that instead of throwing an EPQException, the default value (def) is returned if getTimestampProperty would throw an exception.
int	hashCode()
boolean	isDefined(SpectrumProperties.PropertyId pid) isDefined - Is the specified property defined in this SpectrumProperties object?
static boolean	isPreDefinedProperty(java.lang.String propertyName)
static java.lang.Class	propertyTypeToClass(int propertyType)
void	setArrayProperty(SpectrumProperties.PropertyId pid, double[] val) setArrayProperty - Sets the specified array property to a double[]
void	setBooleanProperty(SpectrumProperties.PropertyId pid, boolean val) setBooleanProperty - Sets the named property to the specified boolean value.
void	setCompositionProperty(SpectrumProperties.PropertyId pid, Composition comp) setCompositionProperty - Sets the Composition associated with the specified PropertyId
void	setDetectorPosition(double elevation, double azimuth, double distance, double optWorkingDistance) setDetectorPosition - Sets the properties associated with the position and orientation of the x-ray detector.
void	setImageProperty(SpectrumProperties.PropertyId pid, java.awt.Image img) setImageProperty - Associates an image with a spectrum.
void	setNumericProperty(SpectrumProperties.PropertyId pid, double val) setNumericProperty - Sets the named property's value to the specified number.
void	setTextProperty(SpectrumProperties.PropertyId pid, java.lang.String val) setTextProperty - Sets the value (val) of the specified (pid) property.
void	setTimestampProperty(SpectrumProperties.PropertyId pid, java.util.Date val) setTimestampProperty - Sets the named property to the specified timestamp value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SpecimenId

public static final SpectrumProperties.PropertyId SpecimenId

SpecimenId - A short name for the specimen

SpecimenDesc

public static final SpectrumProperties.PropertyId SpecimenDesc

SpecimenDesc - A user friendly description of the specimen

SampleNumber

public static final SpectrumProperties.PropertyId SampleNumber

SampleNumber - A field (sometimes a number) identifying the sample.

ClientNumber

public static final SpectrumProperties.PropertyId ClientNumber

ClientNumber - A field (sometimes a number) provided by a client that the client uses to identify the sample.

ClientName

public static final SpectrumProperties.PropertyId ClientName

ClientName - The name of the client for whom the analysis was performed.

ProjectNumber

public static final SpectrumProperties.PropertyId ProjectNumber

ProjectNumber - A field (sometimes a number) identifying the project with which this sample is associated.

SourceFile

public static final SpectrumProperties.PropertyId SourceFile

SourceFile - The name of the file from which the spectrum was extracted.

SourceFileId

public static final SpectrumProperties.PropertyId SourceFileId

SourceFileId - The file name and integer index detailing where the spectrum was found.

Analyst

public static final SpectrumProperties.PropertyId Analyst

Analyst - The instrument operator who collected the spectrum.

Instrument

public static final SpectrumProperties.PropertyId Instrument

Instument - The instrument on which the spectum was collected. Should identify one instrument instance uniquely.

Software

public static final SpectrumProperties.PropertyId Software

Software - What software package was used to acquire the spectrum.

AcquisitionTime

public static final SpectrumProperties.PropertyId AcquisitionTime

AcquisitionTime - The time at which the spectrum was aquired. This is reported as the number of milliseconds since January 1, 1970, 00:00:00 GMT.

Azimuth

public static final SpectrumProperties.PropertyId Azimuth

Azimuth - The azimuthal angle of the detector (from x-axis counterclockwise)

Elevation

public static final SpectrumProperties.PropertyId Elevation

Elevation - The elevation of the detector above the plane defined by the normal to the beam.

DetectorArea

public static final SpectrumProperties.PropertyId DetectorArea

DetectorArea - The active surface area of the detector in square millimeters.

DetectorThickness

public static final SpectrumProperties.PropertyId DetectorThickness

DetectorThickness - The thickness of the active detector in millimeters.

DetectorTilt

public static final SpectrumProperties.PropertyId DetectorTilt

DetectorTilt - The angle between the detector normal and the a vector between the sample and the detector.

TakeOffAngle

public static final SpectrumProperties.PropertyId TakeOffAngle

TakeOffAngle - The angle at which the beam comes off of the sample. This angle is defined by the point at which the x-ray is emitted and the location of the detector. In degrees.

DetectorDistance

public static final SpectrumProperties.PropertyId DetectorDistance

DetectorDistance - The distance from the sample-beam point to the detector in millimeters.

SolidAngle

public static final SpectrumProperties.PropertyId SolidAngle

SolidAngle - Collection solid angle of detector in sR

WindowType

public static final SpectrumProperties.PropertyId WindowType

WindowType - A descriptive name for the window type.

DiamondWindow

public static final SpectrumProperties.PropertyId DiamondWindow

DiamondWindow - The thickness of the detector window in micrometers (µm).

MylarWindow

public static final SpectrumProperties.PropertyId MylarWindow

MylarWindow - The thickness of the detector window in micrometers (µm).

BoronNitrideWindow

public static final SpectrumProperties.PropertyId BoronNitrideWindow

BoronNitrideWindow - The thickness of the detector window in micrometers (µm).

SiliconNitrideWindow

public static final SpectrumProperties.PropertyId SiliconNitrideWindow

SiliconNitrideWindow - The thickness of the detector window in micrometers (µm).

ParaleneWindow

public static final SpectrumProperties.PropertyId ParaleneWindow

ParaleneWindow - The thickness of the detector window in micrometers (µm).

PyroleneWindow

public static final SpectrumProperties.PropertyId PyroleneWindow

PyroleneWindow - The thickness of the detector window in micrometers (µm).

MoxtekWindow

public static final SpectrumProperties.PropertyId MoxtekWindow

MoxtekWindow - The thickness of the detector window in micrometers (µm).

HydroCarbonWindow

public static final SpectrumProperties.PropertyId HydroCarbonWindow

HydroCarbonWindow - The thickness of the detector window in micrometers (µm).

BerylliumWindow

public static final SpectrumProperties.PropertyId BerylliumWindow

BerylliumWindow - The thickness of the detector window in micrometers (µm).

AlumimumWindow

public static final SpectrumProperties.PropertyId AlumimumWindow

AlumimumWindow - Thickness of the aluminum window in nanometers.

GoldLayer

public static final SpectrumProperties.PropertyId GoldLayer

GoldLayerThickness - The thickness (in micrometers) of the gold layer coating the surface of the detector.

AluminumLayer

public static final SpectrumProperties.PropertyId AluminumLayer

AluminumLayerThickness - The thickness (in nanometers) of the aluminum layer coating the surface of the detector.

IceThickness

public static final SpectrumProperties.PropertyId IceThickness

IceThickness - Estimated thickness (in micrometers) of the ice layer covering the window of the detector.

CarbonLayer

public static final SpectrumProperties.PropertyId CarbonLayer

CarbonLayer - Estimated thickness (in nanometers) of the carbon layer coating the surface of the sample.

DeadLayer

public static final SpectrumProperties.PropertyId DeadLayer

DeadLayer - The thickness of the dead layer at the surface of the detector in micrometers.

ActiveLayer

public static final SpectrumProperties.PropertyId ActiveLayer

ActiveLayer - Thickness of the detector active layer in micrometers.

DetectorType

public static final SpectrumProperties.PropertyId DetectorType

DetectorType - Type of X-ray Detector, Allowed values are (EDSDET in DTSA) SIBEW = Si(Li) with Be Window SIUTW = Si(Li) with Ultra Thin Window SIWLS = Si(Li) Windowless GEBEW = Ge with Be Window GEUTW = Ge with Ultra Thin Window GEWLS = Ge Windowless

EnergyScale

public static final SpectrumProperties.PropertyId EnergyScale

EnergyScale - The linear scale factor for converting channels into energies (in eV). [eV per channel]

EnergyOffset

public static final SpectrumProperties.PropertyId EnergyOffset

EnergyOffset - The zero offset for converting channels to energies. The energy=ValueOf(EnergyScale)*channel+ValueOf(EnergyOffset).

Resolution

public static final SpectrumProperties.PropertyId Resolution

Resolution - The measured detector resolution at the energy specified by ResolutionLine.

ResolutionLine

public static final SpectrumProperties.PropertyId ResolutionLine

ResolutionLine - The energy of the line at which the resolution of the detector was measured.

NumberOfChannels

public static final SpectrumProperties.PropertyId NumberOfChannels

NumberOfChannels - The number of channels of count data. Each spectrum has one and only one region of data starting with channel 0 at ValueOf(EnergyOffset) and extending to ValueOf(NumberOfChannels) with an energy of ValueOf(NumberOfChannels)*ValueOf(EnergyScale)+ValueOf(EnergyOffset).

QuantumEfficiency

public static final SpectrumProperties.PropertyId QuantumEfficiency

QuantumEfficiency - The efficiency of the detector for measuring x-rays. Most x-ray detectors measure all x-rays that strike the detector thus the quantum efficiency is 1.0. This concept can be a little ill-defined as some thin detectors may allow higher energy x-rays to pass unabsorbed. The quantum efficiency then is not a constant but depends on energy.

IntegrationTime

public static final SpectrumProperties.PropertyId IntegrationTime

IntegrationTime - Integration time per spectrum for parallel data collection in milliseconds [RN] (DTSA)

DwellTime

public static final SpectrumProperties.PropertyId DwellTime

DwellTime - Dwell time/channel for serial data collection in msec

SpectrumComment

public static final SpectrumProperties.PropertyId SpectrumComment

SpectrumComment - A user-friendly comment describing the data contained within this spectrum object.

SpectrumClass

public static final SpectrumProperties.PropertyId SpectrumClass

SpectrumClass - A user defined descriptor identifying a class of similar spectra or sample types.

SpectrumType

public static final SpectrumProperties.PropertyId SpectrumType

SpectrumType - As defined by DTSA

IsTheoreticallyGenerated

public static final SpectrumProperties.PropertyId IsTheoreticallyGenerated

IsTheoreticallyGenerated - Was this spectrum generated rather than measured?

IsResidualSpectrum

public static final SpectrumProperties.PropertyId IsResidualSpectrum

IsResidualSpectrum - Is this the a residual spectrum?

IsROISpectrum

public static final SpectrumProperties.PropertyId IsROISpectrum

IsROISpectrum - Is this a ROI spectrum?

IsStandard

public static final SpectrumProperties.PropertyId IsStandard

IsStandard - Is this spectrum a standard?

IsEdited

public static final SpectrumProperties.PropertyId IsEdited

IsEdited - Has the spectrum data been edited.

IsTemporary

public static final SpectrumProperties.PropertyId IsTemporary

IsTemporary - Is the spectrum of ephemeral use? Temporary spectra are never saved to the database.

IsDerived

public static final SpectrumProperties.PropertyId IsDerived

IsDerived - Was this spectrum derived from another spectrum's data?

BackgroundCorrected

public static final SpectrumProperties.PropertyId BackgroundCorrected

BackgroundCorrected - Has this spectral data been background corrected?

LiveTime

public static final SpectrumProperties.PropertyId LiveTime

LiveTime - The amount of time during which the detector was available to process x-ray events. (LiveTime<=RealTime)

RealTime

public static final SpectrumProperties.PropertyId RealTime

RealTime - The acquisition time (as per clock on wall or equivalent.)

XUnits

public static final SpectrumProperties.PropertyId XUnits

YUnits

public static final SpectrumProperties.PropertyId YUnits

SignalType

public static final SpectrumProperties.PropertyId SignalType

SignalType - As specified in the EMSA file format. The detector type from which this data was collected.

XPosition

public static final SpectrumProperties.PropertyId XPosition

XPosition - The x stage coordinate in millimeters.

YPosition

public static final SpectrumProperties.PropertyId YPosition

YPosition - The y stage coordinate in millimeters.

ZPosition

public static final SpectrumProperties.PropertyId ZPosition

ZPosition - The z stage coordinate in millimeters.

StageRotation

public static final SpectrumProperties.PropertyId StageRotation

StageRotation - The rotation stage coordinate in degrees

StageTilt

public static final SpectrumProperties.PropertyId StageTilt

StageTilt - The tilt stage coordinate in degrees

StageBank

public static final SpectrumProperties.PropertyId StageBank

StageBank - The bank stage coordinate in degrees

FaradayBegin

public static final SpectrumProperties.PropertyId FaradayBegin

FaradayBegin - A measurement of the full probe current taken before the spectrum was acquired. (nA)

FaradayEnd

public static final SpectrumProperties.PropertyId FaradayEnd

FaradayEnd - A measurement of the full probe current taken after the spectrum was acquired.","nA)

SpotSize

public static final SpectrumProperties.PropertyId SpotSize

SpotSize - The spot size as defined by the ASPEX software.

ProbeArea

public static final SpectrumProperties.PropertyId ProbeArea

ProbeArea - As define by DTSA

SlowChannelCounts

public static final SpectrumProperties.PropertyId SlowChannelCounts

SlowChannelCounts

MediumChannelCounts

public static final SpectrumProperties.PropertyId MediumChannelCounts

MediumChannelCounts

FastChannelCounts

public static final SpectrumProperties.PropertyId FastChannelCounts

FastChannelCounts

LLD

public static final SpectrumProperties.PropertyId LLD

LLD

PulseProcessorType

public static final SpectrumProperties.PropertyId PulseProcessorType

PulseProcessorType

PulseProcessTime

public static final SpectrumProperties.PropertyId PulseProcessTime

PulseProcessTime

PulseProcessorSetting

public static final SpectrumProperties.PropertyId PulseProcessorSetting

PulseProcessorSetting

BeamEnergy

public static final SpectrumProperties.PropertyId BeamEnergy

BeamEnergy - The energy of the electron probe in kiloelectron volts.

WorkingDistance

public static final SpectrumProperties.PropertyId WorkingDistance

WorkingDistance - The distance between the pole piece and the sample as implied by the objective current necessary to bring the beam into focus (in mm).

EmissionCurrent

public static final SpectrumProperties.PropertyId EmissionCurrent

EmissionCurrent - The emission current in microamps. Not this is the amount of emission from the gun not the amount that strikes the sample.

Magnification

public static final SpectrumProperties.PropertyId Magnification

Magnification - The magnification at which the image was acquired. This is ambiguous as the size at which the image is displayed changes the magnification. Nominally I use a 3.5" display size to calculate mag. I can't say what other people do.

MagnificationZoom

public static final SpectrumProperties.PropertyId MagnificationZoom

MagnificationZoom - The zoom factor for the micro-image.

ConvergenceAngle

public static final SpectrumProperties.PropertyId ConvergenceAngle

ConvergenceAngle - Convergence semi-angle of incident beam in milliRadians [RN] (EMSA)

CollectionAngle

public static final SpectrumProperties.PropertyId CollectionAngle

CollectionAngle - Collection semi-angle of scattered beam in mR

OperatingMode

public static final SpectrumProperties.PropertyId OperatingMode

OperatingMode - Operating Mode, allowed values are [5CS]: (DTSA) IMAGE = Imaging Mode DIFFR = Diffraction Mode SCIMG = Scanning Imaging Mode SCDIF = Scanning Diffraction Mode "IMAGE", "DIFFR", "SCIMG", "SCDIF"

SpecimenThickness

public static final SpectrumProperties.PropertyId SpecimenThickness

SpecimenThickness - Specimen thickness in nanometers [RN] (DTSA)

SpecimenDensity

public static final SpectrumProperties.PropertyId SpecimenDensity

SpecimenDensity -

ElementN

public static final SpectrumProperties.PropertyId ElementN

ElementN - The n-th element. This string is a pattern for MessageFormat.format.

WeightFractionN

public static final SpectrumProperties.PropertyId WeightFractionN

WeightFractionN - The weight fraction associated with the n-th element. This string is a pattern for MessageFormat.format.

ValenceN

public static final SpectrumProperties.PropertyId ValenceN

ValenceN - The valence associated with the n-th element. This string is a pattern for MessageFormat.format.

Composition

public static final SpectrumProperties.PropertyId Composition

Composition - A string describing the composition (as implemented by Composition.toComposition and Composition.parseCompositon) The Composition string should reflect the composition of the sample as determined by an reliable independent method such as wet chemistry.

MicroanalyticalComposition

public static final SpectrumProperties.PropertyId MicroanalyticalComposition

MicroanalyticalComposition - A string describing the composition (as implemented by Composition.toComposition and Composition.parseCompositon) The composition reported in the MicroanalyticalComposition string is the result of a microanalytical measurement and a compitent standard-based or standardless analysis of the resulting spectrum. This string should describe the best microanalytically derived understanding of composition of the sample.

KRatios

public static final SpectrumProperties.PropertyId KRatios

KRatios - Describes the results of a fit of reference spectra as a set of k-ratios. (As implemented by KRatioSet.toParseableString and KRatioSet.parseString)

MacroImage

public static final SpectrumProperties.PropertyId MacroImage

MacroImage - Associates a macro-view Image with a spectrum.

MicroImage

public static final SpectrumProperties.PropertyId MicroImage

MicroImage - Associates a microscopic-view Image with a spectrum.

AFA_DAvg

public static final SpectrumProperties.PropertyId AFA_DAvg

AFA_DAvg - The average particle diameter as measured by ASPEX AFA.

ASPEX_BeamX

public static final SpectrumProperties.PropertyId ASPEX_BeamX

ASPEX_BeamX - The location of the beam on the image during the EDS acquisition

ASPEX_BeamY

public static final SpectrumProperties.PropertyId ASPEX_BeamY

ASPEX_BeamY - The location of the beam on the image during the EDS acquisition

DuaneHunt

public static final SpectrumProperties.PropertyId DuaneHunt

DuaneHunt - The location of the Duane-Hunt limit (in keV)

SampleSurfaceNormal

public static final SpectrumProperties.PropertyId SampleSurfaceNormal

SampleSurfaceNormal - A normal on the surface of the sample at the point at which electron beam strikes. The coordinate system is defined such that looking down the trajectory of the incident electrons from the front of the instrument the positive x-axis is perpendicular to the front of the instrument and goes to the right. The y-axis goes towards the front of the instrument. The z-axis is parallel to the electron beam and positive down. The origin is at the undeflected center of the beam at a working distance of zero mm according to the lenses. The sample position is defined by [0.0, 0.0, WorkingDistance]

XRayDetectorOrientation

public static final SpectrumProperties.PropertyId XRayDetectorOrientation

Orientation of a normal to the surface of the EDS detector (out-of-the-face of the detector)

XRayDetectorPosition

public static final SpectrumProperties.PropertyId XRayDetectorPosition

The physical location of the x-ray detector relative to the beam axis. See SampleSurfaceNormal for a description of the coordinate system.

DetectorDescription

public static final SpectrumProperties.PropertyId DetectorDescription

A user-friendly description of the EDS detector (supposed to uniquely specify a detector)

Unknown

public static final int Unknown

Unknown - This property type is undefined or the type unrecognized.

See Also:

Constant Field Values

Numeric

public static final int Numeric

Numeric - This property type is most naturally representated as a double precision floating point number.

See Also:

Constant Field Values

Textual

public static final int Textual

Textual - This property type is most naturally represented as text.

See Also:

Constant Field Values

Boolean

public static final int Boolean

Boolean - This property type is most naturally represented as a boolean value ('true' or 'false')

See Also:

Constant Field Values

Timestamp

public static final int Timestamp

Timestamp - This property type is most naturally represented as a date and time.

See Also:

Constant Field Values

ImageType

public static final int ImageType

ImageType - This property type is most naturally represented as an Image.

See Also:

Constant Field Values

CompositionType

public static final int CompositionType

CompositionType - This property type is most naturally represented as an Composition object.

See Also:

Constant Field Values

ArrayType

public static final int ArrayType

ArrayType - This property is most naturally represented as an double[]

See Also:

Constant Field Values

Constructor Detail

SpectrumProperties

public SpectrumProperties()

SpectrumProperties - Construct an empty SpectrumProperties object.

SpectrumProperties

public SpectrumProperties(SpectrumProperties parentProps)

SpectrumProperties - Construct a SpectrumProperties object that is a duplicate of the parentProps object.

Parameters:

parentProps - SpectrumProperties

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

getTextProperty

public java.lang.String getTextProperty(SpectrumProperties.PropertyId pid)
                                 throws EPQException

getTextProperty - Get the textual property identified by the specified pid. This method throws an exception if the named property is not found.

Parameters:

pid - String

Returns:

String

Throws:

EPQException

getTextWithDefault

public java.lang.String getTextWithDefault(SpectrumProperties.PropertyId pid,
                                           java.lang.String def)

getTextWithDefault - Similar to getTextProperty except instead of throwing an exception, this version returns the default value (def) if the property is not defined.

Parameters:

pid - String

def - String

Returns:

String

setTextProperty

public void setTextProperty(SpectrumProperties.PropertyId pid,
                            java.lang.String val)

setTextProperty - Sets the value (val) of the specified (pid) property. Any previous definition is overwritten.

Parameters:

pid - String

val - String

getNumericProperty

public double getNumericProperty(SpectrumProperties.PropertyId pid)
                          throws EPQException

getNumericProperty - Gets the numerical value of the specified property (pid). If the property is not defined or if it is not representable as a double then the method raises an EPQException.

Parameters:

pid - String

Returns:

double

Throws:

EPQException

getNumericWithDefault

public double getNumericWithDefault(SpectrumProperties.PropertyId pid,
                                    double def)

getNumericWithDefault - Similar to getNumericProperty except that instead of throwing an Exception, the default value (def) is returned if getNumericProperty would throw an exception.

Parameters:

pid - String

def - double

Returns:

double

setNumericProperty

public void setNumericProperty(SpectrumProperties.PropertyId pid,
                               double val)

setNumericProperty - Sets the named property's value to the specified number.

Parameters:

pid - String

val - double

setArrayProperty

public void setArrayProperty(SpectrumProperties.PropertyId pid,
                             double[] val)

setArrayProperty - Sets the specified array property to a double[]

Parameters:

pid -

val - double[]

getArrayProperty

public double[] getArrayProperty(SpectrumProperties.PropertyId pid)
                          throws EPQException

getArrayProperty - Gets the values contained within the specified array property

Parameters:

pid -

Returns:

double[]

Throws:

EPQException

getArrayWithDefault

public double[] getArrayWithDefault(SpectrumProperties.PropertyId pid,
                                    double[] def)

getArrayProperty - Gets the values contained within the specified array property if it exists or otherwise returns the values in def.

Parameters:

pid -

def -

Returns:

double[]

setImageProperty

public void setImageProperty(SpectrumProperties.PropertyId pid,
                             java.awt.Image img)

setImageProperty - Associates an image with a spectrum.

Parameters:

pid - String

img - Image

getImageProperty

public java.awt.Image getImageProperty(SpectrumProperties.PropertyId pid)
                                throws EPQException

getImageProperty - Get an image associated with a spectrum.

Parameters:

pid - String

Returns:

Image

Throws:

EPQException

getCompositionProperty

public Composition getCompositionProperty(SpectrumProperties.PropertyId pid)
                                   throws EPQException

getCompositionProperty - Get the Composition object associated with the specified PropertyId

Parameters:

pid -

Returns:

The Composition

Throws:

EPQException

getCompositionWithDefault

public Composition getCompositionWithDefault(SpectrumProperties.PropertyId pid,
                                             Composition comp)

getCompositionWithDefault - Get the Composition associated with the specified PropertyId. If none is defined return comp.

Parameters:

pid -

comp -

Returns:

The Composition

setCompositionProperty

public void setCompositionProperty(SpectrumProperties.PropertyId pid,
                                   Composition comp)

setCompositionProperty - Sets the Composition associated with the specified PropertyId

Parameters:

pid -

comp -

setBooleanProperty

public void setBooleanProperty(SpectrumProperties.PropertyId pid,
                               boolean val)

setBooleanProperty - Sets the named property to the specified boolean value.

Parameters:

pid - String

val - boolean

getBooleanProperty

public boolean getBooleanProperty(SpectrumProperties.PropertyId pid)
                           throws EPQException

getBooleanProperty - Returns the boolean value associated with the named property. This method throws an exception if the property is not defined.

Parameters:

pid - String

Returns:

boolean

Throws:

EPQException

getBooleanWithDefault

public boolean getBooleanWithDefault(SpectrumProperties.PropertyId pid,
                                     boolean def)

getBooleanWithDefault - Similar to the getBooleanProperty method except it returns the default value instead of throwing an exception if the named property is not defined.

Parameters:

pid - String

def - boolean

Returns:

boolean

getTimestampProperty

public java.util.Date getTimestampProperty(SpectrumProperties.PropertyId pid)
                                    throws EPQException

getTimestampProperty - Gets the date and time associated with the specified property.

Parameters:

pid - PropertyId

Returns:

Date

Throws:

EPQException

getTimestampWithDefault

public java.util.Date getTimestampWithDefault(SpectrumProperties.PropertyId pid,
                                              java.util.Date def)

getTimestampWithDefault - Similar to getTimestampProperty except that instead of throwing an EPQException, the default value (def) is returned if getTimestampProperty would throw an exception.

Parameters:

pid - String

def - Date

Returns:

Date

setTimestampProperty

public void setTimestampProperty(SpectrumProperties.PropertyId pid,
                                 java.util.Date val)

setTimestampProperty - Sets the named property to the specified timestamp value.

Parameters:

pid - String

val - Timestamp

setDetectorPosition

public void setDetectorPosition(double elevation,
                                double azimuth,
                                double distance,
                                double optWorkingDistance)

setDetectorPosition - Sets the properties associated with the position and orientation of the x-ray detector. Uses an algorithm which *assumes* that at the detector points directly at the point (0.0, 0.0, optWorkingDistance) from the specified elevation and azimuth. To determine the optWorkingDistance determine the point at which the detector points on the beam axis. Place a sample there. Focus on the sample and then record the working distance.

Parameters:

elevation - - Elevation up from the x-y plane (radians)

azimuth - - Measured from the x-axis positive towards the y-axis (radians)

distance - - Distance from (0.0,0.0,optWorkingDistance) to the detector (in meters)

optWorkingDistance - - The optimal working distance (in meters)

clear

public void clear()

clear - Clears the defintion of all properties.

clearAllBut

public void clearAllBut(SpectrumProperties.PropertyId[] props)

clearAllBut - Clears all the SpectrumProperties.PropertyId objects in the SpectrumProperties object except the ones listed.

Parameters:

props - PropertyId[]

clear

public void clear(SpectrumProperties.PropertyId[] props)

clear - Clear the specified properties identified by this list of PropertyId objects from this SpectrumProperties.

Parameters:

props - PropertyId[]

isDefined

public boolean isDefined(SpectrumProperties.PropertyId pid)

isDefined - Is the specified property defined in this SpectrumProperties object?

Parameters:

pid - String

Returns:

boolean

getPropertySet

public java.util.Set getPropertySet()

getPropertySet - Returns a list of the PropertyId objects associated with all the properties available for this spectrum.

Returns:

Set - A Set of PropertyId objects

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getPropertyType

public int getPropertyType(SpectrumProperties.PropertyId pid)

getPropertyType - Gets the actual property type associated with this property (in contrast with what PropertyId.getPropertyType says). They had better agree!!!

Parameters:

pid - PropertyId

Returns:

int

propertyTypeToClass

public static java.lang.Class propertyTypeToClass(int propertyType)

isPreDefinedProperty

public static boolean isPreDefinedProperty(java.lang.String propertyName)

findPreDefinedPropertyId

public static SpectrumProperties.PropertyId findPreDefinedPropertyId(java.lang.String propertyName)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addAll

public void addAll(SpectrumProperties props)

addAll - All all the properties from props into this SpectrumProperties object overwriting duplicate elements in this.

Parameters:

props -