org.jscience.physics.nuclear.kinematics.math.analysis
Class Multiplet

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractList<E>
          java.util.Vector
              org.jscience.physics.nuclear.kinematics.math.analysis.Multiplet

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List, java.util.RandomAccess

public class Multiplet
extends java.util.Vector

DOCUMENT ME!

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Vector

capacityIncrement, elementCount, elementData

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Multiplet()
Creates new Multiplet

Multiplet(Peak p)
Creates a new Multiplet object.

Method Summary

void	addMultiplet(Multiplet madd) DOCUMENT ME!
void	addPeak(Peak p) DOCUMENT ME!
double[]	getAllCentroids() DOCUMENT ME!
Peak[]	getAllPeaks() DOCUMENT ME!
double[]	getCentroidErrors() DOCUMENT ME!
Peak	getPeak(int index) DOCUMENT ME!
Peak	getPeakNear(double centroid, double tolerance) Returns peak nearest given centroid if distance is less than the given tolerance.
Multiplet	lastPeaks(int n) Returns a new multiplet containing only the last n peaks of this multiplet.
int	removeAreaGreaterThan(double max) Removes all peaks with greater than the specified area.
int	removeAreaLessThan(double min) Removes all peaks with less than the specified area.

Methods inherited from class java.util.Vector

add, add, addAll, addAll, addElement, capacity, clear, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, lastElement, lastIndexOf, lastIndexOf, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeRange, retainAll, set, setElementAt, setSize, size, subList, toArray, toArray, toString, trimToSize

Methods inherited from class java.util.AbstractList

iterator, listIterator, listIterator

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

iterator, listIterator, listIterator

Constructor Detail

Multiplet

public Multiplet()

Creates new Multiplet

Multiplet

public Multiplet(Peak p)

Creates a new Multiplet object.

Parameters:

p - DOCUMENT ME!

Method Detail

getAllPeaks

public Peak[] getAllPeaks()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getAllCentroids

public double[] getAllCentroids()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getCentroidErrors

public double[] getCentroidErrors()

DOCUMENT ME!

Returns:

DOCUMENT ME!

addMultiplet

public void addMultiplet(Multiplet madd)

DOCUMENT ME!

Parameters:

madd - DOCUMENT ME!

removeAreaLessThan

public int removeAreaLessThan(double min)

Removes all peaks with less than the specified area.

Parameters:

min - minimum area to retain the peak

Returns:

number of peaks remaining

removeAreaGreaterThan

public int removeAreaGreaterThan(double max)

Removes all peaks with greater than the specified area.

Parameters:

max - minimum area to retain the peak

Returns:

number of peaks remaining

getPeakNear

public Peak getPeakNear(double centroid,
                        double tolerance)

Returns peak nearest given centroid if distance is less than the given tolerance.

Parameters:

centroid - DOCUMENT ME!

tolerance - DOCUMENT ME!

Returns:

DOCUMENT ME!

lastPeaks

public Multiplet lastPeaks(int n)

Returns a new multiplet containing only the last n peaks of this multiplet.

Parameters:

n - DOCUMENT ME!

Returns:

DOCUMENT ME!

addPeak

public void addPeak(Peak p)

DOCUMENT ME!

Parameters:

p - DOCUMENT ME!

getPeak

public Peak getPeak(int index)

DOCUMENT ME!

Parameters:

index - DOCUMENT ME!

Returns:

DOCUMENT ME!