xpSpectrumBase Class Reference

The "spectrum" base object for the expert system. More...

#include <XPS4XPS.H>

Inheritance diagram for xpSpectrumBase:

[legend]Collaboration diagram for xpSpectrumBase:

[legend]

Public Member Functions
	xpSpectrumBase (void)
	xpSpectrumBase (const xpSpectrumBase &S)
virtual	~xpSpectrumBase (void)
float	GetChargingEnergy (void)
float	GetEnergySeparation (void)
wxList *	GetPeaks (void)
xpSampleBase *	GetSample (void)
void	SetChargingEnergy (float EC)
void	SetEnergySeparation (float ES)
void	SetSample (xpSampleBase *S)
void	SetConcentrations (void)
Protected Attributes
float	ChargingEnergy
float	EnergySeparation
wxList	PeakList
xpSampleBase *	sample

---

Detailed Description

The "spectrum" base object for the expert system.

It implements the generic behaviour of spectra.

---

Constructor & Destructor Documentation

xpSpectrumBase::xpSpectrumBase (  void   )  [inline]

Constructor. Initializes parameters: xpSpectrumBase::EnergySeparation to 12 eV, xpSpectrumBase::ChargingEnergy to 0 eV, xpSpectrumBase::sample to NULL

xpSpectrumBase::xpSpectrumBase (  const xpSpectrumBase &  S  )  [inline]

Copy constructor. Copies parameters of S to this spectrum. Parameters: S  The spectrum to be copied

virtual xpSpectrumBase::~xpSpectrumBase (  void   )  [inline, virtual]

Destruct the base spectrum.

---

Member Function Documentation

float xpSpectrumBase::GetChargingEnergy (  void   )  [inline]

Return xpSpectrumBase::GetChargingEnergy: Returns: energy shift due to charging See also: GetChargingEnergy

float xpSpectrumBase::GetEnergySeparation (  void   )  [inline]

Return xpSpectrumBase::EnergySeparation Returns: energy separation of carbon peaks See also: SetEnergySeparation

wxList* xpSpectrumBase::GetPeaks (  void   )  [inline]

Return xpSpectrumBase::PeakList Returns: address of list of peaks

xpSampleBase* xpSpectrumBase::GetSample (  void   )  [inline]

Return xpSpectrumBase::sample Returns: pointer to the sample object See also: SetSample

void xpSpectrumBase::SetChargingEnergy (  float  EC  )  [inline]

Set xpSpectrumBase::ChargingEnergy Parameters: EC  the energy shift due to charging See also: GetChargingEnergy

void xpSpectrumBase::SetConcentrations (  void   )

Calculate concentration for the contained peaks

void xpSpectrumBase::SetEnergySeparation (  float  ES  )  [inline]

Set xpSpectrumBase::EnergySeparation Parameters: ES  the energy separation of carbon peaks See also: GetEnergySeparation

void xpSpectrumBase::SetSample (  xpSampleBase *  S  )  [inline]

Set xpSpectrumBase::sample Parameters: S  pointer to the sample object See also: GetSample

---

Field Documentation

float xpSpectrumBase::ChargingEnergy [protected]

Energy shift, due to sample charging.

float xpSpectrumBase::EnergySeparation [protected]

The energy separation parameter.

wxList xpSpectrumBase::PeakList [protected]

Contains peaks attached to the spectrum.

xpSampleBase* xpSpectrumBase::sample [protected]

Pointer to the attached sample information, if any.

---

The documentation for this class was generated from the following files:

• XPS4XPS.H
• XPS4XPS.CPP

---