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

hep.aida
Interface IHistogramFactory

public interface IHistogramFactory

User level interface for factory classes of Histograms (binned, unbinned, and profile) The created objects are assumed to be managed by the tree which is associated to the factory.

Author:
The AIDA team (http://aida.freehep.org/)

Method Summary
 IHistogram1D add(String path, IHistogram1D hist1, IHistogram1D hist2)
          Create an IHistogram1D by adding two IHistogram1D.
 IHistogram2D add(String path, IHistogram2D hist1, IHistogram2D hist2)
          Create an IHistogram2D by adding two IHistogram2D.
 IHistogram3D add(String path, IHistogram3D hist1, IHistogram3D hist2)
          Create an IHistogram3D by adding two IHistogram3D.
 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 ICloud1D, an 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 ICloud2D, an 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 ICloud3D, an 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 copy, 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 hist1, IHistogram1D hist2)
          Create an IHistogram1D by dividing two IHistogram1D.
 IHistogram2D divide(String path, IHistogram2D hist1, IHistogram2D hist2)
          Create an IHistogram2D by dividing two IHistogram2D.
 IHistogram3D divide(String path, IHistogram3D hist1, IHistogram3D hist2)
          Create an IHistogram3D by dividing two IHistogram3D.
 IHistogram1D multiply(String path, IHistogram1D hist1, IHistogram1D hist2)
          Create an IHistogram1D by multiplying two IHistogram1D.
 IHistogram2D multiply(String path, IHistogram2D hist1, IHistogram2D hist2)
          Create an IHistogram2D by multiplying two IHistogram2D.
 IHistogram3D multiply(String path, IHistogram3D hist1, IHistogram3D hist2)
          Create an IHistogram3D by multiplying two IHistogram3D.
 IHistogram1D projectionX(String path, IHistogram2D hist)
          Create an IHistogram1D by projecting an IHistogram2D along its x axis.
 IHistogram2D projectionXY(String path, IHistogram3D hist)
          Create an IHistogram2D by projecting an IHistogram3D on the x-y plane.
 IHistogram2D projectionXZ(String path, IHistogram3D hist)
          Create an IHistogram2D by projecting an IHistogram3D on the x-z plane.
 IHistogram1D projectionY(String path, IHistogram2D hist)
          Create an IHistogram1D by projecting an IHistogram2D along its y axis.
 IHistogram2D projectionYZ(String path, IHistogram3D hist)
          Create an IHistogram2D by projecting an IHistogram3D on the y-z plane.
 IHistogram1D sliceX(String path, IHistogram2D hist, int index)
          Create an IHistogram1D by slicing an IHistogram2D parallel to the y axis at a given bin.
 IHistogram1D sliceX(String path, IHistogram2D hist, int index1, int index2)
          Create an IHistogram1D by slicing an IHistogram2D parallel to the y axis between two bins (inclusive).
 IHistogram2D sliceXY(String path, IHistogram3D hist, int index1, int index2)
          Create an IHistogram2D by slicing an IHistogram3D perpendicular to the Z axis, between "index1" and "index2" (inclusive).
 IHistogram2D sliceXZ(String path, IHistogram3D hist, int index1, int index2)
          Create an IHistogram2D by slicing an IHistogram3D perpendicular to the Y axis, between "index1" and "index2" (inclusive).
 IHistogram1D sliceY(String path, IHistogram2D hist, int index)
          Create an IHistogram1D by slicing an IHistogram2D parallel to the x axis at a given bin.
 IHistogram1D sliceY(String path, IHistogram2D hist, int index1, int index2)
          Create an IHistogram1D by slicing an IHistogram2D parallel to the x axis between two bins (inclusive).
 IHistogram2D sliceYZ(String path, IHistogram3D hist, int index1, int index2)
          Create an IHistogram2D by slicing an IHistogram3D perpendicular to the X axis, between "index1" and "index2" (inclusive).
 IHistogram1D subtract(String path, IHistogram1D hist1, IHistogram1D hist2)
          Create an IHistogram1D by subtracting two IHistogram1D.
 IHistogram2D subtract(String path, IHistogram2D hist1, IHistogram2D hist2)
          Create an IHistogram2D by subtracting two IHistogram2D.
 IHistogram3D subtract(String path, IHistogram3D hist1, IHistogram3D hist2)
          Create an IHistogram3D by subtracting two IHistogram3D.
 

Method Detail

destroy

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

Parameters:
hist - The IBaseHistogram to be destroyed.
Throws:
IllegalArgumentException - If the histogram cannot be destroyed.

createCloud1D

public ICloud1D createCloud1D(String path,
                              String title)
                       throws IllegalArgumentException
Create a ICloud1D, an unbinned 1-dimensional histogram.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCloud1D

public ICloud1D createCloud1D(String path,
                              String title,
                              int nMax)
                       throws IllegalArgumentException
Create a ICloud1D, an unbinned 1-dimensional histogram.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCloud1D

public ICloud1D createCloud1D(String path,
                              String title,
                              int nMax,
                              String options)
                       throws IllegalArgumentException
Create a ICloud1D, an unbinned 1-dimensional histogram.

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.
options - The options for the ICloud1D. "autoconvert=true" to enable 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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCloud1D

public ICloud1D createCloud1D(String pathAndTitle)
                       throws IllegalArgumentException
Create a ICloud1D, an unbinned 1-dimensional histogram.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCopy

public ICloud1D createCopy(String path,
                           ICloud1D cloud)
                    throws IllegalArgumentException
Create a copy of an ICloud1D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCloud2D

public ICloud2D createCloud2D(String path,
                              String title)
                       throws IllegalArgumentException
Create a ICloud2D, an unbinned 2-dimensional histogram.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCloud2D

public ICloud2D createCloud2D(String path,
                              String title,
                              int nMax)
                       throws IllegalArgumentException
Create a ICloud2D, an unbinned 2-dimensional histogram.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCloud2D

public ICloud2D createCloud2D(String path,
                              String title,
                              int nMax,
                              String options)
                       throws IllegalArgumentException
Create a ICloud2D, an unbinned 2-dimensional histogram.

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.
options - The options for the ICloud2D. "autoconvert=true" to enable 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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCloud2D

public ICloud2D createCloud2D(String pathAndTitle)
                       throws IllegalArgumentException
Create a ICloud2D, an unbinned 2-dimensional histogram.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCopy

public ICloud2D createCopy(String path,
                           ICloud2D cloud)
                    throws IllegalArgumentException
Create a copy of an ICloud2D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCloud3D

public ICloud3D createCloud3D(String path,
                              String title)
                       throws IllegalArgumentException
Create a ICloud3D, an unbinned 3-dimensional histogram.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCloud3D

public ICloud3D createCloud3D(String path,
                              String title,
                              int nMax)
                       throws IllegalArgumentException
Create a ICloud3D, an unbinned 3-dimensional histogram.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCloud3D

public ICloud3D createCloud3D(String path,
                              String title,
                              int nMax,
                              String options)
                       throws IllegalArgumentException
Create a ICloud3D, an unbinned 3-dimensional histogram.

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
options - The options for the ICloud3D. "autoconvert=true" to enable 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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCloud3D

public ICloud3D createCloud3D(String pathAndTitle)
                       throws IllegalArgumentException
Create a ICloud3D, an unbinned 3-dimensional histogram.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCopy

public ICloud3D createCopy(String path,
                           ICloud3D cloud)
                    throws IllegalArgumentException
Create a copy of an ICloud3D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createHistogram1D

public IHistogram1D createHistogram1D(String path,
                                      String title,
                                      int nBins,
                                      double lowerEdge,
                                      double upperEdge)
                               throws IllegalArgumentException
Create a IHistogram1D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createHistogram1D

public IHistogram1D createHistogram1D(String path,
                                      String title,
                                      int nBins,
                                      double lowerEdge,
                                      double upperEdge,
                                      String options)
                               throws IllegalArgumentException
Create a IHistogram1D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createHistogram1D

public IHistogram1D createHistogram1D(String pathAndTitle,
                                      int nBins,
                                      double lowerEdge,
                                      double upperEdge)
                               throws IllegalArgumentException
Create a IHistogram1D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createHistogram1D

public IHistogram1D createHistogram1D(String path,
                                      String title,
                                      double[] binEdges)
                               throws IllegalArgumentException
Create a IHistogram1D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createHistogram1D

public IHistogram1D createHistogram1D(String path,
                                      String title,
                                      double[] binEdges,
                                      String options)
                               throws IllegalArgumentException
Create a IHistogram1D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCopy

public IHistogram1D createCopy(String path,
                               IHistogram1D hist)
                        throws IllegalArgumentException
Create a copy of an IHistogram1D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createHistogram2D

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

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

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.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createHistogram2D

public IHistogram2D createHistogram2D(String pathAndTitle,
                                      int nBinsX,
                                      double lowerEdgeX,
                                      double upperEdgeX,
                                      int nBinsY,
                                      double lowerEdgeY,
                                      double upperEdgeY)
                               throws IllegalArgumentException
Create a IHistogram2D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createHistogram2D

public IHistogram2D createHistogram2D(String path,
                                      String title,
                                      double[] binEdgesX,
                                      double[] binEdgesY)
                               throws IllegalArgumentException
Create a IHistogram2D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createHistogram2D

public IHistogram2D createHistogram2D(String path,
                                      String title,
                                      double[] binEdgesX,
                                      double[] binEdgesY,
                                      String options)
                               throws IllegalArgumentException
Create a IHistogram2D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCopy

public IHistogram2D createCopy(String copy,
                               IHistogram2D hist)
                        throws IllegalArgumentException
Create a copy of an IHistogram2D.

Parameters:
hist - The IHistogram2D to be copied.
Returns:
The copy of the IHistogram2D.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

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)
                               throws IllegalArgumentException
Create a IHistogram3D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

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)
                               throws IllegalArgumentException
Create a IHistogram3D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createHistogram3D

public IHistogram3D createHistogram3D(String pathAndTitle,
                                      int nBinsX,
                                      double lowerEdgeX,
                                      double upperEdgeX,
                                      int nBinsY,
                                      double lowerEdgeY,
                                      double upperEdgeY,
                                      int nBinsZ,
                                      double lowerEdgeZ,
                                      double upperEdgeZ)
                               throws IllegalArgumentException
Create a IHistogram3D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createHistogram3D

public IHistogram3D createHistogram3D(String path,
                                      String title,
                                      double[] binEdgesX,
                                      double[] binEdgesY,
                                      double[] binEdgesZ)
                               throws IllegalArgumentException
Create a IHistogram3D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createHistogram3D

public IHistogram3D createHistogram3D(String path,
                                      String title,
                                      double[] binEdgesX,
                                      double[] binEdgesY,
                                      double[] binEdgesZ,
                                      String options)
                               throws IllegalArgumentException
Create a IHistogram3D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCopy

public IHistogram3D createCopy(String path,
                               IHistogram3D hist)
                        throws IllegalArgumentException
Create a copy of an IHistogram3D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile1D

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

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile1D

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

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile1D

public IProfile1D createProfile1D(String path,
                                  String title,
                                  int nBins,
                                  double lowerEdge,
                                  double upperEdge,
                                  double lowerValue,
                                  double upperValue)
                           throws IllegalArgumentException
Create a IProfile1D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile1D

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

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile1D

public IProfile1D createProfile1D(String path,
                                  String title,
                                  double[] binEdges)
                           throws IllegalArgumentException
Create a IProfile1D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile1D

public IProfile1D createProfile1D(String path,
                                  String title,
                                  double[] binEdges,
                                  String options)
                           throws IllegalArgumentException
Create a IProfile1D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile1D

public IProfile1D createProfile1D(String path,
                                  String title,
                                  double[] binEdges,
                                  double lowerValue,
                                  double upperValue)
                           throws IllegalArgumentException
Create a IProfile1D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile1D

public IProfile1D createProfile1D(String path,
                                  String title,
                                  double[] binEdges,
                                  double lowerValue,
                                  double upperValue,
                                  String options)
                           throws IllegalArgumentException
Create a IProfile1D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile1D

public IProfile1D createProfile1D(String pathAndTitle,
                                  int nBins,
                                  double lowerEdge,
                                  double upperEdge)
                           throws IllegalArgumentException
Create a IProfile1D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile1D

public IProfile1D createProfile1D(String pathAndTitle,
                                  int nBins,
                                  double lowerEdge,
                                  double upperEdge,
                                  double lowerValue,
                                  double upperValue)
                           throws IllegalArgumentException
Create a IProfile1D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCopy

public IProfile1D createCopy(String path,
                             IProfile1D profile)
                      throws IllegalArgumentException
Create a copy of an IProfile1D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile2D

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

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile2D

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

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile2D

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

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

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)
                           throws IllegalArgumentException
Create a IProfile2D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile2D

public IProfile2D createProfile2D(String path,
                                  String title,
                                  double[] binEdgesX,
                                  double[] binEdgesY)
                           throws IllegalArgumentException
Create a IProfile2D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile2D

public IProfile2D createProfile2D(String path,
                                  String title,
                                  double[] binEdgesX,
                                  double[] binEdgesY,
                                  String options)
                           throws IllegalArgumentException
Create a IProfile2D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile2D

public IProfile2D createProfile2D(String path,
                                  String title,
                                  double[] binEdgesX,
                                  double[] binEdgesY,
                                  double lowerValue,
                                  double upperValue)
                           throws IllegalArgumentException
Create a IProfile2D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile2D

public IProfile2D createProfile2D(String path,
                                  String title,
                                  double[] binEdgesX,
                                  double[] binEdgesY,
                                  double lowerValue,
                                  double upperValue,
                                  String options)
                           throws IllegalArgumentException
Create a IProfile2D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile2D

public IProfile2D createProfile2D(String pathAndTitle,
                                  int nBinsX,
                                  double lowerEdgeX,
                                  double upperEdgeX,
                                  int nBinsY,
                                  double lowerEdgeY,
                                  double upperEdgeY)
                           throws IllegalArgumentException
Create a IProfile2D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createProfile2D

public IProfile2D createProfile2D(String pathAndTitle,
                                  int nBinsX,
                                  double lowerEdgeX,
                                  double upperEdgeX,
                                  int nBinsY,
                                  double lowerEdgeY,
                                  double upperEdgeY,
                                  double lowerValue,
                                  double upperValue)
                           throws IllegalArgumentException
Create a IProfile2D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createCopy

public IProfile2D createCopy(String path,
                             IProfile2D profile)
                      throws IllegalArgumentException
Create a copy of an IProfile2D.

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.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

add

public IHistogram1D add(String path,
                        IHistogram1D hist1,
                        IHistogram1D hist2)
                 throws IllegalArgumentException
Create an IHistogram1D by adding two IHistogram1D.

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.
hist1 - The first member of the addition.
hist2 - The second member of the addition.
Returns:
The sum of the two IHistogram1D.
Throws:
IllegalArgumentException - if the two IHistogram1D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.

subtract

public IHistogram1D subtract(String path,
                             IHistogram1D hist1,
                             IHistogram1D hist2)
                      throws IllegalArgumentException
Create an IHistogram1D by subtracting two IHistogram1D.

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.
hist1 - The first member of the subtraction.
hist2 - The second member of the subtraction.
Returns:
The difference of the two IHistogram1D.
Throws:
IllegalArgumentException - if the two IHistogram1D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.

multiply

public IHistogram1D multiply(String path,
                             IHistogram1D hist1,
                             IHistogram1D hist2)
                      throws IllegalArgumentException
Create an IHistogram1D by multiplying two IHistogram1D.

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.
hist1 - The first member of the multiplication.
hist2 - The second member of the multiplication.
Returns:
The product of the two IHistogram1D.
Throws:
IllegalArgumentException - if the two IHistogram1D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.

divide

public IHistogram1D divide(String path,
                           IHistogram1D hist1,
                           IHistogram1D hist2)
                    throws IllegalArgumentException
Create an IHistogram1D by dividing two IHistogram1D.

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.
hist1 - The first member of the division.
hist2 - The second member of the division.
Returns:
The ration of the two IHistogram1D.
Throws:
IllegalArgumentException - if the two IHistogram1D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.

add

public IHistogram2D add(String path,
                        IHistogram2D hist1,
                        IHistogram2D hist2)
                 throws IllegalArgumentException
Create an IHistogram2D by adding two IHistogram2D.

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.
hist1 - The first member of the addition.
hist2 - The second member of the addition.
Returns:
The sum of the two IHistogram2D.
Throws:
IllegalArgumentException - if the two IHistogram2D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.

subtract

public IHistogram2D subtract(String path,
                             IHistogram2D hist1,
                             IHistogram2D hist2)
                      throws IllegalArgumentException
Create an IHistogram2D by subtracting two IHistogram2D.

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.
hist1 - The first member of the subtraction.
hist2 - The second member of the subtraction.
Returns:
The difference of the two IHistogram2D.
Throws:
IllegalArgumentException - if the two IHistogram2D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.

multiply

public IHistogram2D multiply(String path,
                             IHistogram2D hist1,
                             IHistogram2D hist2)
                      throws IllegalArgumentException
Create an IHistogram2D by multiplying two IHistogram2D.

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.
hist1 - The first member of the multiplication.
hist2 - The second member of the multiplication.
Returns:
The product of the two IHistogram2D.
Throws:
IllegalArgumentException - if the two IHistogram2D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.

divide

public IHistogram2D divide(String path,
                           IHistogram2D hist1,
                           IHistogram2D hist2)
                    throws IllegalArgumentException
Create an IHistogram2D by dividing two IHistogram2D.

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.
hist1 - The first member of the division.
hist2 - The second member of the division.
Returns:
The ration of the two IHistogram2D.
Throws:
IllegalArgumentException - if the two IHistogram2D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.

add

public IHistogram3D add(String path,
                        IHistogram3D hist1,
                        IHistogram3D hist2)
                 throws IllegalArgumentException
Create an IHistogram3D by adding two IHistogram3D.

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.
hist1 - The first member of the addition.
hist2 - The second member of the addition.
Returns:
The sum of the two IHistogram3D.
Throws:
IllegalArgumentException - if the two IHistogram3D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.

subtract

public IHistogram3D subtract(String path,
                             IHistogram3D hist1,
                             IHistogram3D hist2)
                      throws IllegalArgumentException
Create an IHistogram3D by subtracting two IHistogram3D.

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.
hist1 - The first member of the subtraction.
hist2 - The second member of the subtraction.
Returns:
The difference of the two IHistogram3D.
Throws:
IllegalArgumentException - if the two IHistogram3D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.

multiply

public IHistogram3D multiply(String path,
                             IHistogram3D hist1,
                             IHistogram3D hist2)
                      throws IllegalArgumentException
Create an IHistogram3D by multiplying two IHistogram3D.

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.
hist1 - The first member of the multiplication.
hist2 - The second member of the multiplication.
Returns:
The product of the two IHistogram3D.
Throws:
IllegalArgumentException - if the two IHistogram3D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.

divide

public IHistogram3D divide(String path,
                           IHistogram3D hist1,
                           IHistogram3D hist2)
                    throws IllegalArgumentException
Create an IHistogram3D by dividing two IHistogram3D.

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.
hist1 - The first member of the division.
hist2 - The second member of the division.
Returns:
The ration of the two IHistogram3D.
Throws:
IllegalArgumentException - if the two IHistogram3D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.

projectionX

public IHistogram1D projectionX(String path,
                                IHistogram2D hist)
                         throws IllegalArgumentException
Create an IHistogram1D by projecting an IHistogram2D along its x axis. This is equivalent to sliceX(UNDERFLOW_BIN,OVERFLOW_BIN).

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 IHistogram2D to be projected.
Returns:
The resulting projection.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

projectionY

public IHistogram1D projectionY(String path,
                                IHistogram2D hist)
                         throws IllegalArgumentException
Create an IHistogram1D by projecting an IHistogram2D along its y axis. This is equivalent to sliceY(UNDERFLOW_BIN,OVERFLOW_BIN).

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 IHistogram2D to be projected.
Returns:
The resulting projection.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

sliceX

public IHistogram1D sliceX(String path,
                           IHistogram2D hist,
                           int index)
                    throws IllegalArgumentException
Create an IHistogram1D by slicing an IHistogram2D parallel to the y axis at a given bin. This is equivalent to sliceX(indexY,indexY).

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 IHistogram2D to be sliced.
index - The index of the bin along the y axis where the IHistogram2D has to be sliced.
Returns:
The resulting slice.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal, or the indexes are illegal.

sliceY

public IHistogram1D sliceY(String path,
                           IHistogram2D hist,
                           int index)
                    throws IllegalArgumentException
Create an IHistogram1D by slicing an IHistogram2D parallel to the x axis at a given bin. This is equivalent to sliceY(indexX,indexX).

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 IHistogram2D to be sliced.
index - The index of the bin along the x axis where the IHistogram2D has to be sliced.
Returns:
The resulting slice.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal, or the indexes are illegal.

sliceX

public IHistogram1D sliceX(String path,
                           IHistogram2D hist,
                           int index1,
                           int index2)
                    throws IllegalArgumentException
Create an IHistogram1D by slicing an IHistogram2D parallel to the y axis between two bins (inclusive).

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 IHistogram2D to be sliced.
index1 - The index of the bin along the y axis that marks the lower edge of the slice.
index2 - The index of the bin along the y axis that marks the upper edge of the slice.
Returns:
The resulting slice.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal, or the indexes are illegal.

sliceY

public IHistogram1D sliceY(String path,
                           IHistogram2D hist,
                           int index1,
                           int index2)
                    throws IllegalArgumentException
Create an IHistogram1D by slicing an IHistogram2D parallel to the x axis between two bins (inclusive).

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 IHistogram2D to be sliced.
index1 - The index of the bin along the x axis that marks the lower edge of the slice.
index2 - The index of the bin along the x axis that marks the upper edge of the slice.
Returns:
The resulting slice.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal, or the indexes are illegal.

projectionXY

public IHistogram2D projectionXY(String path,
                                 IHistogram3D hist)
                          throws IllegalArgumentException
Create an IHistogram2D by projecting an IHistogram3D on the x-y plane. This is equivalent to sliceXY(UNDERFLOW_BIN,OVERFLOW_BIN).

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 projected.
Returns:
The resulting projection.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

projectionXZ

public IHistogram2D projectionXZ(String path,
                                 IHistogram3D hist)
                          throws IllegalArgumentException
Create an IHistogram2D by projecting an IHistogram3D on the x-z plane. This is equivalent to sliceXZ(UNDERFLOW_BIN,OVERFLOW_BIN).

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 projected.
Returns:
The resulting projection.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

projectionYZ

public IHistogram2D projectionYZ(String path,
                                 IHistogram3D hist)
                          throws IllegalArgumentException
Create an IHistogram2D by projecting an IHistogram3D on the y-z plane. This is equivalent to sliceYZ(UNDERFLOW_BIN,OVERFLOW_BIN).

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 projected.
Returns:
The resulting projection.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

sliceXY

public IHistogram2D sliceXY(String path,
                            IHistogram3D hist,
                            int index1,
                            int index2)
                     throws IllegalArgumentException
Create an IHistogram2D by slicing an IHistogram3D perpendicular to the Z axis, between "index1" and "index2" (inclusive). The X axis of the IHistogram2D corresponds to the X axis of this IHistogram3D. The Y axis of the IHistogram2D corresponds to the Y axis of this IHistogram3D.

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 sliced.
index1 - The index of the bin along the z axis that marks the lower edge of the slice.
index2 - The index of the bin along the z axis that marks the upper edge of the slice.
Returns:
The resulting slice.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal, or the indexes are illegal.

sliceXZ

public IHistogram2D sliceXZ(String path,
                            IHistogram3D hist,
                            int index1,
                            int index2)
                     throws IllegalArgumentException
Create an IHistogram2D by slicing an IHistogram3D perpendicular to the Y axis, between "index1" and "index2" (inclusive). The X axis of the IHistogram2D corresponds to the X axis of this IHistogram3D. The Z axis of the IHistogram2D corresponds to the Z axis of this IHistogram3D.

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 sliced.
index1 - The index of the bin along the y axis that marks the lower edge of the slice.
index2 - The index of the bin along the y axis that marks the upper edge of the slice.
Returns:
The resulting slice.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal, or the indexes are illegal.

sliceYZ

public IHistogram2D sliceYZ(String path,
                            IHistogram3D hist,
                            int index1,
                            int index2)
                     throws IllegalArgumentException
Create an IHistogram2D by slicing an IHistogram3D perpendicular to the X axis, between "index1" and "index2" (inclusive). The Y axis of the IHistogram2D corresponds to the Y axis of this IHistogram3D. The Z axis of the IHistogram2D corresponds to the Z axis of this IHistogram3D.

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 sliced.
index1 - The index of the bin along the x axis that marks the lower edge of the slice.
index2 - The index of the bin along the x axis that marks the upper edge of the slice.
Returns:
The resulting slice.
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal, or the indexes are illegal.
Overview  Package   Class  Tree  Deprecated  Index  Help 
AIDA API
Version 3.3
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2000-2004 AIDA Team, All Rights Reserved.