gov.nist.microanalysis.EPQLibrary
Class EdgeEnergy

java.lang.Object
  extended by gov.nist.microanalysis.EPQLibrary.AlgorithmClass
      extended by gov.nist.microanalysis.EPQLibrary.EdgeEnergy
All Implemented Interfaces:
java.lang.Comparable

public abstract class EdgeEnergy
extends AlgorithmClass

Various different implementations of classes that return the edge energy for a specified AtomicShell.

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 EdgeEnergy Chantler2005
          Chantler2005 - A set of edge energies from "Chantler, C.T., Olsen, K., Dragoset, R.A., Kishore, A.R., Kotochigova, S.A., and Zucker, D.S.
static EdgeEnergy Default
           
static EdgeEnergy DTSA
          DTSA - From DTSA at http://www.cstl.nist.gov/div837/Division/outputs/DTSA/DTSA.htm
static EdgeEnergy NISTxrtdb
          NISTxrtdb - The NIST x-ray transition database provides edge energies for the K and L shells for atomic numbers from 10 to 100.
static EdgeEnergy Wernish84
          Wernish84 - Wernisch et al., 1984 - Taken from Markowitz in the Handbook of X-ray Spectroscopy
 
Constructor Summary
protected EdgeEnergy(java.lang.String name, java.lang.String ref)
           
 
Method Summary
abstract  double compute(AtomicShell shell)
          getEdgeEnergy - Returns the edge energy associated with the specified atomic shell (in Joules)
 double compute(XRayTransition xrt)
          getEdgeEnergy - Returns the edge energy (in Joules) associated with the specified tranition.
 java.util.List getAllImplementations()
          getAllImplementations - Returns a full list of all available algorithms.
protected  void initializeDefaultStrategy()
          initializeDefaultStrategy - Implement this method in derived classes to specify the contents (possibly null) of the default Strategy using the addDefaultAlgorithm(Class,AlgorithmClass) method.
abstract  boolean isSupported(AtomicShell shell)
          supports - Does this particular implementation provide a non-zero edge energy for the specified transition?
 
Methods inherited from class gov.nist.microanalysis.EPQLibrary.AlgorithmClass
addDefaultAlgorithm, allAlgorithmNames, allAlgorithms, applyGlobalOverride, clearGlobalOverride, compareTo, documentStrategy, getActiveStrategy, getAlgorithm, getAlgorithmClass, getName, getReference, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NISTxrtdb

public static final EdgeEnergy NISTxrtdb
NISTxrtdb - The NIST x-ray transition database provides edge energies for the K and L shells for atomic numbers from 10 to 100.


Chantler2005

public static final EdgeEnergy Chantler2005
Chantler2005 - A set of edge energies from "Chantler, C.T., Olsen, K., Dragoset, R.A., Kishore, A.R., Kotochigova, S.A., and Zucker, D.S. (2005), X-Ray Form Factor, Attenuation and Scattering Tables (version 2.1). [Online] Available: http://physics.nist.gov/ffast 10-Mar-2005. National Institute of Standards and Technology, Gaithersburg, MD. Originally published as Chantler, C.T., J. Phys. Chem. Ref. Data 29(4), 597-1048 (2000); and Chantler, C.T., J. Phys. Chem. Ref. Data 24, 71-643 (1995)." Supports elements H to U and shells K to O5, P1 to P3.


Wernish84

public static final EdgeEnergy Wernish84
Wernish84 - Wernisch et al., 1984 - Taken from Markowitz in the Handbook of X-ray Spectroscopy


DTSA

public static final EdgeEnergy DTSA
DTSA - From DTSA at http://www.cstl.nist.gov/div837/Division/outputs/DTSA/DTSA.htm


Default

public static EdgeEnergy Default
Constructor Detail

EdgeEnergy

protected EdgeEnergy(java.lang.String name,
                     java.lang.String ref)
Method Detail

initializeDefaultStrategy

protected void initializeDefaultStrategy()
Description copied from class: AlgorithmClass
initializeDefaultStrategy - Implement this method in derived classes to specify the contents (possibly null) of the default Strategy using the addDefaultAlgorithm(Class,AlgorithmClass) method.

Specified by:
initializeDefaultStrategy in class AlgorithmClass

getAllImplementations

public java.util.List getAllImplementations()
getAllImplementations - Returns a full list of all available algorithms. Each item is an implements the EdgeEnergy class.

Specified by:
getAllImplementations in class AlgorithmClass
Returns:
List

compute

public abstract double compute(AtomicShell shell)
getEdgeEnergy - Returns the edge energy associated with the specified atomic shell (in Joules)

Parameters:
shell - AtomicShell
Returns:
double

compute

public double compute(XRayTransition xrt)
getEdgeEnergy - Returns the edge energy (in Joules) associated with the specified tranition.

Parameters:
xrt - XRayTransition
Returns:
double

isSupported

public abstract boolean isSupported(AtomicShell shell)
supports - Does this particular implementation provide a non-zero edge energy for the specified transition?

Parameters:
shell - AtomicShell
Returns:
boolean