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

java.lang.Object
  extended by org.jscience.physics.nuclear.kinematics.math.analysis.Peak
All Implemented Interfaces:
java.lang.Comparable

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

This class represents a gaussian peak, in terms of it's properties. Fields are also provided for the error bars on these properties.


Constructor Summary
Peak(double position, double area, double width)
          Creates new Peak assuming no uncertainty in values.
Peak(double p, double pe, double a, double ae, double w, double we)
          Generates a peak with error bars on its parameters.
 
Method Summary
 int compareTo(java.lang.Object p1)
          DOCUMENT ME!
 double getArea()
          DOCUMENT ME!
 double getAreaError()
          DOCUMENT ME!
 double getPosition()
          DOCUMENT ME!
 double getPositionError()
          DOCUMENT ME!
 double getWidth()
          DOCUMENT ME!
 double getWidthError()
          DOCUMENT ME!
 void setArea(double a)
          DOCUMENT ME!
 void setArea(double a, double e)
          DOCUMENT ME!
 void setPosition(double p)
          DOCUMENT ME!
 void setPosition(double p, double e)
          DOCUMENT ME!
 void setWidth(double w)
          DOCUMENT ME!
 void setWidth(double w, double e)
          DOCUMENT ME!
 java.lang.String toString()
          DOCUMENT ME!
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Peak

public Peak(double position,
            double area,
            double width)
Creates new Peak assuming no uncertainty in values.

Parameters:
position - position of the peak centroid
area - total peak area
width - Full width at half max of the peak

Peak

public Peak(double p,
            double pe,
            double a,
            double ae,
            double w,
            double we)
Generates a peak with error bars on its parameters.

Parameters:
p - position of peak centroid
pe - error on position
a - area of peak
ae - uncertainty in area
w - FWHM of peak
we - uncertainty in FWHM
Method Detail

getPosition

public double getPosition()
DOCUMENT ME!

Returns:

getArea

public double getArea()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getWidth

public double getWidth()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getPositionError

public double getPositionError()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getAreaError

public double getAreaError()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getWidthError

public double getWidthError()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setPosition

public void setPosition(double p)
DOCUMENT ME!

Parameters:
p - DOCUMENT ME!

setPosition

public void setPosition(double p,
                        double e)
DOCUMENT ME!

Parameters:
p - DOCUMENT ME!
e - DOCUMENT ME!

setArea

public void setArea(double a)
DOCUMENT ME!

Parameters:
a - DOCUMENT ME!

setArea

public void setArea(double a,
                    double e)
DOCUMENT ME!

Parameters:
a - DOCUMENT ME!
e - DOCUMENT ME!

setWidth

public void setWidth(double w)
DOCUMENT ME!

Parameters:
w - DOCUMENT ME!

setWidth

public void setWidth(double w,
                     double e)
DOCUMENT ME!

Parameters:
w - DOCUMENT ME!
e - DOCUMENT ME!

toString

public java.lang.String toString()
DOCUMENT ME!

Overrides:
toString in class java.lang.Object
Returns:
DOCUMENT ME!

compareTo

public int compareTo(java.lang.Object p1)
DOCUMENT ME!

Specified by:
compareTo in interface java.lang.Comparable
Parameters:
p1 - DOCUMENT ME!
Returns:
DOCUMENT ME!