hep.aida.ref.histogram
Class Profile2D

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.Profile2D

All Implemented Interfaces:

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

public class Profile2D

extends Profile

implements hep.aida.IProfile2D, IsObservable

Source Code:

Profile2D.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

	Profile2D() Create a 1-dimensional Profile.
protected	Profile2D(String name, String title, hep.aida.IAxis xAxis, hep.aida.IAxis yAxis) Create a 1-dimensional Profile.
protected	Profile2D(String name, String title, hep.aida.IAxis xAxis, hep.aida.IAxis yAxis, String options)

Method Summary

void	add(hep.aida.IProfile2D profile)
int	allEntries()
int	binEntries(int indexX, int indexY)
int	binEntriesX(int indexX)
int	binEntriesY(int indexY)
double	binError(int indexX, int indexY)
double	binHeight(int indexX, int indexY)
double	binHeightX(int indexX)
double	binHeightY(int indexY)
double	binMeanX(int indexX, int indexY)
double	binMeanY(int indexX, int indexY)
double	binRms(int indexX, int indexY)
int	coordToIndexX(double coord)
int	coordToIndexY(double coord)
int	entries() Number of in-range entries in the histogram.
int	extraEntries()
void	fill(double x, double y, double z)
void	fill(double x, double y, double z, double weight)
protected Histogram3D	histogram() Get the internal histogram.
void	initProfile2D(hep.aida.IAxis xAxis, hep.aida.IAxis yAxis)
void	initProfile2D(hep.aida.IAxis xAxis, hep.aida.IAxis yAxis, String options)
double	maxBinHeight()
double	meanX()
double	meanY()
double	minBinHeight()
void	reset() Reset the histogram; as if just created.
double	rmsX()
double	rmsY()
void	scale(double scaleFactor)
void	setContents(double[][] heights, double[][] errors, int[][] entries, double[][] rmss, double[][] meanXs, double[][] meanYs)
protected void	setHistogram(Histogram3D hist)
void	setMeanX(double meanX)
void	setMeanY(double meanY)
void	setRmsX(double rmsX)
void	setRmsY(double rmsY)
double	sumAllBinHeights()
double	sumBinHeights()
double	sumExtraBinHeights()
hep.aida.IAxis	xAxis()
hep.aida.IAxis	yAxis()

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

Profile2D

public Profile2D()

Create a 1-dimensional Profile.

Profile2D

protected Profile2D(String name,
                    String title,
                    hep.aida.IAxis xAxis,
                    hep.aida.IAxis yAxis)

Create a 1-dimensional Profile.

Parameters:

name - The name of the Profile as a ManagedObject.

title - The title of the Profile.

xAxis - The x-axis of the Profile.

yAxis - The y-axis of the Profile.

Profile2D

protected Profile2D(String name,
                    String title,
                    hep.aida.IAxis xAxis,
                    hep.aida.IAxis yAxis,
                    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

binMeanX

public double binMeanX(int indexX,
                       int indexY)

Specified by:

binMeanX in interface hep.aida.IProfile2D

binMeanY

public double binMeanY(int indexX,
                       int indexY)

Specified by:

binMeanY in interface hep.aida.IProfile2D

binEntries

public int binEntries(int indexX,
                      int indexY)

Specified by:

binEntries in interface hep.aida.IProfile2D

binEntriesX

public int binEntriesX(int indexX)

Specified by:

binEntriesX in interface hep.aida.IProfile2D

binEntriesY

public int binEntriesY(int indexY)

Specified by:

binEntriesY in interface hep.aida.IProfile2D

binError

public double binError(int indexX,
                       int indexY)

Specified by:

binError in interface hep.aida.IProfile2D

binHeight

public double binHeight(int indexX,
                        int indexY)

Specified by:

binHeight in interface hep.aida.IProfile2D

binHeightX

public double binHeightX(int indexX)

Specified by:

binHeightX in interface hep.aida.IProfile2D

binHeightY

public double binHeightY(int indexY)

Specified by:

binHeightY in interface hep.aida.IProfile2D

binRms

public double binRms(int indexX,
                     int indexY)

Specified by:

binRms in interface hep.aida.IProfile2D

coordToIndexX

public int coordToIndexX(double coord)

Specified by:

coordToIndexX in interface hep.aida.IProfile2D

coordToIndexY

public int coordToIndexY(double coord)

Specified by:

coordToIndexY in interface hep.aida.IProfile2D

fill

public void fill(double x,
                 double y,
                 double z)
          throws IllegalArgumentException

Specified by:

fill in interface hep.aida.IProfile2D

Throws:

IllegalArgumentException

fill

public void fill(double x,
                 double y,
                 double z,
                 double weight)
          throws IllegalArgumentException

Specified by:

fill in interface hep.aida.IProfile2D

Throws:

IllegalArgumentException

meanX

public double meanX()

Specified by:

meanX in interface hep.aida.IProfile2D

meanY

public double meanY()

Specified by:

meanY in interface hep.aida.IProfile2D

rmsX

public double rmsX()

Specified by:

rmsX in interface hep.aida.IProfile2D

rmsY

public double rmsY()

Specified by:

rmsY in interface hep.aida.IProfile2D

xAxis

public hep.aida.IAxis xAxis()

Specified by:

xAxis in interface hep.aida.IProfile2D

yAxis

public hep.aida.IAxis yAxis()

Specified by:

yAxis in interface hep.aida.IProfile2D

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

maxBinHeight

public double maxBinHeight()

Specified by:

maxBinHeight in interface hep.aida.IProfile

minBinHeight

public double minBinHeight()

Specified by:

minBinHeight 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

scale

public void scale(double scaleFactor)
           throws IllegalArgumentException

Throws:

IllegalArgumentException

add

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

Specified by:

add in interface hep.aida.IProfile2D

Throws:

IllegalArgumentException

histogram

protected Histogram3D histogram()

Get the internal histogram.

setHistogram

protected void setHistogram(Histogram3D hist)

initProfile2D

public void initProfile2D(hep.aida.IAxis xAxis,
                          hep.aida.IAxis yAxis)

initProfile2D

public void initProfile2D(hep.aida.IAxis xAxis,
                          hep.aida.IAxis yAxis,
                          String options)

setRmsX

public void setRmsX(double rmsX)

setRmsY

public void setRmsY(double rmsY)

setMeanX

public void setMeanX(double meanX)

setMeanY

public void setMeanY(double meanY)

setContents

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