gov.nist.microanalysis.EPQLibrary
Class TransitionEnergy

java.lang.Object
  gov.nist.microanalysis.EPQLibrary.AlgorithmClass
      gov.nist.microanalysis.EPQLibrary.TransitionEnergy

All Implemented Interfaces:

java.lang.Comparable

public abstract class TransitionEnergy
extends AlgorithmClass

A set of various different algorithms and databases for the x-ray transition energy.

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 TransitionEnergy	Chantler2005 Chandler2005 - Computes the transition energies from the edge energies provided by "Chantler, C.T., Olsen, K., Dragoset, R.A., Kishore, A.R., Kotochigova, S.A., and Zucker, D.S.
static TransitionEnergy	Default Default - The default implementation of the TransitionEnergy class as used by XRayTransition.getEnergy*(...).
static TransitionEnergy	DTSA DTSA - Extracts the transition energy from the DTSA database.

Constructor Summary

protected

TransitionEnergy(java.lang.String name, java.lang.String reference)

Method Summary

abstract double	compute(XRayTransition xrt) compute - Compute the transition energy for the specified transition.
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(XRayTransition xrt) isSupported - Can this algorithm compute the transition 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

Chantler2005

public static final TransitionEnergy Chantler2005

Chandler2005 - Computes the transition energies from the edge energies provided by "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 transitions to and from shells K to O5, P1 to P3.

DTSA

public static final TransitionEnergy DTSA

DTSA - Extracts the transition energy from the DTSA database.

Default

public static TransitionEnergy Default

Default - The default implementation of the TransitionEnergy class as used by XRayTransition.getEnergy*(...).

Constructor Detail

TransitionEnergy

protected TransitionEnergy(java.lang.String name,
                           java.lang.String reference)

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(XRayTransition xrt)
                        throws EPQException

compute - Compute the transition energy for the specified transition.

Parameters:

xrt - XRayTransition

Returns:

double

Throws:

EPQException

isSupported

public abstract boolean isSupported(XRayTransition xrt)

isSupported - Can this algorithm compute the transition energy for the specified transition?

Parameters:

xrt - XRayTransition

Returns:

boolean