Main Page | Class Hierarchy | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

xpPeakBase Class Reference

The "peak component" object for the expert system. More...

#include <XPS4XPS.H>

Inheritance diagram for xpPeakBase:

Inheritance graph
[legend]
Collaboration diagram for xpPeakBase:

Collaboration graph
[legend]

Public Member Functions

 xpPeakBase (xpSpectrumBase *Parent, float E=0.0f)
 xpPeakBase (const xpPeakBase &C)
xboolean::xbool GetCarbon1sPeak (void) const
float GetRate (const float counts) const
float GetMeasTime (void)
float GetSensitivity (void)
void SetSensitivity (const float S)
float GetConcentration (void)
void SetConcentration (const float C)
float GetConcentrationUncertainty (void)
void SetConcentrationUncertainty (const float C)
void SetMeasTime (const float t)
float GetPeakCounts (void)
void SetPeakCounts (const float c)
float GetBgndCounts (void)
void SetBgndCounts (const float c)
float GetPeakRate (void)
void SetPeakRate (const float r)
float GetBgndRate (void)
void SetBgndRate (const float r)
float GetRelPrec (void)
float CalcRelPrec (void)
void SetRelPrec (const float r)
float GetEstimatedPeakCounts (float rp)
float GetChargingEnergy (void) const
float GetEnergy (bool WithCharging=false)
xpPeakPanel * GetPanel (void) const
float GetPostPeakSlope (void) const
float GetShirleyTailHeight (void) const
float GetAngleRatio (void) const
bool IsCarbon1sPeak (void)
bool IsPeakInRangeBE (const float BELow, const float BEHigh)
bool IsPeakInRangeKE (const float KELow, const float KEHigh)
void SetCarbon1sPeak (const xboolean::xbool B)
void SetEnergy (const float E, bool WithCharging=false)
void SetPanel (xpPeakPanel *PP)
void SetPostPeakSlope (const float PPS)
void SetShirleyTailHeight (const float STH)
void SetAngleRatio (const float AR)

Protected Attributes

float Energy
float PostPeakSlope
float ShirleyTailHeight
float AngleRatio
float meastime
float sensitivity
float concentration
float concentrationUncertainty
float peakcounts
float bgndcounts
float peakrate
float bgndrate
float relprec
xboolean::xbool Carbon1sPeak
xpPeakPanel * m_peakpanel

Detailed Description

The "peak component" object for the expert system.

It implements the generic behaviour of spectrum peaks.

Constructor & Destructor Documentation

xpPeakBase::xpPeakBase (  xpSpectrumBase *  Parent,
float  E = 0.0f
)  [inline]
 

Constructor. Sets the numeric parameters to 0.

Parameters:
Parent the parent spectrum the peak belongs to
E the energy of the peak

xpPeakBase::xpPeakBase (  const xpPeakBase &  C  )  [inline]
 

Copy constructor. Copies parameters of C to this peak.

Parameters:
C the peak to be copied

Member Function Documentation

float xpPeakBase::CalcRelPrec (  void   )  [inline]
 

Calculate relative precision of the peak intensity measurement

Returns:
xpPeakBase::relprec

float xpPeakBase::GetAngleRatio (  void   )  const [inline]
 

Return xpSpectrumBase::AngleRatio

Returns:
the value of the "Angle ratio" parameter
See also:
SetAngleRatio

float xpPeakBase::GetBgndCounts (  void   )  [inline]
 

Return counts in the background under the peak

Returns:
xpPeakBase::bgndcounts .

float xpPeakBase::GetBgndRate (  void   )  [inline]
 

Return bgnd rate of the peak

Returns:
xpPeakBase::bgndrate .

xboolean::xbool xpPeakBase::GetCarbon1sPeak (  void   )  const [inline]
 

Return xpPeakBase::Carbon1sPeak

Returns:
True if the peak is Carbon 1s peak
See also:
SetCarbon1sPeak

float xpPeakBase::GetChargingEnergy (  void   )  const [inline]
 

Return xpSpectrumBase::GetChargingEnergy

Returns:
value of the charging energy of its parent.

float xpPeakBase::GetConcentration (  void   )  [inline]
 

Return concentration

Returns:
xpPeakBase::concentration .

float xpPeakBase::GetConcentrationUncertainty (  void   )  [inline]
 

Return concentration

Returns:
xpPeakBase::concentrationUncertainty .

float xpPeakBase::GetEnergy (  bool  WithCharging = false  )  [inline]
 

Returns the energy of the peak, by default without charging shift. If WithCharging is true, the returned value is corrected with the charging shift. If the energy type of the and its parent spectrum is different, the charging shift is negated. Otherwise, no energy type checking is made.

Parameters:
WithCharging the boolean if to correct for charging
See also:
xpPeakBase::GetChargingEnergy

float xpPeakBase::GetEstimatedPeakCounts (  float  rp  )  [inline]
 

Calculate new peak count to match the requested precision; internal use only.

Calculate a nex approximation to the peak counts according to formula

\[ P = \frac{100}{rp}*\sqrt(P + B) + B \]

where
$ P$ is the peak counts
$ B$ is the background counts
$ rp$ is the requested relative precision

Parameters:
rp the requested relative precision
Returns:
the new approximation to peak counts to match the requested pecision

float xpPeakBase::GetMeasTime (  void   )  [inline]
 

Return measurement time

Returns:
xpPeakBase::meastime .

xpPeakPanel* xpPeakBase::GetPanel (  void   )  const [inline]
 

Returns the panel where this peak is displayed

Returns:
the address of panel where the peak is displayed
See also:
SetPanel

float xpPeakBase::GetPeakCounts (  void   )  [inline]
 

Return counts in the peak

Returns:
xpPeakBase::peakcounts .

float xpPeakBase::GetPeakRate (  void   )  [inline]
 

Return count rate of the peak

Returns:
xpPeakBase::peakrate .

float xpPeakBase::GetPostPeakSlope (  void   )  const [inline]
 

Return xpSpectrumBase::PostPeakSlope.

Returns:
value of post peak slope of the peak
See also:
SetPostPeakSlope

float xpPeakBase::GetRate (  const float  counts  )  const [inline]
 

Return rate, corresponding to counts and time

Parameters:
counts the total counts
Returns:
counts divided by meastime.

float xpPeakBase::GetRelPrec (  void   )  [inline]
 

Return relative precision of the peak intensity measurement

Returns:
xpPeakBase::relprec

float xpPeakBase::GetSensitivity (  void   )  [inline]
 

Return sensitivity

Returns:
xpPeakBase::sensitivity .

float xpPeakBase::GetShirleyTailHeight (  void   )  const [inline]
 

Return xpSpectrumBase::ShirleyTailHeight

Returns:
the value of the Shirley Tail Height parameter
See also:
SetShirleyTailHeight

bool xpPeakBase::IsCarbon1sPeak (  void   )  [inline]
 

Return True if the peak is Carbon 1s peak

Returns:
the status if the peak is C1s peak

bool xpPeakBase::IsPeakInRangeBE (  const float  BELow,
const float  BEHigh
)  [inline]
 

Returns 'true' if peak energy is between the binding energy values BELow and BEHigh, 'false' otherwise. The peak energy is transformed to BE scale if necessary.

Parameters:
BELow the low bound of the binding energy range
BEHigh the high bound of the binding energy range
Returns:
the status if the peak is in the given BE range

bool xpPeakBase::IsPeakInRangeKE (  const float  KELow,
const float  KEHigh
)  [inline]
 

Returns 'true' if peak energy is between the kinetic energy values KELow and KEHigh, 'false' otherwise. The peak energy is transformed to KE scale if necessary.

Parameters:
KELow the low bound of the kinetic energy range
KEHigh the high bound of the kinetic energy range
Returns:
the status if the peak is in the given KE range

void xpPeakBase::SetAngleRatio (  const float  AR  )  [inline]
 

Set xpSpectrumBase::AngleRatio Sets the AngleRatio parameter

Parameters:
AR the new value of the "Angle ratio" parameter
See also:
GetAngleRatio

void xpPeakBase::SetBgndCounts (  const float  c  )  [inline]
 

Set counts in the background under the peak

Parameters:
c in the background under the peak
Returns:
xpPeakBase::peakcounts .

void xpPeakBase::SetBgndRate (  const float  r  )  [inline]
 

Set counting rate of the background under the peak

Parameters:
r in the background under the peak
Returns:
xpPeakBase::bgndrate .

void xpPeakBase::SetCarbon1sPeak (  const xboolean::xbool  B  )  [inline]
 

Set xpSpectrumBase::Carbon1sPeak

Parameters:
B the new status of the flag Carbon 1s peak
See also:
GetCarbon1sPeak

void xpPeakBase::SetConcentration (  const float  C  )  [inline]
 

Set concentration

Parameters:
C new concentration

void xpPeakBase::SetConcentrationUncertainty (  const float  C  )  [inline]
 

Set concentration

Parameters:
C new concentration

void xpPeakBase::SetEnergy (  const float  E,
bool  WithCharging = false
)  [inline]
 

Set xpPeakBase::Energy from E. If WithCharging is true, the returned value is corrected with the charging shift ChargingEnergy. If the energy type of the peak and that of its parent spectrum are different, the charging shift ChargingEnergy is negated. Otherwise, no energy type checking is made.

Parameters:
E the new value of the peak energy parameter
WithCharging the boolean if to correct for charging
See also:
GetEnergy

void xpPeakBase::SetMeasTime (  const float  t  )  [inline]
 

Set measurement time

Parameters:
t the new meas time
Returns:
xpPeakBase::meastime .

void xpPeakBase::SetPanel (  xpPeakPanel *  PP  )  [inline]
 

Sets the panel where this peak is displayed

Parameters:
PP the address of panel where the peak is displayed
See also:
GetPanel

void xpPeakBase::SetPeakCounts (  const float  c  )  [inline]
 

Set counts in the peak

Parameters:
c the new count in the peak
Returns:
xpPeakBase::peakcounts .

void xpPeakBase::SetPeakRate (  const float  r  )  [inline]
 

Set counting rate of the peak

Parameters:
r in the background under the peak
Returns:
xpPeakBase::peakrate .

void xpPeakBase::SetPostPeakSlope (  const float  PPS  )  [inline]
 

Set xpPeakBase::PostPeakSlope. Sets the Post Peak Slope parameter.

Parameters:
PPS the new value of the Post Peak Slope parameter
See also:
GetPostPeakSlope

void xpPeakBase::SetRelPrec (  const float  r  )  [inline]
 

Set relative precision of measung the the peak. Calculates new xpPeakBase::peakcounts to match the requested relative precision

Parameters:
r in the requested relative precision

void xpPeakBase::SetSensitivity (  const float  S  )  [inline]
 

Set sensitivity

Parameters:
S new sensitivity

void xpPeakBase::SetShirleyTailHeight (  const float  STH  )  [inline]
 

Set xpSpectrumBase::ShirleyTailHeight Sets the Shirley Tail Height parameter

Parameters:
STH the new value of the Shirley Tail Height parameter
See also:
GetShirleyTailHeight

Field Documentation

float xpPeakBase::AngleRatio [protected]
 

The intensity ratio seen at different angles.

float xpPeakBase::bgndcounts [protected]
 

bgnd counts

float xpPeakBase::bgndrate [protected]
 

bgnd count rate

xboolean::xbool xpPeakBase::Carbon1sPeak [protected]
 

If the peak is Carbon 1s peak: True, False or Unknown.

float xpPeakBase::concentration [protected]
 

Concentration of element.

float xpPeakBase::concentrationUncertainty [protected]
 

Concentration uncertainty of element.

float xpPeakBase::Energy [protected]
 

The energy parameter of the peak.

xpPeakPanel* xpPeakBase::m_peakpanel [protected]
 

The panel where this peak is shown.

float xpPeakBase::meastime [protected]
 

Meas time, in secs.

float xpPeakBase::peakcounts [protected]
 

peak couns

float xpPeakBase::peakrate [protected]
 

peak count rate

float xpPeakBase::PostPeakSlope [protected]
 

The value of the post peak slope.

float xpPeakBase::relprec [protected]
 

relative precision of the measurement

float xpPeakBase::sensitivity [protected]
 

Sensitivity of peak detection.

float xpPeakBase::ShirleyTailHeight [protected]
 

The value of the Shirley tail height.

The documentation for this class was generated from the following file:
Generated on Tue Dec 23 10:24:40 2003 for xps4xps by doxygen 1.3.5