FreeHEP API
Version current

hep.aida.ref.remote
Class RemoteHistogram2D

java.lang.Object
  extended byhep.aida.ref.event.AIDAObservable
      extended byhep.aida.ref.ManagedObject
          extended byhep.aida.ref.remote.RemoteManagedObject
              extended byhep.aida.ref.remote.RemoteHistogram2D
All Implemented Interfaces:
Connectable, hep.aida.IBaseHistogram, hep.aida.dev.IDevManagedObject, hep.aida.IHistogram, hep.aida.IHistogram2D, hep.aida.IManagedObject, IsObservable

public class RemoteHistogram2D
extends RemoteManagedObject
implements hep.aida.IHistogram2D

This is implementation of IHistogram2D that can not be modified by the user. This is a simple implementation that does not guarantee internal consistency. So extra care should be taken when setting data for this class. This Class is designed to work with the IDevMutableStore, but can work with other Stores - overwrite makeSureDataIsValid() method. Note: use "putTitle" method, AIDA's "setTitle" is disabled. Don't forget to call "setDataValid" after you fill new data, as only this method fires events to notify AIDAListeners about change. Also please note that in our current AIDA implementation: UNDERFLOW_BIN = -2, OVERFLOW_BIN = -1, bins = [0, nBins-1] But we keep them here as: UNDERFLOW_BIN = 0, OVERFLOW_BIN = nBins+1, bins = [1, nBins]

Author:
serbo
Source Code:
RemoteHistogram2D.java

Field Summary
 
Fields inherited from class hep.aida.ref.remote.RemoteManagedObject
aidaType, dataIsValid, DEFAULT_DOUBLE, DEFAULT_FLOAT, DEFAULT_INT, DEFAULT_LONG, remoteLogger, stateDidChange, store, treePath
 
Fields inherited from class hep.aida.ref.ManagedObject
fillable
 
Fields inherited from class hep.aida.ref.event.AIDAObservable
connectionDidChange, isConnected, isValid
 
Constructor Summary
RemoteHistogram2D(IDevMutableStore store, String name)
           
RemoteHistogram2D(IDevMutableStore store, String name, String title)
           
RemoteHistogram2D(String name)
          Creates a new instance of RemoteHistogram1D
 
Method Summary
 void add(hep.aida.IHistogram2D iHistogram2D)
           
 int allEntries()
           
 hep.aida.IAnnotation annotation()
           
 int binEntries(int param1, int param2)
           
 int binEntriesX(int param)
           
 int binEntriesY(int param)
           
 double binError(int param1, int param2)
           
 double binHeight(int param1, int param2)
           
 double binHeightX(int param)
           
 double binHeightY(int param)
           
 double binMeanX(int param1, int param2)
           
 double binMeanY(int param1, int param2)
           
 double binRmsX(int param1, int param2)
           
 double binRmsY(int param1, int param2)
           
 int coordToIndexX(double param)
           
 int coordToIndexY(double param)
           
protected  EventObject createEvent()
           
 int dimension()
           
 int entries()
           
 double equivalentBinEntries()
           
 int extraEntries()
           
 void fill(double param, double param1)
           
 void fill(double param, double param1, double param2)
           
 double maxBinHeight()
           
 double meanX()
           
 double meanY()
           
 double minBinHeight()
           
 int nanEntries()
           
 void reset()
           
 double rmsX()
           
 double rmsY()
           
 void scale(double param)
           
 void setAnnotation(Annotation a)
           
 void setBinEntriesX(int[] h)
           
 void setBinEntriesY(int[] h)
           
 void setBinHeightsX(double[] h)
           
 void setBinHeightsY(double[] h)
           
 void setBinMeansX(double[][] h)
           
 void setBinMeansY(double[][] h)
           
 void setBinRmssX(double[][] h)
           
 void setBinRmssY(double[][] h)
           
 void setEntries(int[][] h)
           
 void setEquivalentBinEntries(double d)
           
 void setErrors(double[][] h)
           
 void setExtraBinHeights(double d)
           
 void setExtraEntries(int d)
           
 void setHeights(double[][] h)
           
 void setInRangeBinHeights(double d)
           
 void setInRangeEntries(int d)
           
 void setMaxBinHeights(double d)
           
 void setMeanX(double mean)
           
 void setMeanY(double mean)
           
 void setMinBinHeights(double d)
           
 void setNanEntries(int i)
           
 void setRmsX(double rms)
           
 void setRmsY(double rms)
           
 void setTitle(String title)
           
 void setXAxis(int bins, double min, double max)
           
 void setYAxis(int bins, double min, double max)
           
 double sumAllBinHeights()
           
 double sumBinHeights()
           
 double sumExtraBinHeights()
           
 String title()
           
 hep.aida.IAxis xAxis()
           
 hep.aida.IAxis yAxis()
           
 
Methods inherited from class hep.aida.ref.remote.RemoteManagedObject
getStore, getTreePath, isDataValid, makeSureDataIsValid, setConnected, setDataValid, setStore, setTreeFolder, setValid, setValidForAll, type
 
Methods inherited from class hep.aida.ref.ManagedObject
isFillable, name, setFillable, setName
 
Methods inherited from class hep.aida.ref.event.AIDAObservable
addListener, fireStateChanged, fireStateChanged, fireStateChanged, isConnected, removeAllListeners, removeListener, setIsValidAfterNotify
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface hep.aida.ref.event.IsObservable
addListener, removeAllListeners, removeListener
 
Methods inherited from interface hep.aida.ref.event.Connectable
isConnected
 

Constructor Detail

RemoteHistogram2D

public RemoteHistogram2D(String name)
Creates a new instance of RemoteHistogram1D


RemoteHistogram2D

public RemoteHistogram2D(IDevMutableStore store,
                         String name)

RemoteHistogram2D

public RemoteHistogram2D(IDevMutableStore store,
                         String name,
                         String title)
Method Detail

createEvent

protected EventObject createEvent()
Overrides:
createEvent in class AIDAObservable

setAnnotation

public void setAnnotation(Annotation a)

setXAxis

public void setXAxis(int bins,
                     double min,
                     double max)

setYAxis

public void setYAxis(int bins,
                     double min,
                     double max)

setRmsX

public void setRmsX(double rms)

setRmsY

public void setRmsY(double rms)

setMeanX

public void setMeanX(double mean)

setMeanY

public void setMeanY(double mean)

setHeights

public void setHeights(double[][] h)

setEntries

public void setEntries(int[][] h)

setErrors

public void setErrors(double[][] h)

setBinMeansX

public void setBinMeansX(double[][] h)

setBinRmssX

public void setBinRmssX(double[][] h)

setBinMeansY

public void setBinMeansY(double[][] h)

setBinRmssY

public void setBinRmssY(double[][] h)

setBinEntriesX

public void setBinEntriesX(int[] h)

setBinEntriesY

public void setBinEntriesY(int[] h)

setBinHeightsX

public void setBinHeightsX(double[] h)

setBinHeightsY

public void setBinHeightsY(double[] h)

setInRangeEntries

public void setInRangeEntries(int d)

setExtraEntries

public void setExtraEntries(int d)

setNanEntries

public void setNanEntries(int i)

setEquivalentBinEntries

public void setEquivalentBinEntries(double d)

setInRangeBinHeights

public void setInRangeBinHeights(double d)

setExtraBinHeights

public void setExtraBinHeights(double d)

setMinBinHeights

public void setMinBinHeights(double d)

setMaxBinHeights

public void setMaxBinHeights(double d)

annotation

public hep.aida.IAnnotation annotation()
Specified by:
annotation in interface hep.aida.IBaseHistogram

dimension

public int dimension()
Specified by:
dimension in interface hep.aida.IBaseHistogram

entries

public int entries()
Specified by:
entries in interface hep.aida.IBaseHistogram

reset

public void reset()
           throws RuntimeException
Specified by:
reset in interface hep.aida.IBaseHistogram
Throws:
RuntimeException

title

public String title()
Specified by:
title in interface hep.aida.IBaseHistogram

setTitle

public void setTitle(String title)
              throws IllegalArgumentException
Specified by:
setTitle in interface hep.aida.IBaseHistogram
Throws:
IllegalArgumentException

allEntries

public int allEntries()
Specified by:
allEntries in interface hep.aida.IHistogram

equivalentBinEntries

public double equivalentBinEntries()
Specified by:
equivalentBinEntries in interface hep.aida.IHistogram

extraEntries

public int extraEntries()
Specified by:
extraEntries in interface hep.aida.IHistogram

nanEntries

public int nanEntries()
Specified by:
nanEntries in interface hep.aida.IBaseHistogram

maxBinHeight

public double maxBinHeight()
Specified by:
maxBinHeight in interface hep.aida.IHistogram

minBinHeight

public double minBinHeight()
Specified by:
minBinHeight in interface hep.aida.IHistogram

scale

public void scale(double param)
           throws IllegalArgumentException
Specified by:
scale in interface hep.aida.IHistogram
Throws:
IllegalArgumentException

sumAllBinHeights

public double sumAllBinHeights()
Specified by:
sumAllBinHeights in interface hep.aida.IHistogram

sumBinHeights

public double sumBinHeights()
Specified by:
sumBinHeights in interface hep.aida.IHistogram

sumExtraBinHeights

public double sumExtraBinHeights()
Specified by:
sumExtraBinHeights in interface hep.aida.IHistogram

add

public void add(hep.aida.IHistogram2D iHistogram2D)
         throws IllegalArgumentException
Specified by:
add in interface hep.aida.IHistogram2D
Throws:
IllegalArgumentException

binEntries

public int binEntries(int param1,
                      int param2)
               throws IllegalArgumentException
Specified by:
binEntries in interface hep.aida.IHistogram2D
Throws:
IllegalArgumentException

binEntriesX

public int binEntriesX(int param)
                throws IllegalArgumentException
Specified by:
binEntriesX in interface hep.aida.IHistogram2D
Throws:
IllegalArgumentException

binEntriesY

public int binEntriesY(int param)
                throws IllegalArgumentException
Specified by:
binEntriesY in interface hep.aida.IHistogram2D
Throws:
IllegalArgumentException

binError

public double binError(int param1,
                       int param2)
                throws IllegalArgumentException
Specified by:
binError in interface hep.aida.IHistogram2D
Throws:
IllegalArgumentException

binHeight

public double binHeight(int param1,
                        int param2)
                 throws IllegalArgumentException
Specified by:
binHeight in interface hep.aida.IHistogram2D
Throws:
IllegalArgumentException

binHeightX

public double binHeightX(int param)
                  throws IllegalArgumentException
Specified by:
binHeightX in interface hep.aida.IHistogram2D
Throws:
IllegalArgumentException

binHeightY

public double binHeightY(int param)
                  throws IllegalArgumentException
Specified by:
binHeightY in interface hep.aida.IHistogram2D
Throws:
IllegalArgumentException

binMeanX

public double binMeanX(int param1,
                       int param2)
                throws IllegalArgumentException
Specified by:
binMeanX in interface hep.aida.IHistogram2D
Throws:
IllegalArgumentException

binMeanY

public double binMeanY(int param1,
                       int param2)
                throws IllegalArgumentException
Specified by:
binMeanY in interface hep.aida.IHistogram2D
Throws:
IllegalArgumentException

binRmsX

public double binRmsX(int param1,
                      int param2)
               throws IllegalArgumentException
Throws:
IllegalArgumentException

binRmsY

public double binRmsY(int param1,
                      int param2)
               throws IllegalArgumentException
Throws:
IllegalArgumentException

coordToIndexX

public int coordToIndexX(double param)
Specified by:
coordToIndexX in interface hep.aida.IHistogram2D

coordToIndexY

public int coordToIndexY(double param)
Specified by:
coordToIndexY in interface hep.aida.IHistogram2D

fill

public void fill(double param,
                 double param1)
          throws IllegalArgumentException
Specified by:
fill in interface hep.aida.IHistogram2D
Throws:
IllegalArgumentException

fill

public void fill(double param,
                 double param1,
                 double param2)
          throws IllegalArgumentException
Specified by:
fill in interface hep.aida.IHistogram2D
Throws:
IllegalArgumentException

meanX

public double meanX()
Specified by:
meanX in interface hep.aida.IHistogram2D

meanY

public double meanY()
Specified by:
meanY in interface hep.aida.IHistogram2D

rmsX

public double rmsX()
Specified by:
rmsX in interface hep.aida.IHistogram2D

rmsY

public double rmsY()
Specified by:
rmsY in interface hep.aida.IHistogram2D

xAxis

public hep.aida.IAxis xAxis()
Specified by:
xAxis in interface hep.aida.IHistogram2D

yAxis

public hep.aida.IAxis yAxis()
Specified by:
yAxis in interface hep.aida.IHistogram2D

FreeHEP API
Version current

Copyright © 2000-2004 FreeHEP, All Rights Reserved.