gov.nist.microanalysis.EPQTools
Class KLMLine

java.lang.Object
  gov.nist.microanalysis.EPQTools.KLMLine

All Implemented Interfaces:

java.lang.Comparable

public class KLMLine
extends java.lang.Object
implements java.lang.Comparable

A small class for representing KLM lines.

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:

Daniel "Ooblioob" Davis

Field Summary

static int	InvalidType
static int	KEdge
static int	KTransition
static int	LEdge
static int	LTransition
static int	MEdge
static int	MTransition
static int	NEdge
static int	NTransition
static int	Satellite
static int	SumPeak

Constructor Summary

KLMLine(AtomicShell as)
Constructs a KLMLine representing an edge

KLMLine(XRayTransition xrt)
Constructs a KLMLine representing a transition

KLMLine(XRayTransition xrt1, XRayTransition xrt2)
Constructs a KLMLine representing a sum peak

Method Summary

int	compareTo(java.lang.Object obj) compareTo - Allows to KLM lines to be ordered.
double	getAmplitude() getAmplitude - returns the amplitude of a particular KLM line.
double	getEnergy() getEnergy - Returns the energy of a particular KLM line.
AtomicShell	getShell() getShell - Returns the shell with which this transition or edge is associated.
int	getType() getType - Returns the type of KLM line - One of Transition, Edge, Satellite, SumPeak
boolean	similarTo(KLMLine klm) Are these two KLM lines of the same general family and element.
java.lang.String	toString() toString - Returns a label for the KLM line.

Methods inherited from class java.lang.Object

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

Field Detail

InvalidType

public static final int InvalidType

See Also:

Constant Field Values

KTransition

public static final int KTransition

See Also:

Constant Field Values

LTransition

public static final int LTransition

See Also:

Constant Field Values

MTransition

public static final int MTransition

See Also:

Constant Field Values

NTransition

public static final int NTransition

See Also:

Constant Field Values

KEdge

public static final int KEdge

See Also:

Constant Field Values

LEdge

public static final int LEdge

See Also:

Constant Field Values

MEdge

public static final int MEdge

See Also:

Constant Field Values

NEdge

public static final int NEdge

See Also:

Constant Field Values

Satellite

public static final int Satellite

See Also:

Constant Field Values

SumPeak

public static final int SumPeak

See Also:

Constant Field Values

Constructor Detail

KLMLine

public KLMLine(XRayTransition xrt)

Constructs a KLMLine representing a transition

Parameters:

xrt -

KLMLine

public KLMLine(AtomicShell as)

Constructs a KLMLine representing an edge

Parameters:

as -

KLMLine

public KLMLine(XRayTransition xrt1,
               XRayTransition xrt2)

Constructs a KLMLine representing a sum peak

Parameters:

xrt1 -

xrt2 -

Method Detail

getEnergy

public double getEnergy()

getEnergy - Returns the energy of a particular KLM line.

Returns:

double

getAmplitude

public double getAmplitude()

getAmplitude - returns the amplitude of a particular KLM line.

Returns:

double

toString

public java.lang.String toString()

toString - Returns a label for the KLM line.

Overrides:

toString in class java.lang.Object

Returns:

String

getType

public int getType()

getType - Returns the type of KLM line - One of Transition, Edge, Satellite, SumPeak

Returns:

int

getShell

public AtomicShell getShell()

getShell - Returns the shell with which this transition or edge is associated. Returns null for a sum peak.

Returns:

AtomicShell

compareTo

public int compareTo(java.lang.Object obj)

compareTo - Allows to KLM lines to be ordered.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

obj - Object

Returns:

int

similarTo

public boolean similarTo(KLMLine klm)

Are these two KLM lines of the same general family and element.

Parameters:

klm -

Returns:

boolean - true if the lines are in the same family, false otherwise.