Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

hep.aida.ref.histogram
Class HistogramFactory

java.lang.Object
  extended by hep.aida.ref.histogram.HistogramFactory
All Implemented Interfaces:
IHistogramFactory
public class HistogramFactory
extends Object
implements IHistogramFactory

Constructor Summary
HistogramFactory(ITree tree)
          Create a new HistogramFactory.
HistogramFactory(Tree tree)
          Create a new HistogramFactory.
 
Method Summary
 IHistogram1D add(String path, IHistogram1D a, IHistogram1D b)
          Adds two 1D Histogram
 IHistogram2D add(String path, IHistogram2D a, IHistogram2D b)
          Adds two 2D Histogram
 IHistogram3D add(String path, IHistogram3D a, IHistogram3D b)
          Adds two 3D Histogram
 ICloud1D createCloud1D(String pathAndTitle)
          Create a ICloud1D, an unbinned 1-dimensional histogram.
 ICloud1D createCloud1D(String path, String title)
          Create a ICloud1D, an unbinned 1-dimensional histogram.
 ICloud1D createCloud1D(String path, String title, int nMax)
          Create a ICloud1D, an unbinned 1-dimensional histogram.
 ICloud1D createCloud1D(String path, String title, int nMax, String options)
          Create a Cloud1D, and unbinned 1-dimensional Histogram.
 ICloud2D createCloud2D(String pathAndTitle)
          Create a ICloud2D, an unbinned 2-dimensional histogram.
 ICloud2D createCloud2D(String path, String title)
          Create a ICloud2D, an unbinned 2-dimensional histogram.
 ICloud2D createCloud2D(String path, String title, int nMax)
          Create a ICloud2D, an unbinned 2-dimensional histogram.
 ICloud2D createCloud2D(String path, String title, int nMax, String options)
          Create a Cloud2D, and unbinned 2-dimensional Histogram.
 ICloud3D createCloud3D(String pathAndTitle)
          Create a ICloud3D, an unbinned 3-dimensional histogram.
 ICloud3D createCloud3D(String path, String title)
          Create a ICloud3D, an unbinned 3-dimensional histogram.
 ICloud3D createCloud3D(String path, String title, int nMax)
          Create a ICloud3D, an unbinned 3-dimensional histogram.
 ICloud3D createCloud3D(String path, String title, int nMax, String options)
          Create a Cloud3D, and unbinned 3-dimensional Histogram.
 ICloud1D createCopy(String path, ICloud1D cloud)
          Create a copy of an ICloud1D.
 ICloud2D createCopy(String path, ICloud2D cloud)
          Create a copy of an ICloud2D.
 ICloud3D createCopy(String path, ICloud3D cloud)
          Create a copy of an ICloud3D.
 IHistogram1D createCopy(String path, IHistogram1D hist)
          Create a copy of an IHistogram1D.
 IHistogram2D createCopy(String path, IHistogram2D hist)
          Create a copy of an IHistogram2D.
 IHistogram3D createCopy(String path, IHistogram3D hist)
          Create a copy of an IHistogram3D.
 IProfile1D createCopy(String path, IProfile1D profile)
          Create a copy of an IProfile1D.
 IProfile2D createCopy(String path, IProfile2D profile)
          Create a copy of an IProfile2D.
 IHistogram1D createHistogram1D(String pathAndTitle, int nBins, double lowerEdge, double upperEdge)
          Create a IHistogram1D.
 IHistogram1D createHistogram1D(String path, String title, double[] binEdges)
          Create a IHistogram1D.
 IHistogram1D createHistogram1D(String path, String title, double[] binEdges, String options)
          Create a IHistogram1D.
 IHistogram1D createHistogram1D(String path, String title, int nBins, double lowerEdge, double upperEdge)
          Create a IHistogram1D.
 IHistogram1D createHistogram1D(String path, String title, int nBins, double lowerEdge, double upperEdge, String options)
          Create a IHistogram1D.
 IHistogram2D createHistogram2D(String pathAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY)
          Create a IHistogram2D.
 IHistogram2D createHistogram2D(String path, String title, double[] binEdgesX, double[] binEdgesY)
          Create a IHistogram2D.
 IHistogram2D createHistogram2D(String path, String title, double[] binEdgesX, double[] binEdgesY, String options)
          Create a IHistogram2D.
 IHistogram2D createHistogram2D(String path, String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY)
          Create a IHistogram2D.
 IHistogram2D createHistogram2D(String path, String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, String options)
          Create a IHistogram2D.
 IHistogram3D createHistogram3D(String pathAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ)
          Create a IHistogram3D.
 IHistogram3D createHistogram3D(String path, String title, double[] binEdgesX, double[] binEdgesY, double[] binEdgesZ)
          Create a IHistogram3D.
 IHistogram3D createHistogram3D(String path, String title, double[] binEdgesX, double[] binEdgesY, double[] binEdgesZ, String options)
          Create a IHistogram3D.
 IHistogram3D createHistogram3D(String path, String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ)
          Create a IHistogram3D.
 IHistogram3D createHistogram3D(String path, String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ, String options)
          Create a IHistogram3D.
 IProfile1D createProfile1D(String pathAndTitle, int nBins, double lowerEdge, double upperEdge)
          Create a IProfile1D.
 IProfile1D createProfile1D(String pathAndTitle, int nBins, double lowerEdge, double upperEdge, double lowerValue, double upperValue)
          Create a IProfile1D.
 IProfile1D createProfile1D(String path, String title, double[] binEdges)
          Create a IProfile1D.
 IProfile1D createProfile1D(String path, String title, double[] binEdges, double lowerValue, double upperValue)
          Create a IProfile1D.
 IProfile1D createProfile1D(String path, String title, double[] binEdges, double lowerValue, double upperValue, String options)
          Create a IProfile1D.
 IProfile1D createProfile1D(String path, String title, double[] binEdges, String options)
          Create a IProfile1D.
 IProfile1D createProfile1D(String path, String title, int nBins, double lowerEdge, double upperEdge)
          Create a IProfile1D.
 IProfile1D createProfile1D(String path, String title, int nBins, double lowerEdge, double upperEdge, double lowerValue, double upperValue)
          Create a IProfile1D.
 IProfile1D createProfile1D(String path, String title, int nBins, double lowerEdge, double upperEdge, double lowerValue, double upperValue, String options)
          Create a IProfile1D.
 IProfile1D createProfile1D(String path, String title, int nBins, double lowerEdge, double upperEdge, String options)
          Create a IProfile1D.
 IProfile2D createProfile2D(String pathAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY)
          Create a IProfile2D.
 IProfile2D createProfile2D(String pathAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, double lowerValue, double upperValue)
          Create a IProfile2D.
 IProfile2D createProfile2D(String path, String title, double[] binEdgesX, double[] binEdgesY)
          Create a IProfile2D.
 IProfile2D createProfile2D(String path, String title, double[] binEdgesX, double[] binEdgesY, double lowerValue, double upperValue)
          Create a IProfile2D.
 IProfile2D createProfile2D(String path, String title, double[] binEdgesX, double[] binEdgesY, double lowerValue, double upperValue, String options)
          Create a IProfile2D.
 IProfile2D createProfile2D(String path, String title, double[] binEdgesX, double[] binEdgesY, String options)
          Create a IProfile2D.
 IProfile2D createProfile2D(String path, String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY)
          Create a IProfile2D.
 IProfile2D createProfile2D(String path, String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, double lowerValue, double upperValue)
          Create a IProfile2D.
 IProfile2D createProfile2D(String path, String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, double lowerValue, double upperValue, String options)
          Create a IProfile2D.
 IProfile2D createProfile2D(String path, String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, String options)
          Create a IProfile2D.
 void destroy(IBaseHistogram hist)
          Destroy an IBaseHistogram ogject.
 IHistogram1D divide(String path, IHistogram1D a, IHistogram1D b)
          Divides two 1D Histogram
 IHistogram2D divide(String path, IHistogram2D a, IHistogram2D b)
          Divides two 2D Histogram
 IHistogram3D divide(String path, IHistogram3D a, IHistogram3D b)
          Divides two 3D Histogram
 IHistogram1D multiply(String path, IHistogram1D a, IHistogram1D b)
          Multiplies two 1D Histogram
 IHistogram2D multiply(String path, IHistogram2D a, IHistogram2D b)
          Multiplies two 2D Histogram
 IHistogram3D multiply(String path, IHistogram3D a, IHistogram3D b)
          Multiplies two 3D Histogram
 IHistogram1D projectionX(String path, IHistogram2D h)
          Create a projection from a 2D histogram parallel to the X axis.
 IHistogram2D projectionXY(String path, IHistogram3D h)
          Create a projection parallel to the X axis from a 3D histogram.
 IHistogram2D projectionXZ(String path, IHistogram3D h)
          Create a projection parallel to the Z axis from a 3D histogram.
 IHistogram1D projectionY(String path, IHistogram2D h)
          Create a projection from a 2D histogram parallel to the Y axis.
 IHistogram2D projectionYZ(String path, IHistogram3D h)
          Create a projection parallel to the Y axis from a 3D histogram.
 IHistogram1D sliceX(String path, IHistogram2D h, int indexY)
          Slice parallel to the Y axis from a 2D histogram at bin indexY and one bin wide.
 IHistogram1D sliceX(String path, IHistogram2D h, int indexY1, int indexY2)
          Create a slice parallel to the X axis from a 2D histogram, between "indexY1" and "indexY2" (inclusive).
 IHistogram2D sliceXY(String path, IHistogram3D h, int indexZ1, int indexZ2)
          Create a slice perpendicular to the Z axis from a 3D histogram, between "indexZ1" and "indexZ2" (inclusive).
 IHistogram2D sliceXZ(String path, IHistogram3D h, int indexY1, int indexY2)
          Create a slice perpendicular to the Y axis from a 3D histogram, between "indexY1" and "indexY2" (inclusive).
 IHistogram1D sliceY(String path, IHistogram2D h, int indexX)
          Slice parallel to the X axis from a 2D histogram at bin indexX and one bin wide.
 IHistogram1D sliceY(String path, IHistogram2D h, int indexX1, int indexX2)
          Create a slice parallel to the Y axis from a 2D histogram, between "indexX1" and "indexX2" (inclusive).
 IHistogram2D sliceYZ(String path, IHistogram3D h, int indexX1, int indexX2)
          Create a slice perpendicular to the X axis from a 3D histogram, between "indexX1" and "indexX2" (inclusive).
 IHistogram1D subtract(String path, IHistogram1D a, IHistogram1D b)
          Subtracts two 1D Histogram
 IHistogram2D subtract(String path, IHistogram2D a, IHistogram2D b)
          Subtracts two 2D Histogram
 IHistogram3D subtract(String path, IHistogram3D a, IHistogram3D b)
          Subtracts two 3D Histogram
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HistogramFactory

public HistogramFactory(ITree tree)
Create a new HistogramFactory. This constructor is used by AnalysisFactory, the Master Factory.

Parameters:
tree - the ITree where the histogram is added.

HistogramFactory

public HistogramFactory(Tree tree)
Create a new HistogramFactory. This constructor is used by AnalysisFactory, the Master Factory.

Parameters:
tree - the Tree where the histogram is added.
Method Detail

destroy

public void destroy(IBaseHistogram hist)
             throws IllegalArgumentException
Destroy an IBaseHistogram ogject.

Specified by:
destroy in interface IHistogramFactory
Parameters:
hist - The IBaseHistogram to be destroyed.
Throws:
IllegalArgumentException - If the histogram cannot be destroyed.

createCloud1D

public ICloud1D createCloud1D(String path,
                              String title,
                              int nMax,
                              String options)
Create a Cloud1D, and unbinned 1-dimensional Histogram.

Specified by:
createCloud1D in interface IHistogramFactory
Parameters:
path - The path of the Cloud1D.
title - The title of the Cloud1D.
nMax - The maximum number of entries after which the Cloud1D will convert to an Histogram1D. If nMax = -1 then the Cloud1D will not convert automatically to an Histogram1D.
options - The options for creating a Cloud1D.
Returns:
The newly created ICloud1D.

createCloud1D

public ICloud1D createCloud1D(String path,
                              String title,
                              int nMax)
Description copied from interface: IHistogramFactory
Create a ICloud1D, an unbinned 1-dimensional histogram.

Specified by:
createCloud1D in interface IHistogramFactory
Parameters:
path - The path of the created ICloud. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the ICloud1D.
nMax - The maximum number of entries after which the ICloud1D will convert to an IHistogram1D. The default nMax = -1 means no autoconversion. to an IHistogram1D. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created ICloud1D.

createCloud1D

public ICloud1D createCloud1D(String path,
                              String title)
Description copied from interface: IHistogramFactory
Create a ICloud1D, an unbinned 1-dimensional histogram.

Specified by:
createCloud1D in interface IHistogramFactory
Parameters:
path - The path of the created ICloud. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the ICloud1D. will convert to an IHistogram1D. The default nMax = -1 means no autoconversion. to an IHistogram1D. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created ICloud1D.

createCloud1D

public ICloud1D createCloud1D(String pathAndTitle)
Description copied from interface: IHistogramFactory
Create a ICloud1D, an unbinned 1-dimensional histogram.

Specified by:
createCloud1D in interface IHistogramFactory
Parameters:
pathAndTitle - The path of the created ICloud. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
Returns:
The newly created ICloud1D.

createCopy

public ICloud1D createCopy(String path,
                           ICloud1D cloud)
Description copied from interface: IHistogramFactory
Create a copy of an ICloud1D.

Specified by:
createCopy in interface IHistogramFactory
Parameters:
path - The path of the resulting ICloud. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
cloud - The ICloud1D to be copied.
Returns:
The copy of the ICloud1D.

createCloud2D

public ICloud2D createCloud2D(String path,
                              String title,
                              int nMax,
                              String options)
Create a Cloud2D, and unbinned 2-dimensional Histogram.

Specified by:
createCloud2D in interface IHistogramFactory
Parameters:
path - The path of the Cloud2D.
title - The title of the Cloud2D.
nMax - The maximum number of entries after which the Cloud2D will convert to an Histogram2D. If nMax = -1 then the Cloud2D will not convert automatically to an Histogram2D.
options - The options for creating a Cloud2D.
Returns:
The newly created ICloud2D.

createCloud2D

public ICloud2D createCloud2D(String path,
                              String title,
                              int nMax)
Description copied from interface: IHistogramFactory
Create a ICloud2D, an unbinned 2-dimensional histogram.

Specified by:
createCloud2D in interface IHistogramFactory
Parameters:
path - The path of the created ICloud. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the ICloud2D.
nMax - The maximum number of entries after which the ICloud2D will convert to an IHistogram2D. The default nMax = -1 means no autoconversion. to an IHistogram2D. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created ICloud2D.

createCloud2D

public ICloud2D createCloud2D(String path,
                              String title)
Description copied from interface: IHistogramFactory
Create a ICloud2D, an unbinned 2-dimensional histogram.

Specified by:
createCloud2D in interface IHistogramFactory
Parameters:
path - The path of the created ICloud. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the ICloud2D. will convert to an IHistogram2D. The default nMax = -1 means no autoconversion. to an IHistogram2D. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created ICloud2D.

createCloud2D

public ICloud2D createCloud2D(String pathAndTitle)
Description copied from interface: IHistogramFactory
Create a ICloud2D, an unbinned 2-dimensional histogram.

Specified by:
createCloud2D in interface IHistogramFactory
Parameters:
pathAndTitle - The path of the created created ICloud. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
Returns:
The newly created ICloud2D.

createCopy

public ICloud2D createCopy(String path,
                           ICloud2D cloud)
Description copied from interface: IHistogramFactory
Create a copy of an ICloud2D.

Specified by:
createCopy in interface IHistogramFactory
Parameters:
path - The path of the resulting ICloud. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
cloud - The ICloud2D to be copied.
Returns:
The copy of the ICloud2D.

createCloud3D

public ICloud3D createCloud3D(String path,
                              String title,
                              int nMax,
                              String options)
Create a Cloud3D, and unbinned 3-dimensional Histogram.

Specified by:
createCloud3D in interface IHistogramFactory
Parameters:
path - The path of the Cloud3D.
title - The title of the Cloud3D.
nMax - The maximum number of entries after which the Cloud3D will convert to an Histogram3D. If nMax = -1 then the Cloud3D will not convert automatically to an Histogram3D.
options - The options for creating a Cloud3D.
Returns:
The newly created ICloud3D.

createCloud3D

public ICloud3D createCloud3D(String path,
                              String title,
                              int nMax)
Description copied from interface: IHistogramFactory
Create a ICloud3D, an unbinned 3-dimensional histogram.

Specified by:
createCloud3D in interface IHistogramFactory
Parameters:
path - The path of the created ICloud. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the ICloud3D.
nMax - The maximum number of entries after which the ICloud3D will convert to an IHistogram3D. The default nMax = -1 means no autoconversion to an IHistogram3D. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created ICloud3D.

createCloud3D

public ICloud3D createCloud3D(String path,
                              String title)
Description copied from interface: IHistogramFactory
Create a ICloud3D, an unbinned 3-dimensional histogram.

Specified by:
createCloud3D in interface IHistogramFactory
Parameters:
path - The path of the created ICloud. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the ICloud3D. will convert to an IHistogram3D. The default nMax = -1 means no autoconversion to an IHistogram3D. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created ICloud3D.

createCloud3D

public ICloud3D createCloud3D(String pathAndTitle)
Description copied from interface: IHistogramFactory
Create a ICloud3D, an unbinned 3-dimensional histogram.

Specified by:
createCloud3D in interface IHistogramFactory
Parameters:
pathAndTitle - The path of the created created ICloud. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
Returns:
The newly created ICloud3D.

createCopy

public ICloud3D createCopy(String path,
                           ICloud3D cloud)
Description copied from interface: IHistogramFactory
Create a copy of an ICloud3D.

Specified by:
createCopy in interface IHistogramFactory
Parameters:
path - The path of the resulting ICloud. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
cloud - The ICloud3D to be copied.
Returns:
The copy of the ICloud3D.

createHistogram1D

public IHistogram1D createHistogram1D(String path,
                                      String title,
                                      int nBins,
                                      double lowerEdge,
                                      double upperEdge,
                                      String options)
Description copied from interface: IHistogramFactory
Create a IHistogram1D.

Specified by:
createHistogram1D in interface IHistogramFactory
Parameters:
path - The path of the created IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IHistogram1D.
nBins - The number of bins of the x axis.
lowerEdge - The lower edge of the x axis.
upperEdge - The upper edge of the x axis.
options - The options for the IHistogram1D. The default is "". "type=efficiency" for an efficiency IHistogram1D. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IHistogram1D.

createHistogram1D

public IHistogram1D createHistogram1D(String path,
                                      String title,
                                      int nBins,
                                      double lowerEdge,
                                      double upperEdge)
Description copied from interface: IHistogramFactory
Create a IHistogram1D.

Specified by:
createHistogram1D in interface IHistogramFactory
Parameters:
path - The path of the created IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IHistogram1D.
nBins - The number of bins of the x axis.
lowerEdge - The lower edge of the x axis.
upperEdge - The upper edge of the x axis. "type=efficiency" for an efficiency IHistogram1D. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IHistogram1D.

createHistogram1D

public IHistogram1D createHistogram1D(String pathAndTitle,
                                      int nBins,
                                      double lowerEdge,
                                      double upperEdge)
Description copied from interface: IHistogramFactory
Create a IHistogram1D.

Specified by:
createHistogram1D in interface IHistogramFactory
Parameters:
pathAndTitle - The path of the created created IHistogram. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
nBins - The number of bins of the x axis.
lowerEdge - The lower edge of the x axis.
upperEdge - The upper edge of the x axis.
Returns:
The newly created IHistogram1D.

createHistogram1D

public IHistogram1D createHistogram1D(String path,
                                      String title,
                                      double[] binEdges,
                                      String options)
Description copied from interface: IHistogramFactory
Create a IHistogram1D.

Specified by:
createHistogram1D in interface IHistogramFactory
Parameters:
path - The path of the created IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IHistogram1D.
binEdges - The array of the bin edges for the x axis.
options - The options for the IHistogram1D. The default is "". "type=efficiency" for an efficiency IHistogram1D. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IHistogram1D.

createHistogram1D

public IHistogram1D createHistogram1D(String path,
                                      String title,
                                      double[] binEdges)
Description copied from interface: IHistogramFactory
Create a IHistogram1D.

Specified by:
createHistogram1D in interface IHistogramFactory
Parameters:
path - The path of the created IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IHistogram1D.
binEdges - The array of the bin edges for the x axis. "type=efficiency" for an efficiency IHistogram1D. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IHistogram1D.

createCopy

public IHistogram1D createCopy(String path,
                               IHistogram1D hist)
Description copied from interface: IHistogramFactory
Create a copy of an IHistogram1D.

Specified by:
createCopy in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
hist - The IHistogram1D to be copied.
Returns:
The copy of the IHistogram1D.

createHistogram2D

public IHistogram2D createHistogram2D(String path,
                                      String title,
                                      int nBinsX,
                                      double lowerEdgeX,
                                      double upperEdgeX,
                                      int nBinsY,
                                      double lowerEdgeY,
                                      double upperEdgeY,
                                      String options)
Create a IHistogram2D.

Specified by:
createHistogram2D in interface IHistogramFactory
Parameters:
path - The path of the created IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IHistogram2D.
nBinsX - The number of bins of the x axis.
lowerEdgeX - The lower edge of the x axis.
upperEdgeX - The upper edge of the x axis.
nBinsY - The number of bins of the y axis.
lowerEdgeY - The lower edge of the y axis.
upperEdgeY - The upper edge of the y axis.
options - The options for the IHistogram2D. The default is "". "type=efficiency" for an efficiency IHistogram2D. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IHistogram2D.

createHistogram2D

public IHistogram2D createHistogram2D(String path,
                                      String title,
                                      int nBinsX,
                                      double lowerEdgeX,
                                      double upperEdgeX,
                                      int nBinsY,
                                      double lowerEdgeY,
                                      double upperEdgeY)
Description copied from interface: IHistogramFactory
Create a IHistogram2D.

Specified by:
createHistogram2D in interface IHistogramFactory
Parameters:
path - The path of the created IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IHistogram2D.
nBinsX - The number of bins of the x axis.
lowerEdgeX - The lower edge of the x axis.
upperEdgeX - The upper edge of the x axis.
nBinsY - The number of bins of the y axis.
lowerEdgeY - The lower edge of the y axis.
upperEdgeY - The upper edge of the y axis. "type=efficiency" for an efficiency IHistogram2D. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IHistogram2D.

createHistogram2D

public IHistogram2D createHistogram2D(String pathAndTitle,
                                      int nBinsX,
                                      double lowerEdgeX,
                                      double upperEdgeX,
                                      int nBinsY,
                                      double lowerEdgeY,
                                      double upperEdgeY)
Description copied from interface: IHistogramFactory
Create a IHistogram2D.

Specified by:
createHistogram2D in interface IHistogramFactory
Parameters:
pathAndTitle - The path of the created created IHistogram. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
nBinsX - The number of bins of the x axis.
lowerEdgeX - The lower edge of the x axis.
upperEdgeX - The upper edge of the x axis.
nBinsY - The number of bins of the y axis.
lowerEdgeY - The lower edge of the y axis.
upperEdgeY - The upper edge of the y axis.
Returns:
The newly created IHistogram2D.

createHistogram2D

public IHistogram2D createHistogram2D(String path,
                                      String title,
                                      double[] binEdgesX,
                                      double[] binEdgesY,
                                      String options)
Description copied from interface: IHistogramFactory
Create a IHistogram2D.

Specified by:
createHistogram2D in interface IHistogramFactory
Parameters:
path - The path of the created IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IHistogram2D.
binEdgesX - The array of the bin edges for the x axis.
binEdgesY - The array of the bin edges for the y axis.
options - The options for the IHistogram2D. The default is "". "type=efficiency" for an efficiency IHistogram2D. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IHistogram2D.

createHistogram2D

public IHistogram2D createHistogram2D(String path,
                                      String title,
                                      double[] binEdgesX,
                                      double[] binEdgesY)
Description copied from interface: IHistogramFactory
Create a IHistogram2D.

Specified by:
createHistogram2D in interface IHistogramFactory
Parameters:
path - The path of the created IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IHistogram2D.
binEdgesX - The array of the bin edges for the x axis.
binEdgesY - The array of the bin edges for the y axis. "type=efficiency" for an efficiency IHistogram2D. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IHistogram2D.

createCopy

public IHistogram2D createCopy(String path,
                               IHistogram2D hist)
Description copied from interface: IHistogramFactory
Create a copy of an IHistogram2D.

Specified by:
createCopy in interface IHistogramFactory
hist - The IHistogram2D to be copied.
Returns:
The copy of the IHistogram2D.

createHistogram3D

public IHistogram3D createHistogram3D(String path,
                                      String title,
                                      int nBinsX,
                                      double lowerEdgeX,
                                      double upperEdgeX,
                                      int nBinsY,
                                      double lowerEdgeY,
                                      double upperEdgeY,
                                      int nBinsZ,
                                      double lowerEdgeZ,
                                      double upperEdgeZ,
                                      String options)
Create a IHistogram3D.

Specified by:
createHistogram3D in interface IHistogramFactory
Parameters:
path - The path of the created IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IHistogram3D.
nBinsX - The number of bins of the x axis.
lowerEdgeX - The lower edge of the x axis.
upperEdgeX - The upper edge of the x axis.
nBinsY - The number of bins of the y axis.
lowerEdgeY - The lower edge of the y axis.
upperEdgeY - The upper edge of the y axis.
nBinsZ - The number of bins of the z axis.
lowerEdgeZ - The lower edge of the z axis.
upperEdgeZ - The upper edge of the z axis.
options - The options for the IHistogram3D. The default is "". "type=efficiency" for an efficiency IHistogram3D. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IHistogram3D.

createHistogram3D

public IHistogram3D createHistogram3D(String path,
                                      String title,
                                      int nBinsX,
                                      double lowerEdgeX,
                                      double upperEdgeX,
                                      int nBinsY,
                                      double lowerEdgeY,
                                      double upperEdgeY,
                                      int nBinsZ,
                                      double lowerEdgeZ,
                                      double upperEdgeZ)
Description copied from interface: IHistogramFactory
Create a IHistogram3D.

Specified by:
createHistogram3D in interface IHistogramFactory
Parameters:
path - The path of the created IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IHistogram3D.
nBinsX - The number of bins of the x axis.
lowerEdgeX - The lower edge of the x axis.
upperEdgeX - The upper edge of the x axis.
nBinsY - The number of bins of the y axis.
lowerEdgeY - The lower edge of the y axis.
upperEdgeY - The upper edge of the y axis.
nBinsZ - The number of bins of the z axis.
lowerEdgeZ - The lower edge of the z axis.
upperEdgeZ - The upper edge of the z axis. "type=efficiency" for an efficiency IHistogram3D. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IHistogram3D.

createHistogram3D

public IHistogram3D createHistogram3D(String pathAndTitle,
                                      int nBinsX,
                                      double lowerEdgeX,
                                      double upperEdgeX,
                                      int nBinsY,
                                      double lowerEdgeY,
                                      double upperEdgeY,
                                      int nBinsZ,
                                      double lowerEdgeZ,
                                      double upperEdgeZ)
Description copied from interface: IHistogramFactory
Create a IHistogram3D.

Specified by:
createHistogram3D in interface IHistogramFactory
Parameters:
pathAndTitle - The path of the created created IHistogram. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
nBinsX - The number of bins of the x axis.
lowerEdgeX - The lower edge of the x axis.
upperEdgeX - The upper edge of the x axis.
nBinsY - The number of bins of the y axis.
lowerEdgeY - The lower edge of the y axis.
upperEdgeY - The upper edge of the y axis.
nBinsZ - The number of bins of the z axis.
lowerEdgeZ - The lower edge of the z axis.
upperEdgeZ - The upper edge of the z axis.
Returns:
The newly created IHistogram3D.

createHistogram3D

public IHistogram3D createHistogram3D(String path,
                                      String title,
                                      double[] binEdgesX,
                                      double[] binEdgesY,
                                      double[] binEdgesZ,
                                      String options)
Description copied from interface: IHistogramFactory
Create a IHistogram3D.

Specified by:
createHistogram3D in interface IHistogramFactory
Parameters:
path - The path of the created IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IHistogram3D.
binEdgesX - The array of the bin edges for the x axis.
binEdgesY - The array of the bin edges for the y axis.
binEdgesZ - The array of the bin edges for the z axis.
options - The options for the IHistogram3D. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object. "type=efficiency" for an efficiency IHistogram3D.
Returns:
The newly created IHistogram3D.

createHistogram3D

public IHistogram3D createHistogram3D(String path,
                                      String title,
                                      double[] binEdgesX,
                                      double[] binEdgesY,
                                      double[] binEdgesZ)
Description copied from interface: IHistogramFactory
Create a IHistogram3D.

Specified by:
createHistogram3D in interface IHistogramFactory
Parameters:
path - The path of the created IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IHistogram3D.
binEdgesX - The array of the bin edges for the x axis.
binEdgesY - The array of the bin edges for the y axis.
binEdgesZ - The array of the bin edges for the z axis. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object. "type=efficiency" for an efficiency IHistogram3D.
Returns:
The newly created IHistogram3D.

createCopy

public IHistogram3D createCopy(String path,
                               IHistogram3D hist)
Description copied from interface: IHistogramFactory
Create a copy of an IHistogram3D.

Specified by:
createCopy in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
hist - The IHistogram3D to be copied.
Returns:
The copy of the IHistogram3D.

createProfile1D

public IProfile1D createProfile1D(String path,
                                  String title,
                                  int nBins,
                                  double lowerEdge,
                                  double upperEdge,
                                  String options)
Create a IProfile1D.

Specified by:
createProfile1D in interface IHistogramFactory
Parameters:
path - The path of the created IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IProfile1D.
nBins - The number of bins of the x axis.
lowerEdge - The lower edge of the x axis.
upperEdge - The upper edge of the x axis.
options - The options for the IProfile1D. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String path,
                                  String title,
                                  int nBins,
                                  double lowerEdge,
                                  double upperEdge)
Description copied from interface: IHistogramFactory
Create a IProfile1D.

Specified by:
createProfile1D in interface IHistogramFactory
Parameters:
path - The path of the created IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IProfile1D.
nBins - The number of bins of the x axis.
lowerEdge - The lower edge of the x axis.
upperEdge - The upper edge of the x axis. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String path,
                                  String title,
                                  int nBins,
                                  double lowerEdge,
                                  double upperEdge,
                                  double lowerValue,
                                  double upperValue,
                                  String options)
Description copied from interface: IHistogramFactory
Create a IProfile1D.

Specified by:
createProfile1D in interface IHistogramFactory
Parameters:
path - The path of the created IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IProfile1D.
nBins - The number of bins of the x axis.
lowerEdge - The lower edge of the x axis.
upperEdge - The upper edge of the x axis.
lowerValue - The lower value displayed along the y axis.
upperValue - The upper value displayed along the y axis.
options - The options for the IProfile1D. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String path,
                                  String title,
                                  int nBins,
                                  double lowerEdge,
                                  double upperEdge,
                                  double lowerValue,
                                  double upperValue)
Description copied from interface: IHistogramFactory
Create a IProfile1D.

Specified by:
createProfile1D in interface IHistogramFactory
Parameters:
path - The path of the created IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IProfile1D.
nBins - The number of bins of the x axis.
lowerEdge - The lower edge of the x axis.
upperEdge - The upper edge of the x axis.
lowerValue - The lower value displayed along the y axis.
upperValue - The upper value displayed along the y axis. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String pathAndTitle,
                                  int nBins,
                                  double lowerEdge,
                                  double upperEdge)
Description copied from interface: IHistogramFactory
Create a IProfile1D.

Specified by:
createProfile1D in interface IHistogramFactory
Parameters:
pathAndTitle - The path of the created created IProfile. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
nBins - The number of bins of the x axis.
lowerEdge - The lower edge of the x axis.
upperEdge - The upper edge of the x axis.
Returns:
The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String pathAndTitle,
                                  int nBins,
                                  double lowerEdge,
                                  double upperEdge,
                                  double lowerValue,
                                  double upperValue)
Description copied from interface: IHistogramFactory
Create a IProfile1D.

Specified by:
createProfile1D in interface IHistogramFactory
Parameters:
pathAndTitle - The path of the created created IProfile. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
nBins - The number of bins of the x axis.
lowerEdge - The lower edge of the x axis.
upperEdge - The upper edge of the x axis.
lowerValue - The lower value displayed along the y axis.
upperValue - The upper value displayed along the y axis.
Returns:
The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String path,
                                  String title,
                                  double[] binEdges,
                                  String options)
Description copied from interface: IHistogramFactory
Create a IProfile1D.

Specified by:
createProfile1D in interface IHistogramFactory
Parameters:
path - The path of the created IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IProfile1D.
binEdges - The array of the bin edges for the x axis.
options - The options for the IProfile1D. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String path,
                                  String title,
                                  double[] binEdges)
Description copied from interface: IHistogramFactory
Create a IProfile1D.

Specified by:
createProfile1D in interface IHistogramFactory
Parameters:
path - The path of the created IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IProfile1D.
binEdges - The array of the bin edges for the x axis. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String path,
                                  String title,
                                  double[] binEdges,
                                  double lowerValue,
                                  double upperValue,
                                  String options)
Description copied from interface: IHistogramFactory
Create a IProfile1D.

Specified by:
createProfile1D in interface IHistogramFactory
Parameters:
path - The path of the created IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IProfile1D.
binEdges - The array of the bin edges for the x axis.
lowerValue - The lower value displayed along the y axis.
upperValue - The upper value displayed along the y axis.
options - The options for the IProfile1D. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String path,
                                  String title,
                                  double[] binEdges,
                                  double lowerValue,
                                  double upperValue)
Description copied from interface: IHistogramFactory
Create a IProfile1D.

Specified by:
createProfile1D in interface IHistogramFactory
Parameters:
path - The path of the created IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IProfile1D.
binEdges - The array of the bin edges for the x axis.
lowerValue - The lower value displayed along the y axis.
upperValue - The upper value displayed along the y axis. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IProfile1D.

createCopy

public IProfile1D createCopy(String path,
                             IProfile1D profile)
Description copied from interface: IHistogramFactory
Create a copy of an IProfile1D.

Specified by:
createCopy in interface IHistogramFactory
Parameters:
path - The path of the resulting IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
profile - The IProfile1D to be copied.
Returns:
The copy of the IProfile1D.

createProfile2D

public IProfile2D createProfile2D(String path,
                                  String title,
                                  int nBinsX,
                                  double lowerEdgeX,
                                  double upperEdgeX,
                                  int nBinsY,
                                  double lowerEdgeY,
                                  double upperEdgeY,
                                  String options)
Create a IProfile2D.

Specified by:
createProfile2D in interface IHistogramFactory
Parameters:
path - The path of the created IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IProfile2D.
nBinsX - The number of bins of the x axis.
lowerEdgeX - The lower edge of the x axis.
upperEdgeX - The upper edge of the x axis.
nBinsY - The number of bins of the y axis.
lowerEdgeY - The lower edge of the y axis.
upperEdgeY - The upper edge of the y axis.
options - The options for the IProfile2D. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String path,
                                  String title,
                                  int nBinsX,
                                  double lowerEdgeX,
                                  double upperEdgeX,
                                  int nBinsY,
                                  double lowerEdgeY,
                                  double upperEdgeY)
Description copied from interface: IHistogramFactory
Create a IProfile2D.

Specified by:
createProfile2D in interface IHistogramFactory
Parameters:
path - The path of the created IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IProfile2D.
nBinsX - The number of bins of the x axis.
lowerEdgeX - The lower edge of the x axis.
upperEdgeX - The upper edge of the x axis.
nBinsY - The number of bins of the y axis.
lowerEdgeY - The lower edge of the y axis.
upperEdgeY - The upper edge of the y axis. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String path,
                                  String title,
                                  int nBinsX,
                                  double lowerEdgeX,
                                  double upperEdgeX,
                                  int nBinsY,
                                  double lowerEdgeY,
                                  double upperEdgeY,
                                  double lowerValue,
                                  double upperValue,
                                  String options)
Description copied from interface: IHistogramFactory
Create a IProfile2D.

Specified by:
createProfile2D in interface IHistogramFactory
Parameters:
path - The path of the created IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IProfile2D.
nBinsX - The number of bins of the x axis.
lowerEdgeX - The lower edge of the x axis.
upperEdgeX - The upper edge of the x axis.
nBinsY - The number of bins of the y axis.
lowerEdgeY - The lower edge of the y axis.
upperEdgeY - The upper edge of the y axis.
lowerValue - The lower value displayed along the z axis.
upperValue - The upper value displayed along the z axis.
options - The options for the IProfile2D. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String path,
                                  String title,
                                  int nBinsX,
                                  double lowerEdgeX,
                                  double upperEdgeX,
                                  int nBinsY,
                                  double lowerEdgeY,
                                  double upperEdgeY,
                                  double lowerValue,
                                  double upperValue)
Description copied from interface: IHistogramFactory
Create a IProfile2D.

Specified by:
createProfile2D in interface IHistogramFactory
Parameters:
path - The path of the created IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IProfile2D.
nBinsX - The number of bins of the x axis.
lowerEdgeX - The lower edge of the x axis.
upperEdgeX - The upper edge of the x axis.
nBinsY - The number of bins of the y axis.
lowerEdgeY - The lower edge of the y axis.
upperEdgeY - The upper edge of the y axis.
lowerValue - The lower value displayed along the z axis.
upperValue - The upper value displayed along the z axis. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String pathAndTitle,
                                  int nBinsX,
                                  double lowerEdgeX,
                                  double upperEdgeX,
                                  int nBinsY,
                                  double lowerEdgeY,
                                  double upperEdgeY)
Description copied from interface: IHistogramFactory
Create a IProfile2D.

Specified by:
createProfile2D in interface IHistogramFactory
Parameters:
pathAndTitle - The path of the created created IProfile. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
nBinsX - The number of bins of the x axis.
lowerEdgeX - The lower edge of the x axis.
upperEdgeX - The upper edge of the x axis.
nBinsY - The number of bins of the y axis.
lowerEdgeY - The lower edge of the y axis.
upperEdgeY - The upper edge of the y axis.
Returns:
The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String pathAndTitle,
                                  int nBinsX,
                                  double lowerEdgeX,
                                  double upperEdgeX,
                                  int nBinsY,
                                  double lowerEdgeY,
                                  double upperEdgeY,
                                  double lowerValue,
                                  double upperValue)
Description copied from interface: IHistogramFactory
Create a IProfile2D.

Specified by:
createProfile2D in interface IHistogramFactory
Parameters:
pathAndTitle - The path of the created created IProfile. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
nBinsX - The number of bins of the x axis.
lowerEdgeX - The lower edge of the x axis.
upperEdgeX - The upper edge of the x axis.
nBinsY - The number of bins of the y axis.
lowerEdgeY - The lower edge of the y axis.
upperEdgeY - The upper edge of the y axis.
lowerValue - The lower value displayed along the z axis.
upperValue - The upper value displayed along the z axis.
Returns:
The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String path,
                                  String title,
                                  double[] binEdgesX,
                                  double[] binEdgesY,
                                  String options)
Description copied from interface: IHistogramFactory
Create a IProfile2D.

Specified by:
createProfile2D in interface IHistogramFactory
Parameters:
path - The path of the created IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IProfile2D.
binEdgesX - The array of the bin edges for the x axis.
binEdgesY - The array of the bin edges for the y axis.
options - The options for the IProfile2D. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String path,
                                  String title,
                                  double[] binEdgesX,
                                  double[] binEdgesY)
Description copied from interface: IHistogramFactory
Create a IProfile2D.

Specified by:
createProfile2D in interface IHistogramFactory
Parameters:
path - The path of the created IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IProfile2D.
binEdgesX - The array of the bin edges for the x axis.
binEdgesY - The array of the bin edges for the y axis. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String path,
                                  String title,
                                  double[] binEdgesX,
                                  double[] binEdgesY,
                                  double lowerValue,
                                  double upperValue,
                                  String options)
Description copied from interface: IHistogramFactory
Create a IProfile2D.

Specified by:
createProfile2D in interface IHistogramFactory
Parameters:
path - The path of the created IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IProfile2D.
binEdgesX - The array of the bin edges for the x axis.
binEdgesY - The array of the bin edges for the y axis.
lowerValue - The lower value displayed along the y axis.
upperValue - The upper value displayed along the y axis.
options - The options for the IProfile2D. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String path,
                                  String title,
                                  double[] binEdgesX,
                                  double[] binEdgesY,
                                  double lowerValue,
                                  double upperValue)
Description copied from interface: IHistogramFactory
Create a IProfile2D.

Specified by:
createProfile2D in interface IHistogramFactory
Parameters:
path - The path of the created IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the IProfile2D.
binEdgesX - The array of the bin edges for the x axis.
binEdgesY - The array of the bin edges for the y axis.
lowerValue - The lower value displayed along the y axis.
upperValue - The upper value displayed along the y axis. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
Returns:
The newly created IProfile2D.

createCopy

public IProfile2D createCopy(String path,
                             IProfile2D profile)
Description copied from interface: IHistogramFactory
Create a copy of an IProfile2D.

Specified by:
createCopy in interface IHistogramFactory
Parameters:
path - The path of the resulting IProfile. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
profile - The IProfile2D to be copied.
Returns:
The copy of the IProfile2D.

add

public IHistogram1D add(String path,
                        IHistogram1D a,
                        IHistogram1D b)
                 throws IllegalArgumentException
Adds two 1D Histogram

Specified by:
add in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
a - The first member of the addition.
b - The second member of the addition.
Returns:
a+b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

subtract

public IHistogram1D subtract(String path,
                             IHistogram1D a,
                             IHistogram1D b)
                      throws IllegalArgumentException
Subtracts two 1D Histogram

Specified by:
subtract in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
a - The first member of the subtraction.
b - The second member of the subtraction.
Returns:
a-b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

multiply

public IHistogram1D multiply(String path,
                             IHistogram1D a,
                             IHistogram1D b)
                      throws IllegalArgumentException
Multiplies two 1D Histogram

Specified by:
multiply in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
a - The first member of the multiplication.
b - The second member of the multiplication.
Returns:
a*b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

divide

public IHistogram1D divide(String path,
                           IHistogram1D a,
                           IHistogram1D b)
                    throws IllegalArgumentException
Divides two 1D Histogram

Specified by:
divide in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
a - The first member of the division.
b - The second member of the division.
Returns:
a/b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

add

public IHistogram2D add(String path,
                        IHistogram2D a,
                        IHistogram2D b)
                 throws IllegalArgumentException
Adds two 2D Histogram

Specified by:
add in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
a - The first member of the addition.
b - The second member of the addition.
Returns:
a+b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

subtract

public IHistogram2D subtract(String path,
                             IHistogram2D a,
                             IHistogram2D b)
                      throws IllegalArgumentException
Subtracts two 2D Histogram

Specified by:
subtract in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
a - The first member of the subtraction.
b - The second member of the subtraction.
Returns:
a-b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

multiply

public IHistogram2D multiply(String path,
                             IHistogram2D a,
                             IHistogram2D b)
                      throws IllegalArgumentException
Multiplies two 2D Histogram

Specified by:
multiply in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
a - The first member of the multiplication.
b - The second member of the multiplication.
Returns:
a*b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

divide

public IHistogram2D divide(String path,
                           IHistogram2D a,
                           IHistogram2D b)
                    throws IllegalArgumentException
Divides two 2D Histogram

Specified by:
divide in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
a - The first member of the division.
b - The second member of the division.
Returns:
a/b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

add

public IHistogram3D add(String path,
                        IHistogram3D a,
                        IHistogram3D b)
                 throws IllegalArgumentException
Adds two 3D Histogram

Specified by:
add in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
a - The first member of the addition.
b - The second member of the addition.
Returns:
a+b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

subtract

public IHistogram3D subtract(String path,
                             IHistogram3D a,
                             IHistogram3D b)
                      throws IllegalArgumentException
Subtracts two 3D Histogram

Specified by:
subtract in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
a - The first member of the subtraction.
b - The second member of the subtraction.
Returns:
a-b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

multiply

public IHistogram3D multiply(String path,
                             IHistogram3D a,
                             IHistogram3D b)
                      throws IllegalArgumentException
Multiplies two 3D Histogram

Specified by:
multiply in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
a - The first member of the multiplication.
b - The second member of the multiplication.
Returns:
a*b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

divide

public IHistogram3D divide(String path,
                           IHistogram3D a,
                           IHistogram3D b)
                    throws IllegalArgumentException
Divides two 3D Histogram

Specified by:
divide in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
a - The first member of the division.
b - The second member of the division.
Returns:
a/b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

projectionX

public IHistogram1D projectionX(String path,
                                IHistogram2D h)
Create a projection from a 2D histogram parallel to the X axis. Equivalent to sliceX(UNDERFLOW_BIN,OVERFLOW_BIN).

Specified by:
projectionX in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
h - The IHistogram2D to be projected.
Returns:
The resulting projection.

projectionY

public IHistogram1D projectionY(String path,
                                IHistogram2D h)
Create a projection from a 2D histogram parallel to the Y axis. Equivalent to sliceY(UNDERFLOW_BIN,OVERFLOW_BIN).

Specified by:
projectionY in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
h - The IHistogram2D to be projected.
Returns:
The resulting projection.

sliceX

public IHistogram1D sliceX(String path,
                           IHistogram2D h,
                           int indexY)
Slice parallel to the Y axis from a 2D histogram at bin indexY and one bin wide. Equivalent to sliceX(indexY,indexY).

Specified by:
sliceX in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
h - The IHistogram2D to be sliced.
indexY - The index of the bin along the y axis where the IHistogram2D has to be sliced.
Returns:
The resulting slice.

sliceY

public IHistogram1D sliceY(String path,
                           IHistogram2D h,
                           int indexX)
Slice parallel to the X axis from a 2D histogram at bin indexX and one bin wide. Equivalent to sliceY(indexX,indexX).

Specified by:
sliceY in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
h - The IHistogram2D to be sliced.
indexX - The index of the bin along the x axis where the IHistogram2D has to be sliced.
Returns:
The resulting slice.

sliceX

public IHistogram1D sliceX(String path,
                           IHistogram2D h,
                           int indexY1,
                           int indexY2)
Create a slice parallel to the X axis from a 2D histogram, between "indexY1" and "indexY2" (inclusive). The returned IHistogram1D represents an instantaneous snapshot of the histogram at the time the slice was created.

Specified by:
sliceX in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
h - The IHistogram2D to be sliced.
indexY1 - The index of the bin along the y axis that marks the lower edge of the slice.
indexY2 - The index of the bin along the y axis that marks the upper edge of the slice.
Returns:
The resulting slice.

sliceY

public IHistogram1D sliceY(String path,
                           IHistogram2D h,
                           int indexX1,
                           int indexX2)
Create a slice parallel to the Y axis from a 2D histogram, between "indexX1" and "indexX2" (inclusive). The returned IHistogram1D represents an instantaneous snapshot of the histogram at the time the slice was created.

Specified by:
sliceY in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
h - The IHistogram2D to be sliced.
indexX1 - The index of the bin along the x axis that marks the lower edge of the slice.
indexX2 - The index of the bin along the x axis that marks the upper edge of the slice.
Returns:
The resulting slice.

projectionXY

public IHistogram2D projectionXY(String path,
                                 IHistogram3D h)
Create a projection parallel to the X axis from a 3D histogram. Equivalent to sliceXY(UNDERFLOW_BIN,OVERFLOW_BIN).

Specified by:
projectionXY in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
h - The IHistogram3D to be projected.
Returns:
The resulting projection.

projectionXZ

public IHistogram2D projectionXZ(String path,
                                 IHistogram3D h)
Create a projection parallel to the Z axis from a 3D histogram. Equivalent to sliceXZ(UNDERFLOW_BIN,OVERFLOW_BIN).

Specified by:
projectionXZ in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
h - The IHistogram3D to be projected.
Returns:
The resulting projection.

projectionYZ

public IHistogram2D projectionYZ(String path,
                                 IHistogram3D h)
Create a projection parallel to the Y axis from a 3D histogram. Equivalent to sliceYZ(UNDERFLOW_BIN,OVERFLOW_BIN).

Specified by:
projectionYZ in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
h - The IHistogram3D to be projected.
Returns:
The resulting projection.

sliceXY

public IHistogram2D sliceXY(String path,
                            IHistogram3D h,
                            int indexZ1,
                            int indexZ2)
Create a slice perpendicular to the Z axis from a 3D histogram, between "indexZ1" and "indexZ2" (inclusive). The returned IHistogram2D represents an instantaneous snapshot of the histogram at the time the slice was created. The X axis of the returned histogram corresponds to the X axis of this histogram. The Y axis of the returned histogram corresponds to the Y axis of this histogram.

Specified by:
sliceXY in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
h - The IHistogram3D to sliced.
indexZ1 - The index of the bin along the z axis that marks the lower edge of the slice.
indexZ2 - The index of the bin along the z axis that marks the upper edge of the slice.
Returns:
The resulting slice.

sliceXZ

public IHistogram2D sliceXZ(String path,
                            IHistogram3D h,
                            int indexY1,
                            int indexY2)
Create a slice perpendicular to the Y axis from a 3D histogram, between "indexY1" and "indexY2" (inclusive). The returned IHistogram2D represents an instantaneous snapshot of the histogram at the time the slice was created. The X axis of the returned histogram corresponds to the X axis of this histogram. The Y axis of the returned histogram corresponds to the Z axis of this histogram.

Specified by:
sliceXZ in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
h - The IHistogram3D to sliced.
indexY1 - The index of the bin along the y axis that marks the lower edge of the slice.
indexY2 - The index of the bin along the y axis that marks the upper edge of the slice.
Returns:
The resulting slice.

sliceYZ

public IHistogram2D sliceYZ(String path,
                            IHistogram3D h,
                            int indexX1,
                            int indexX2)
Create a slice perpendicular to the X axis from a 3D histogram, between "indexX1" and "indexX2" (inclusive). The returned IHistogram2D represents an instantaneous snapshot of the histogram at the time the slice was created. The X axis of the returned histogram corresponds to the Y axis of this histogram. The Y axis of the returned histogram corresponds to the Z axis of this histogram.

Specified by:
sliceYZ in interface IHistogramFactory
Parameters:
path - The path of the resulting IHistogram. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
h - The IHistogram3D to sliced.
indexX1 - The index of the bin along the x axis that marks the lower edge of the slice.
indexX2 - The index of the bin along the x axis that marks the upper edge of the slice.
Returns:
The resulting slice.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
jHepWork 3.2 © jWork.org