hep.aida.ref.histogram
Class Profile1D

java.lang.Object
  hep.aida.ref.event.AIDAObservable
      hep.aida.ref.ManagedObject
          hep.aida.ref.histogram.AbstractBaseHistogram
              hep.aida.ref.histogram.Profile
                  hep.aida.ref.histogram.Profile1D

All Implemented Interfaces:

Connectable, hep.aida.IBaseHistogram, hep.aida.dev.IDevManagedObject, hep.aida.IManagedObject, hep.aida.IProfile, hep.aida.IProfile1D, IsObservable

public class Profile1D

extends Profile

implements hep.aida.IProfile1D, IsObservable

Source Code:

Profile1D.java

Field Summary

Fields inherited from class hep.aida.ref.ManagedObject

fillable

Fields inherited from class hep.aida.ref.event.AIDAObservable

connectionDidChange, isConnected, isValid

Constructor Summary

	Profile1D() Create a 1-dimensional Profile.
protected	Profile1D(String name, String title, hep.aida.IAxis axis) Create a 1-dimensional Profile.
protected	Profile1D(String name, String title, hep.aida.IAxis axis, String options)

Method Summary

void	add(hep.aida.IProfile1D profile)
int	allEntries()
hep.aida.IAxis	axis()
int	binEntries(int index)
double	binError(int index)
double	binHeight(int index)
double	binMean(int index)
double	binRms(int index)
int	coordToIndex(double coord)
int	entries() Number of in-range entries in the histogram.
int	extraEntries()
void	fill(double x, double y)
void	fill(double x, double y, double weight)
protected Histogram2D	histogram() Get the internal histogram.
void	initProfile1D(hep.aida.IAxis axis)
void	initProfile1D(hep.aida.IAxis axis, String options)
double	maxBinHeight()
double	mean()
double	minBinHeight()
void	reset() Reset the histogram; as if just created.
double	rms()
void	scale(double scaleFactor)
void	setContents(double[] heights, double[] errors, int[] entries, double[] rmss, double[] meanXs) Set the content of the whole Histogram at once.
protected void	setHistogram(Histogram2D hist)
void	setMean(double mean)
void	setNEntries(int entries)
void	setRms(double rms)
void	setValidEntries(int entries)
double	sumAllBinHeights()
double	sumBinHeights()
double	sumExtraBinHeights()

Methods inherited from class hep.aida.ref.histogram.Profile

createEvent, nanEntries, options

Methods inherited from class hep.aida.ref.histogram.AbstractBaseHistogram

annotation, dimension, setAnnotation, setTitle, title

Methods inherited from class hep.aida.ref.ManagedObject

isFillable, name, setFillable, setName, type

Methods inherited from class hep.aida.ref.event.AIDAObservable

addListener, fireStateChanged, fireStateChanged, fireStateChanged, isConnected, removeAllListeners, removeListener, setConnected, setIsValidAfterNotify, setValid, setValidForAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface hep.aida.IBaseHistogram

annotation, dimension, nanEntries, setTitle, title

Methods inherited from interface hep.aida.ref.event.IsObservable

addListener, removeAllListeners, removeListener, setValid

Methods inherited from interface hep.aida.ref.event.Connectable

isConnected, setConnected

Constructor Detail

Profile1D

public Profile1D()

Create a 1-dimensional Profile.

Profile1D

protected Profile1D(String name,
                    String title,
                    hep.aida.IAxis axis)

Create a 1-dimensional Profile.

Parameters:

name - The name of the Profile as a ManagedObject.

title - The title of the Profile.

axis - The x-axis of the Profile.

Profile1D

protected Profile1D(String name,
                    String title,
                    hep.aida.IAxis axis,
                    String options)

Method Detail

reset

public void reset()

Description copied from class: AbstractBaseHistogram

Reset the histogram; as if just created.

Specified by:

reset in interface hep.aida.IBaseHistogram

Overrides:

reset in class AbstractBaseHistogram

entries

public int entries()

Description copied from class: AbstractBaseHistogram

Number of in-range entries in the histogram.

Specified by:

entries in interface hep.aida.IBaseHistogram

Specified by:

entries in class AbstractBaseHistogram

Returns:

The number of in-range entries.

allEntries

public int allEntries()

Specified by:

allEntries in interface hep.aida.IProfile

extraEntries

public int extraEntries()

Specified by:

extraEntries in interface hep.aida.IProfile

sumAllBinHeights

public double sumAllBinHeights()

Specified by:

sumAllBinHeights in interface hep.aida.IProfile

sumBinHeights

public double sumBinHeights()

Specified by:

sumBinHeights in interface hep.aida.IProfile

sumExtraBinHeights

public double sumExtraBinHeights()

Specified by:

sumExtraBinHeights in interface hep.aida.IProfile

minBinHeight

public double minBinHeight()

Specified by:

minBinHeight in interface hep.aida.IProfile

maxBinHeight

public double maxBinHeight()

Specified by:

maxBinHeight in interface hep.aida.IProfile

fill

public void fill(double x,
                 double y,
                 double weight)

Specified by:

fill in interface hep.aida.IProfile1D

fill

public void fill(double x,
                 double y)

Specified by:

fill in interface hep.aida.IProfile1D

binEntries

public int binEntries(int index)

Specified by:

binEntries in interface hep.aida.IProfile1D

binHeight

public double binHeight(int index)

Specified by:

binHeight in interface hep.aida.IProfile1D

binError

public double binError(int index)

Specified by:

binError in interface hep.aida.IProfile1D

binMean

public double binMean(int index)

Specified by:

binMean in interface hep.aida.IProfile1D

binRms

public double binRms(int index)

Specified by:

binRms in interface hep.aida.IProfile1D

mean

public double mean()

Specified by:

mean in interface hep.aida.IProfile1D

rms

public double rms()

Specified by:

rms in interface hep.aida.IProfile1D

axis

public hep.aida.IAxis axis()

Specified by:

axis in interface hep.aida.IProfile1D

coordToIndex

public int coordToIndex(double coord)

Specified by:

coordToIndex in interface hep.aida.IProfile1D

scale

public void scale(double scaleFactor)
           throws IllegalArgumentException

Throws:

IllegalArgumentException

add

public void add(hep.aida.IProfile1D profile)
         throws IllegalArgumentException

Specified by:

add in interface hep.aida.IProfile1D

Throws:

IllegalArgumentException

histogram

protected Histogram2D histogram()

Get the internal histogram.

setHistogram

protected void setHistogram(Histogram2D hist)

initProfile1D

public void initProfile1D(hep.aida.IAxis axis)

initProfile1D

public void initProfile1D(hep.aida.IAxis axis,
                          String options)

setRms

public void setRms(double rms)

setMean

public void setMean(double mean)

setContents

public void setContents(double[] heights,
                        double[] errors,
                        int[] entries,
                        double[] rmss,
                        double[] meanXs)

Set the content of the whole Histogram at once. This is a convenience method for saving/restoring Histograms. Of the arguments below the heights, the errors and the entries array cannot be null. If the means array is null, the mean is defaulted to the geometric center of the bin. If the rms array is null, the rms is taken to be the bin width over the root of 12.

Parameters:

heights - The bins heights

errors - The bins errors

entries - The bin entries.

rmss - The rmss of the bins

meanXs - The mean of the bin.

setNEntries

public void setNEntries(int entries)

setValidEntries

public void setValidEntries(int entries)