gov.nist.microanalysis.EPQLibrary
Class NISTXRayTransitionDB

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

public class NISTXRayTransitionDB
extends java.lang.Object

A database of x-ray transition energies from theory and measurements. The source of this data is http://physics.nist.gov/PhysRefData/XrayTrans/

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

Field Summary

static java.lang.String	COMBINED
static java.lang.String	DIRECT
static java.lang.String	THEORY
static java.lang.String	UNAVAILABLE
static java.lang.String	VAPOR

Constructor Summary

NISTXRayTransitionDB()

Method Summary

java.lang.String	getDefaultDatumType(AtomicShell shell) getDefaultDatumType - Returns one of THEORY, BLEND, COMBINED, VAPOR or UNAVAILABLE depending upon which type of value would be returned by the getEdgeEnergy(AtomicShell shell) method.
java.lang.String	getDefaultDatumType(XRayTransition xrt) getDefaultDatumType - Returns one of THEORY, BLEND, COMBINED, VAPOR or UNAVAILABLE depending upon which type of value would be returned by the getEnergy(XRayTransition xrt) method.
double	getEdgeEnergy(AtomicShell sh) getEdgeEnergy - Returns the edge energy for the specified AtomicShell (Element and shell.)
double	getEdgeEnergy(AtomicShell shell, java.lang.String type) getEdgeEnergy - Returns the energy (in Joules) for the specific edge.
double	getEnergy(XRayTransition xrt) getEnergy - Gets the energy (in Joules) of the specified transition.
double	getEnergy(XRayTransition xrt, java.lang.String type) getEnergy - Returns the energy (in Joules) for the specific transition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

THEORY

public static java.lang.String THEORY

COMBINED

public static java.lang.String COMBINED

VAPOR

public static java.lang.String VAPOR

DIRECT

public static java.lang.String DIRECT

UNAVAILABLE

public static java.lang.String UNAVAILABLE

Constructor Detail

NISTXRayTransitionDB

public NISTXRayTransitionDB()

Method Detail

getDefaultDatumType

public java.lang.String getDefaultDatumType(XRayTransition xrt)

getDefaultDatumType - Returns one of THEORY, BLEND, COMBINED, VAPOR or UNAVAILABLE depending upon which type of value would be returned by the getEnergy(XRayTransition xrt) method.

Parameters:

xrt - XRayTransition

Returns:

String

getDefaultDatumType

public java.lang.String getDefaultDatumType(AtomicShell shell)

getDefaultDatumType - Returns one of THEORY, BLEND, COMBINED, VAPOR or UNAVAILABLE depending upon which type of value would be returned by the getEdgeEnergy(AtomicShell shell) method.

Parameters:

shell - AtomicShell

Returns:

String

getEnergy

public double getEnergy(XRayTransition xrt)

getEnergy - Gets the energy (in Joules) of the specified transition. If no data exists for the specified transition, NaN is returned. The data available for each transition is searched in the order THEORY, BLEND, COMBINED, VAPOR for the first valid value. This value is returned.

Parameters:

xrt - XRayTransition

Returns:

double

getEnergy

public double getEnergy(XRayTransition xrt,
                        java.lang.String type)

getEnergy - Returns the energy (in Joules) for the specific transition. This method allows the user to specify which type of value they would like from THEORY, BLEND, COMBINED and VAPOR. If this value is unavailable this method returns Double.NaN.

Parameters:

xrt - XRayTransition

type - String

Returns:

double

getEdgeEnergy

public double getEdgeEnergy(AtomicShell shell,
                            java.lang.String type)

getEdgeEnergy - Returns the energy (in Joules) for the specific edge. This method allows the user to specify which type of value they would like from THEORY, BLEND, COMBINED and VAPOR. If this value is unavailable this method returns Double.NaN.

Parameters:

shell - AtomicShell

type - String

Returns:

double

getEdgeEnergy

public double getEdgeEnergy(AtomicShell sh)

getEdgeEnergy - Returns the edge energy for the specified AtomicShell (Element and shell.)

Parameters:

sh - AtomicShell

Returns:

double