|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectgov.nist.microanalysis.EPQLibrary.XRayTransition
public final class XRayTransition
A class for managing the various different ways that x-ray transitions are identified and labeled.
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
| Field Summary | |
|---|---|
static int[] |
ALL_TRANSITIONS
|
static int |
KA1
|
static int |
KA2
|
static int |
KB1
|
static int |
KB2
|
static int |
KB3
|
static int |
KB4
|
static int |
KB5
|
static int |
L1M1
|
static int |
L1N1
|
static int |
L1N4
|
static int |
L1O1
|
static int |
L1O4
|
static int |
L2M2
|
static int |
L2M5
|
static int |
L2N2
|
static int |
L2N3
|
static int |
L2N5
|
static int |
L2O2
|
static int |
L2O3
|
static int |
L2P2
|
static int |
L3N2
|
static int |
L3N3
|
static int |
L3O2
|
static int |
L3O3
|
static int |
L3P1
|
static int |
LA1
|
static int |
LA2
|
static int |
Last
|
static int |
LB1
|
static int |
LB10
|
static int |
LB15
|
static int |
LB17
|
static int |
LB2
|
static int |
LB3
|
static int |
LB4
|
static int |
LB5
|
static int |
LB6
|
static int |
LB7
|
static int |
LB9
|
static int |
LG1
|
static int |
LG11
|
static int |
LG2
|
static int |
LG3
|
static int |
LG4
|
static int |
LG4p
|
static int |
LG5
|
static int |
LG6
|
static int |
LG8
|
static int |
Ll
|
static int |
Ln
|
static int |
Ls
|
static int |
Lt
|
static int |
Lu
|
static int |
Lv
|
static int |
M1N2
|
static int |
M1N3
|
static int |
M2M4
|
static int |
M2N1
|
static int |
M2N4
|
static int |
M2O4
|
static int |
M3M4
|
static int |
M3M5
|
static int |
M3N1
|
static int |
M3N4
|
static int |
M3O1
|
static int |
M3O4
|
static int |
M3O5
|
static int |
M4N3
|
static int |
M4O2
|
static int |
M5O3
|
static int |
MA1
|
static int |
MA2
|
static int |
MB
|
static int |
MG
|
static int |
MZ1
|
static int |
MZ2
|
static int |
N4N6
|
static int |
N5N6
|
static int |
None
|
static int |
NormalizationDefault
NormalizationDefault - The weights are as they were read from the data table. |
static int |
NormalizeDestination
NormalizeDestination - Normalize the weights do the total weight representing transitions into a single destination shell sums to 1.0. |
static int |
NormalizeFamily
NormalizeFamily - Normalize the weights so the the total weight in family (KFamily, LFamily, MFamily) sums to 1.0. |
static int |
NormalizeKLM
NormalizeKLM - Normalize the weights so that the heaviest weight KLM line has an amplitude of 1.0. |
static int |
Unnamed
|
| Constructor Summary | |
|---|---|
XRayTransition(AtomicShell dest,
int srcShell)
XRayTransition - Create an object corresponding to a transition between the specified destination (dest) shell and the specific source shell (srcShell) |
|
XRayTransition(Element el,
int trans)
XRayTransition - Create an object corresponding to a specific x-ray transition in a specific element. |
|
XRayTransition(Element element,
int src,
int dest)
XRayTransition - Create an object corresponding to a specific x-ray transition in a specific element. |
|
| Method Summary | |
|---|---|
java.lang.Object |
clone()
|
int |
compareTo(java.lang.Object obj)
compareTo - Orders by atomic number then by destination shell and finally by source shell. |
static java.util.Collection |
createByDestinationShell(AtomicShell dest)
createByDestinationShell - Creates a list of all x-ray transition lines that may occur when the destination shell is empty. |
boolean |
equals(java.lang.Object obj)
equals - returns true if the value of obj is exactly equal to the value of this. |
boolean |
exists()
exists - Does this x-ray transition exists (with non-zero weight)? (ie. |
static boolean |
exists(Element el,
int xrt)
exists - The specified x-ray transition exists (with non-zero weight) for the specified element? (ie. |
static boolean |
familyExists(Element el,
int family)
Does one or more transitions exist for the specified element and transition family. |
AtomicShell |
getDestination()
getDestination - Get the shell to which the electron jumps during the x-ray emission process. |
int |
getDestinationShell()
getDestinationShell - Get the shell to which the electron jumps during the x-ray emission process. |
static int |
getDestinationShell(int xrt)
getDestinationShell - Get the shell to which the electron jumps during the x-ray emission process. |
double |
getEdgeEnergy()
getEdgeEnergy - Returns the mininum electron energy required to excite this transition. |
Element |
getElement()
getElement - Get the element associated with this transition. |
double |
getEnergy_eV()
getEnergy_eV - Returns the energy of the transition in eV. |
static double |
getEnergy_eV(Element el,
int trans)
getEnergy_eV - Get the x-ray energy associated with the specified transition for the specified Element as eV. |
double |
getEnergy()
getEnergy - Returns the energy of the transition in Joules. |
static double |
getEnergy(Element el,
int trans)
getEnergy - Get the x-ray energy associated with the specified transition for the specified Element. |
int |
getFamily()
getFamily - Returns the index of the family associated with this transition. |
static int |
getFamily(int xrt)
getFamily - A static method for returning the family with which a transition is associated. |
static int |
getFirstIntoShell(AtomicShell shell)
getFirstIntoShell - Get the first transition (ordered by the order of the enumerated shell index) that ends in the specified shell. |
static int |
getFirstTransition(int family)
getFirstTransition - Get the first transition (by enumerated index) in the specified line family (AtomicShell.KFamily...AtomicShell.NFamily) |
java.lang.String |
getIUPACName()
getIUPACName - Returns the IUPAC name for the current transition. |
static java.lang.String |
getIUPACName(int xrt)
getIUPACName - Returns the IUPAC name for the specified transition. |
static int |
getLastIntoShell(AtomicShell shell)
getLastIntoShell - Get the last (plus one) transition (ordered by the order of the enumerated shell index) that ends in the specified shell. |
static int |
getLastTransition(int family)
getLastTransition - Get the last transition (by enumerated index) in the specified line family (AtomicShell.KFamily...AtomicShell.NFamily) |
double |
getNormalizedWeight()
getNormalizedWeight - Gets the transition weight associated with this transition. |
java.lang.String |
getSiegbahnName()
|
AtomicShell |
getSource()
getSource - Get the higher energy shell from which the electron its transition into the vacant core shell. |
int |
getSourceShell()
getSourceShell - Get the (typically valence) shell from which the electron starts its transition to the (typically core) shell. |
static int |
getSourceShell(int xrt)
getSourceShell - Get the (typically valence) shell from which the electron starts its transition to the (typically core) shell for the specified named transition. |
static XRayTransition |
getStrongestLine(AtomicShell shell)
getStrongestLine - For the element and edge specified by the AtomicShell object, returns the XRayTransition with the highest weight. |
int |
getTransitionIndex()
getTransitionIndex - Get the index associated with this transition (KA1, KA2,....) |
static double |
getWeight(Element el,
int trans,
int mode)
getWeight - Gets the transition weight associated with the specified elemet and transition. |
double |
getWeight(int mode)
getWeight - Gets the transition weight associated with this transition. |
static double |
getWeightIntoDestinationShell(Element el,
int shell)
getWeightIntoDestinationShell - Returns the fraction of the total weight (normalized by family) which results from transitions into the specified shell. |
int |
hashCode()
|
boolean |
isWellKnown()
isWellKnown - In this transition one of the well-known named transitions. |
static boolean |
isWellKnown(int trans)
isWellKnown - In this transition one of the well-known named transitions. |
static int |
lineWithHighestEnergy(Element el,
int family)
lineWithHighestEnergy - Returns the line index of the line in the specified family with the highest x-ray energy. |
static int |
lineWithLowestEnergy(Element el,
int family)
lineWithLowestEnergy - Returns the line index of the line in the specified family with the lowest x-ray energy. |
static boolean |
occurs(int elm,
int trans)
occurs - Does this x-ray line have a weight greater than zero? |
static XRayTransition |
parseString(java.lang.String str)
parseString - The inverse of toString() |
static java.lang.String |
removeGreek(java.lang.String str)
|
boolean |
shouldExist()
shouldExist - Should this transition exist (as an x-ray transition) based on whether the electric dipole and quadrupole selection rules permit the transition and whether in a ground state atom both the source and destination shells are occupied. |
static boolean |
shouldExist(AtomicShell src,
AtomicShell dest)
shouldExist - Should this transition exist (as an x-ray transition) based on whether the electric dipole and quadrupole selection rules permit the transition and whether in a ground state atom both the source and destination shells are occupied. |
static boolean |
shouldExist(Element el,
int srcShell,
int destShell)
shouldExist - Should this transition exist (as an x-ray transition) based on whether the electric dipole and quadrupole selection rules permit the transition and whether in a ground state atom both the source and destination shells are occupied. |
java.lang.String |
toString()
|
static int |
TransitionFromShells(int src,
int dest)
TransitionFromShells - Returns an integer representing the named transition when an electron goes from src to dest. |
static int[] |
transitionsIntoShell(int shell)
transitionsIntoShell - Returns a list of the integer indexes of transitions that end in the specified shell. |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final int KA1
public static final int KA2
public static final int KB1
public static final int KB2
public static final int KB3
public static final int KB4
public static final int KB5
public static final int L3N2
public static final int L3N3
public static final int L3O2
public static final int L3O3
public static final int L3P1
public static final int LA1
public static final int LA2
public static final int LB15
public static final int LB2
public static final int LB5
public static final int LB6
public static final int LB7
public static final int Ll
public static final int Ls
public static final int Lt
public static final int Lu
public static final int L2M2
public static final int L2M5
public static final int L2N2
public static final int L2N3
public static final int L2N5
public static final int L2O2
public static final int L2O3
public static final int L2P2
public static final int LB1
public static final int LB17
public static final int LG1
public static final int LG5
public static final int LG6
public static final int LG8
public static final int Ln
public static final int Lv
public static final int L1M1
public static final int L1N1
public static final int L1N4
public static final int L1O1
public static final int L1O4
public static final int LB10
public static final int LB3
public static final int LB4
public static final int LB9
public static final int LG2
public static final int LG11
public static final int LG3
public static final int LG4
public static final int LG4p
public static final int M1N2
public static final int M1N3
public static final int M2M4
public static final int M2N1
public static final int M2N4
public static final int M2O4
public static final int M3M4
public static final int M3M5
public static final int M3N1
public static final int M3N4
public static final int M3O1
public static final int M3O4
public static final int M3O5
public static final int MG
public static final int M4N3
public static final int M4O2
public static final int MB
public static final int MZ2
public static final int M5O3
public static final int MA1
public static final int MA2
public static final int MZ1
public static final int N4N6
public static final int N5N6
public static final int Last
public static final int Unnamed
public static final int None
public static final int[] ALL_TRANSITIONS
public static final int NormalizationDefault
public static final int NormalizeFamily
public static final int NormalizeDestination
public static final int NormalizeKLM
| Constructor Detail |
|---|
public XRayTransition(Element el,
int trans)
el - Elementtrans - int - One of the named transition KA1 to N5N6
public XRayTransition(Element element,
int src,
int dest)
element - Elementsrc - int - One of the AtomicShell.K to AtomicShell.PXIdest - int - One of the AtomicShell.K to AtomicShell.PXI
public XRayTransition(AtomicShell dest,
int srcShell)
dest - AtomicShell - The inner most shell involved in the transition.srcShell - int - One of the AtomicShell.K to AtomicShell.PXI| Method Detail |
|---|
public int getTransitionIndex()
public int getSourceShell()
public AtomicShell getSource()
public static int getSourceShell(int xrt)
xrt - - a named transition
public int getDestinationShell()
public AtomicShell getDestination()
public static int getDestinationShell(int xrt)
xrt - - a named transition
public Element getElement()
public boolean isWellKnown()
public static boolean isWellKnown(int trans)
trans - int - a transition in the range [KA1,Last)
public java.lang.String toString()
toString in class java.lang.Objectpublic static XRayTransition parseString(java.lang.String str)
str -
public java.lang.String getIUPACName()
public java.lang.String getSiegbahnName()
public static java.lang.String removeGreek(java.lang.String str)
public static java.lang.String getIUPACName(int xrt)
xrt - - The index of an x-ray transition
public double getEnergy()
throws EPQException
EPQException
public double getEnergy_eV()
throws EPQException
EPQException
public static double getEnergy_eV(Element el,
int trans)
throws EPQException
el - Elementtrans - int
EPQException
public static double getEnergy(Element el,
int trans)
throws EPQException
el - Elementtrans - int
EPQExceptionpublic double getEdgeEnergy()
public double getWeight(int mode)
mode - int One of DefaultNormalization, NormalizeFamily, or
NormalizeDestination
EPQFatalException - - When weight data is unavailable
public static double getWeight(Element el,
int trans,
int mode)
mode - int One of DefaultNormalization, NormalizeFamily, or
NormalizeDestination
EPQFatalException - - When weight data is unavailablepublic double getNormalizedWeight()
EPQFatalException - - When weight data is unavailablepublic int getFamily()
EPQExceptionpublic static int getFamily(int xrt)
xrt - int - A valid named transition index
public static boolean occurs(int elm,
int trans)
elm - inttrans - int
public static XRayTransition getStrongestLine(AtomicShell shell)
throws EPQException
shell - AtomicShell
EPQExceptionpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Objectobj - Object
public int hashCode()
hashCode in class java.lang.Objectpublic java.lang.Object clone()
clone in class java.lang.Objectpublic int compareTo(java.lang.Object obj)
compareTo in interface java.lang.Comparableobj -
public static java.util.Collection createByDestinationShell(AtomicShell dest)
dest - AtomicShell
public static int getFirstTransition(int family)
family - int
public static int getLastTransition(int family)
family - int
public static int getFirstIntoShell(AtomicShell shell)
shell - AtomicShell
public static int getLastIntoShell(AtomicShell shell)
shell - AtomicShell
public static int lineWithHighestEnergy(Element el,
int family)
el - Elementfamily - int
public static int lineWithLowestEnergy(Element el,
int family)
el - Elementfamily - int
public static boolean exists(Element el,
int xrt)
el - Elementxrt - int
public boolean exists()
public boolean shouldExist()
public static boolean shouldExist(AtomicShell src,
AtomicShell dest)
src - AtomicShelldest - AtomicShell (note:
src.getAtomicNumber()==dest.getAtomicNumber())
public static boolean shouldExist(Element el,
int srcShell,
int destShell)
el - ElementsrcShell - intdestShell - int
public static double getWeightIntoDestinationShell(Element el,
int shell)
el - Element - The elementshell - int - The destination (lower energy) shell
public static int TransitionFromShells(int src,
int dest)
src - intdest - int
public static int[] transitionsIntoShell(int shell)
shell - One of AtomicShell.K to AtomicShell.NV
public static boolean familyExists(Element el,
int family)
el - An elementfamily - - One of AtomicShell.KFamily, AtomicShell.LFamily,
AtomicShell.MFamily or AtomicShell.NFamily.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||