gov.nist.microanalysis.EPQLibrary
Interface ISpectrumData

All Superinterfaces:
java.lang.Comparable
All Known Implementing Classes:
BaseSpectrum, DerivedSpectrum, EditableSpectrum, EDSDetector, EMSAFile, Microcalorimeter, NoisySpectrum, SerializableSpectrum, SpectrumMath

public interface ISpectrumData
extends java.lang.Comparable

An interface which all classes that contain spectral data should implement to allow them to be displayed in the SpecDisplay control.

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

Method Summary
 int getChannelCount()
          getChannelCount - Returns the number of channels in the spectrum (nominally 2048)
 double getChannelWidth()
          getChannelWidth - Returns the width of each channel (in eV)
 double getCounts(int i)
          getCounts - Return the counts in the i-th channel
 SpectrumProperties getProperties()
          getProperties - Returns the SpectrumProperties object associated with this spectrum.
 double getZeroOffset()
          getZeroOffset - Returns the energy of the first channel.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getChannelCount

int getChannelCount()
getChannelCount - Returns the number of channels in the spectrum (nominally 2048)

Returns:
int

getCounts

double getCounts(int i)
getCounts - Return the counts in the i-th channel

Parameters:
i -
Returns:
double

getChannelWidth

double getChannelWidth()
getChannelWidth - Returns the width of each channel (in eV)

Returns:
double

getZeroOffset

double getZeroOffset()
getZeroOffset - Returns the energy of the first channel.

Returns:
double

getProperties

SpectrumProperties getProperties()
getProperties - Returns the SpectrumProperties object associated with this spectrum. SpectrumProperties are the mechanism by which contextual data is associated with spectra.

Returns:
SpectrumProperties