characteristic Class Reference

Characteristic wavelengths of commonly used x-ray tube target materials. More...

#include <wavelengths.h>

List of all members.

Public Member Functions

 characteristic ()
 Default constructor. Calling certain methods may cause crashes!
 characteristic (std::string const &label)
 Retrieves characteristic wavelength for given label.
bool is_valid () const
 Tests if the label passed to the contructor could be matched.
const char * label () const
 Returns label (e.g. Cu or CuA1).
float as_angstrom () const
 Wavelength (Angstrom).
float as_kev () const
 Energy [keV].
float as_ev () const
 Energy [eV].

Friends

class characteristic_iterator


Detailed Description

Characteristic wavelengths of commonly used x-ray tube target materials.

Constructor & Destructor Documentation

characteristic ( std::string const &  label  ) 

Retrieves characteristic wavelength for given label.

The lookup is not case-sensitive.

See also: is_valid()


Member Function Documentation

bool is_valid (  )  const [inline]

Tests if the label passed to the contructor could be matched.

Shorthand for: as_angstrom() != 0

const char* label (  )  const [inline]

Returns label (e.g. Cu or CuA1).

See also: is_valid()

float as_angstrom (  )  const [inline]

Wavelength (Angstrom).

See also: is_valid()

float as_kev (  )  const [inline]

Energy [keV].

See also: is_valid()

Referenced by characteristic::as_ev().

float as_ev (  )  const [inline]

Energy [eV].

See also: is_valid()

References characteristic::as_kev().


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

Generated on Tue Sep 1 17:12:31 2009 for cctbx by  doxygen 1.5.6