hep.aida
Interface IHistogramFactory
-
- All Known Implementing Classes:
- HistogramFactory
public interface IHistogramFactoryUser 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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description IHistogram1Dadd(java.lang.String path, IHistogram1D hist1, IHistogram1D hist2)Create an IHistogram1D by adding two IHistogram1D.IHistogram2Dadd(java.lang.String path, IHistogram2D hist1, IHistogram2D hist2)Create an IHistogram2D by adding two IHistogram2D.IHistogram3Dadd(java.lang.String path, IHistogram3D hist1, IHistogram3D hist2)Create an IHistogram3D by adding two IHistogram3D.ICloud1DcreateCloud1D(java.lang.String pathAndTitle)Create a ICloud1D, an unbinned 1-dimensional histogram.ICloud1DcreateCloud1D(java.lang.String path, java.lang.String title)Create a ICloud1D, an unbinned 1-dimensional histogram.ICloud1DcreateCloud1D(java.lang.String path, java.lang.String title, int nMax)Create a ICloud1D, an unbinned 1-dimensional histogram.ICloud1DcreateCloud1D(java.lang.String path, java.lang.String title, int nMax, java.lang.String options)Create a ICloud1D, an unbinned 1-dimensional histogram.ICloud2DcreateCloud2D(java.lang.String pathAndTitle)Create a ICloud2D, an unbinned 2-dimensional histogram.ICloud2DcreateCloud2D(java.lang.String path, java.lang.String title)Create a ICloud2D, an unbinned 2-dimensional histogram.ICloud2DcreateCloud2D(java.lang.String path, java.lang.String title, int nMax)Create a ICloud2D, an unbinned 2-dimensional histogram.ICloud2DcreateCloud2D(java.lang.String path, java.lang.String title, int nMax, java.lang.String options)Create a ICloud2D, an unbinned 2-dimensional histogram.ICloud3DcreateCloud3D(java.lang.String pathAndTitle)Create a ICloud3D, an unbinned 3-dimensional histogram.ICloud3DcreateCloud3D(java.lang.String path, java.lang.String title)Create a ICloud3D, an unbinned 3-dimensional histogram.ICloud3DcreateCloud3D(java.lang.String path, java.lang.String title, int nMax)Create a ICloud3D, an unbinned 3-dimensional histogram.ICloud3DcreateCloud3D(java.lang.String path, java.lang.String title, int nMax, java.lang.String options)Create a ICloud3D, an unbinned 3-dimensional histogram.ICloud1DcreateCopy(java.lang.String path, ICloud1D cloud)Create a copy of an ICloud1D.ICloud2DcreateCopy(java.lang.String path, ICloud2D cloud)Create a copy of an ICloud2D.ICloud3DcreateCopy(java.lang.String path, ICloud3D cloud)Create a copy of an ICloud3D.IHistogram1DcreateCopy(java.lang.String path, IHistogram1D hist)Create a copy of an IHistogram1D.IHistogram2DcreateCopy(java.lang.String copy, IHistogram2D hist)Create a copy of an IHistogram2D.IHistogram3DcreateCopy(java.lang.String path, IHistogram3D hist)Create a copy of an IHistogram3D.IProfile1DcreateCopy(java.lang.String path, IProfile1D profile)Create a copy of an IProfile1D.IProfile2DcreateCopy(java.lang.String path, IProfile2D profile)Create a copy of an IProfile2D.IHistogram1DcreateHistogram1D(java.lang.String pathAndTitle, int nBins, double lowerEdge, double upperEdge)Create a IHistogram1D.IHistogram1DcreateHistogram1D(java.lang.String path, java.lang.String title, double[] binEdges)Create a IHistogram1D.IHistogram1DcreateHistogram1D(java.lang.String path, java.lang.String title, double[] binEdges, java.lang.String options)Create a IHistogram1D.IHistogram1DcreateHistogram1D(java.lang.String path, java.lang.String title, int nBins, double lowerEdge, double upperEdge)Create a IHistogram1D.IHistogram1DcreateHistogram1D(java.lang.String path, java.lang.String title, int nBins, double lowerEdge, double upperEdge, java.lang.String options)Create a IHistogram1D.IHistogram2DcreateHistogram2D(java.lang.String pathAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY)Create a IHistogram2D.IHistogram2DcreateHistogram2D(java.lang.String path, java.lang.String title, double[] binEdgesX, double[] binEdgesY)Create a IHistogram2D.IHistogram2DcreateHistogram2D(java.lang.String path, java.lang.String title, double[] binEdgesX, double[] binEdgesY, java.lang.String options)Create a IHistogram2D.IHistogram2DcreateHistogram2D(java.lang.String path, java.lang.String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY)Create a IHistogram2D.IHistogram2DcreateHistogram2D(java.lang.String path, java.lang.String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, java.lang.String options)Create a IHistogram2D.IHistogram3DcreateHistogram3D(java.lang.String pathAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ)Create a IHistogram3D.IHistogram3DcreateHistogram3D(java.lang.String path, java.lang.String title, double[] binEdgesX, double[] binEdgesY, double[] binEdgesZ)Create a IHistogram3D.IHistogram3DcreateHistogram3D(java.lang.String path, java.lang.String title, double[] binEdgesX, double[] binEdgesY, double[] binEdgesZ, java.lang.String options)Create a IHistogram3D.IHistogram3DcreateHistogram3D(java.lang.String path, java.lang.String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ)Create a IHistogram3D.IHistogram3DcreateHistogram3D(java.lang.String path, java.lang.String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ, java.lang.String options)Create a IHistogram3D.IProfile1DcreateProfile1D(java.lang.String pathAndTitle, int nBins, double lowerEdge, double upperEdge)Create a IProfile1D.IProfile1DcreateProfile1D(java.lang.String pathAndTitle, int nBins, double lowerEdge, double upperEdge, double lowerValue, double upperValue)Create a IProfile1D.IProfile1DcreateProfile1D(java.lang.String path, java.lang.String title, double[] binEdges)Create a IProfile1D.IProfile1DcreateProfile1D(java.lang.String path, java.lang.String title, double[] binEdges, double lowerValue, double upperValue)Create a IProfile1D.IProfile1DcreateProfile1D(java.lang.String path, java.lang.String title, double[] binEdges, double lowerValue, double upperValue, java.lang.String options)Create a IProfile1D.IProfile1DcreateProfile1D(java.lang.String path, java.lang.String title, double[] binEdges, java.lang.String options)Create a IProfile1D.IProfile1DcreateProfile1D(java.lang.String path, java.lang.String title, int nBins, double lowerEdge, double upperEdge)Create a IProfile1D.IProfile1DcreateProfile1D(java.lang.String path, java.lang.String title, int nBins, double lowerEdge, double upperEdge, double lowerValue, double upperValue)Create a IProfile1D.IProfile1DcreateProfile1D(java.lang.String path, java.lang.String title, int nBins, double lowerEdge, double upperEdge, double lowerValue, double upperValue, java.lang.String options)Create a IProfile1D.IProfile1DcreateProfile1D(java.lang.String path, java.lang.String title, int nBins, double lowerEdge, double upperEdge, java.lang.String options)Create a IProfile1D.IProfile2DcreateProfile2D(java.lang.String pathAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY)Create a IProfile2D.IProfile2DcreateProfile2D(java.lang.String pathAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, double lowerValue, double upperValue)Create a IProfile2D.IProfile2DcreateProfile2D(java.lang.String path, java.lang.String title, double[] binEdgesX, double[] binEdgesY)Create a IProfile2D.IProfile2DcreateProfile2D(java.lang.String path, java.lang.String title, double[] binEdgesX, double[] binEdgesY, double lowerValue, double upperValue)Create a IProfile2D.IProfile2DcreateProfile2D(java.lang.String path, java.lang.String title, double[] binEdgesX, double[] binEdgesY, double lowerValue, double upperValue, java.lang.String options)Create a IProfile2D.IProfile2DcreateProfile2D(java.lang.String path, java.lang.String title, double[] binEdgesX, double[] binEdgesY, java.lang.String options)Create a IProfile2D.IProfile2DcreateProfile2D(java.lang.String path, java.lang.String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY)Create a IProfile2D.IProfile2DcreateProfile2D(java.lang.String path, java.lang.String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, double lowerValue, double upperValue)Create a IProfile2D.IProfile2DcreateProfile2D(java.lang.String path, java.lang.String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, double lowerValue, double upperValue, java.lang.String options)Create a IProfile2D.IProfile2DcreateProfile2D(java.lang.String path, java.lang.String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, java.lang.String options)Create a IProfile2D.voiddestroy(IBaseHistogram hist)Destroy an IBaseHistogram ogject.IHistogram1Ddivide(java.lang.String path, IHistogram1D hist1, IHistogram1D hist2)Create an IHistogram1D by dividing two IHistogram1D.IHistogram2Ddivide(java.lang.String path, IHistogram2D hist1, IHistogram2D hist2)Create an IHistogram2D by dividing two IHistogram2D.IHistogram3Ddivide(java.lang.String path, IHistogram3D hist1, IHistogram3D hist2)Create an IHistogram3D by dividing two IHistogram3D.IHistogram1Dmultiply(java.lang.String path, IHistogram1D hist1, IHistogram1D hist2)Create an IHistogram1D by multiplying two IHistogram1D.IHistogram2Dmultiply(java.lang.String path, IHistogram2D hist1, IHistogram2D hist2)Create an IHistogram2D by multiplying two IHistogram2D.IHistogram3Dmultiply(java.lang.String path, IHistogram3D hist1, IHistogram3D hist2)Create an IHistogram3D by multiplying two IHistogram3D.IHistogram1DprojectionX(java.lang.String path, IHistogram2D hist)Create an IHistogram1D by projecting an IHistogram2D along its x axis.IHistogram2DprojectionXY(java.lang.String path, IHistogram3D hist)Create an IHistogram2D by projecting an IHistogram3D on the x-y plane.IHistogram2DprojectionXZ(java.lang.String path, IHistogram3D hist)Create an IHistogram2D by projecting an IHistogram3D on the x-z plane.IHistogram1DprojectionY(java.lang.String path, IHistogram2D hist)Create an IHistogram1D by projecting an IHistogram2D along its y axis.IHistogram2DprojectionYZ(java.lang.String path, IHistogram3D hist)Create an IHistogram2D by projecting an IHistogram3D on the y-z plane.IHistogram1DsliceX(java.lang.String path, IHistogram2D hist, int index)Create an IHistogram1D by slicing an IHistogram2D parallel to the y axis at a given bin.IHistogram1DsliceX(java.lang.String path, IHistogram2D hist, int index1, int index2)Create an IHistogram1D by slicing an IHistogram2D parallel to the y axis between two bins (inclusive).IHistogram2DsliceXY(java.lang.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).IHistogram2DsliceXZ(java.lang.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).IHistogram1DsliceY(java.lang.String path, IHistogram2D hist, int index)Create an IHistogram1D by slicing an IHistogram2D parallel to the x axis at a given bin.IHistogram1DsliceY(java.lang.String path, IHistogram2D hist, int index1, int index2)Create an IHistogram1D by slicing an IHistogram2D parallel to the x axis between two bins (inclusive).IHistogram2DsliceYZ(java.lang.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).IHistogram1Dsubtract(java.lang.String path, IHistogram1D hist1, IHistogram1D hist2)Create an IHistogram1D by subtracting two IHistogram1D.IHistogram2Dsubtract(java.lang.String path, IHistogram2D hist1, IHistogram2D hist2)Create an IHistogram2D by subtracting two IHistogram2D.IHistogram3Dsubtract(java.lang.String path, IHistogram3D hist1, IHistogram3D hist2)Create an IHistogram3D by subtracting two IHistogram3D.
-
-
-
Method Detail
-
destroy
void destroy(IBaseHistogram hist) throws java.lang.IllegalArgumentException
Destroy an IBaseHistogram ogject.- Parameters:
hist- The IBaseHistogram to be destroyed.- Throws:
java.lang.IllegalArgumentException- If the histogram cannot be destroyed.
-
createCloud1D
ICloud1D createCloud1D(java.lang.String path, java.lang.String title) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCloud1D
ICloud1D createCloud1D(java.lang.String path, java.lang.String title, int nMax) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCloud1D
ICloud1D createCloud1D(java.lang.String path, java.lang.String title, int nMax, java.lang.String options) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCloud1D
ICloud1D createCloud1D(java.lang.String pathAndTitle) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCopy
ICloud1D createCopy(java.lang.String path, ICloud1D cloud) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCloud2D
ICloud2D createCloud2D(java.lang.String path, java.lang.String title) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCloud2D
ICloud2D createCloud2D(java.lang.String path, java.lang.String title, int nMax) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCloud2D
ICloud2D createCloud2D(java.lang.String path, java.lang.String title, int nMax, java.lang.String options) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCloud2D
ICloud2D createCloud2D(java.lang.String pathAndTitle) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCopy
ICloud2D createCopy(java.lang.String path, ICloud2D cloud) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCloud3D
ICloud3D createCloud3D(java.lang.String path, java.lang.String title) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCloud3D
ICloud3D createCloud3D(java.lang.String path, java.lang.String title, int nMax) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCloud3D
ICloud3D createCloud3D(java.lang.String path, java.lang.String title, int nMax, java.lang.String options) throws java.lang.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 autoconversionoptions- 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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCloud3D
ICloud3D createCloud3D(java.lang.String pathAndTitle) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCopy
ICloud3D createCopy(java.lang.String path, ICloud3D cloud) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createHistogram1D
IHistogram1D createHistogram1D(java.lang.String path, java.lang.String title, int nBins, double lowerEdge, double upperEdge) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createHistogram1D
IHistogram1D createHistogram1D(java.lang.String path, java.lang.String title, int nBins, double lowerEdge, double upperEdge, java.lang.String options) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createHistogram1D
IHistogram1D createHistogram1D(java.lang.String pathAndTitle, int nBins, double lowerEdge, double upperEdge) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createHistogram1D
IHistogram1D createHistogram1D(java.lang.String path, java.lang.String title, double[] binEdges) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createHistogram1D
IHistogram1D createHistogram1D(java.lang.String path, java.lang.String title, double[] binEdges, java.lang.String options) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCopy
IHistogram1D createCopy(java.lang.String path, IHistogram1D hist) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createHistogram2D
IHistogram2D createHistogram2D(java.lang.String path, java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createHistogram2D
IHistogram2D createHistogram2D(java.lang.String path, java.lang.String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createHistogram2D
IHistogram2D createHistogram2D(java.lang.String pathAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createHistogram2D
IHistogram2D createHistogram2D(java.lang.String path, java.lang.String title, double[] binEdgesX, double[] binEdgesY) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createHistogram2D
IHistogram2D createHistogram2D(java.lang.String path, java.lang.String title, double[] binEdgesX, double[] binEdgesY, java.lang.String options) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCopy
IHistogram2D createCopy(java.lang.String copy, IHistogram2D hist) throws java.lang.IllegalArgumentException
Create a copy of an 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.hist- The IHistogram2D to be copied.- Returns:
- The copy of the IHistogram2D.
- Throws:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createHistogram3D
IHistogram3D createHistogram3D(java.lang.String path, java.lang.String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createHistogram3D
IHistogram3D createHistogram3D(java.lang.String path, java.lang.String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ, java.lang.String options) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createHistogram3D
IHistogram3D createHistogram3D(java.lang.String pathAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createHistogram3D
IHistogram3D createHistogram3D(java.lang.String path, java.lang.String title, double[] binEdgesX, double[] binEdgesY, double[] binEdgesZ) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createHistogram3D
IHistogram3D createHistogram3D(java.lang.String path, java.lang.String title, double[] binEdgesX, double[] binEdgesY, double[] binEdgesZ, java.lang.String options) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCopy
IHistogram3D createCopy(java.lang.String path, IHistogram3D hist) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile1D
IProfile1D createProfile1D(java.lang.String path, java.lang.String title, int nBins, double lowerEdge, double upperEdge) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile1D
IProfile1D createProfile1D(java.lang.String path, java.lang.String title, int nBins, double lowerEdge, double upperEdge, java.lang.String options) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile1D
IProfile1D createProfile1D(java.lang.String path, java.lang.String title, int nBins, double lowerEdge, double upperEdge, double lowerValue, double upperValue) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile1D
IProfile1D createProfile1D(java.lang.String path, java.lang.String title, int nBins, double lowerEdge, double upperEdge, double lowerValue, double upperValue, java.lang.String options) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile1D
IProfile1D createProfile1D(java.lang.String path, java.lang.String title, double[] binEdges) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile1D
IProfile1D createProfile1D(java.lang.String path, java.lang.String title, double[] binEdges, java.lang.String options) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile1D
IProfile1D createProfile1D(java.lang.String path, java.lang.String title, double[] binEdges, double lowerValue, double upperValue) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile1D
IProfile1D createProfile1D(java.lang.String path, java.lang.String title, double[] binEdges, double lowerValue, double upperValue, java.lang.String options) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile1D
IProfile1D createProfile1D(java.lang.String pathAndTitle, int nBins, double lowerEdge, double upperEdge) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile1D
IProfile1D createProfile1D(java.lang.String pathAndTitle, int nBins, double lowerEdge, double upperEdge, double lowerValue, double upperValue) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCopy
IProfile1D createCopy(java.lang.String path, IProfile1D profile) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile2D
IProfile2D createProfile2D(java.lang.String path, java.lang.String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile2D
IProfile2D createProfile2D(java.lang.String path, java.lang.String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, java.lang.String options) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile2D
IProfile2D createProfile2D(java.lang.String path, java.lang.String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, double lowerValue, double upperValue) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile2D
IProfile2D createProfile2D(java.lang.String path, java.lang.String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, double lowerValue, double upperValue, java.lang.String options) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile2D
IProfile2D createProfile2D(java.lang.String path, java.lang.String title, double[] binEdgesX, double[] binEdgesY) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile2D
IProfile2D createProfile2D(java.lang.String path, java.lang.String title, double[] binEdgesX, double[] binEdgesY, java.lang.String options) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile2D
IProfile2D createProfile2D(java.lang.String path, java.lang.String title, double[] binEdgesX, double[] binEdgesY, double lowerValue, double upperValue) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile2D
IProfile2D createProfile2D(java.lang.String path, java.lang.String title, double[] binEdgesX, double[] binEdgesY, double lowerValue, double upperValue, java.lang.String options) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile2D
IProfile2D createProfile2D(java.lang.String pathAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createProfile2D
IProfile2D createProfile2D(java.lang.String pathAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, double lowerValue, double upperValue) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
createCopy
IProfile2D createCopy(java.lang.String path, IProfile2D profile) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
add
IHistogram1D add(java.lang.String path, IHistogram1D hist1, IHistogram1D hist2) throws java.lang.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:
java.lang.IllegalArgumentException- if the two IHistogram1D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.
-
subtract
IHistogram1D subtract(java.lang.String path, IHistogram1D hist1, IHistogram1D hist2) throws java.lang.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:
java.lang.IllegalArgumentException- if the two IHistogram1D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.
-
multiply
IHistogram1D multiply(java.lang.String path, IHistogram1D hist1, IHistogram1D hist2) throws java.lang.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:
java.lang.IllegalArgumentException- if the two IHistogram1D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.
-
divide
IHistogram1D divide(java.lang.String path, IHistogram1D hist1, IHistogram1D hist2) throws java.lang.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:
java.lang.IllegalArgumentException- if the two IHistogram1D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.
-
add
IHistogram2D add(java.lang.String path, IHistogram2D hist1, IHistogram2D hist2) throws java.lang.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:
java.lang.IllegalArgumentException- if the two IHistogram2D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.
-
subtract
IHistogram2D subtract(java.lang.String path, IHistogram2D hist1, IHistogram2D hist2) throws java.lang.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:
java.lang.IllegalArgumentException- if the two IHistogram2D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.
-
multiply
IHistogram2D multiply(java.lang.String path, IHistogram2D hist1, IHistogram2D hist2) throws java.lang.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:
java.lang.IllegalArgumentException- if the two IHistogram2D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.
-
divide
IHistogram2D divide(java.lang.String path, IHistogram2D hist1, IHistogram2D hist2) throws java.lang.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:
java.lang.IllegalArgumentException- if the two IHistogram2D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.
-
add
IHistogram3D add(java.lang.String path, IHistogram3D hist1, IHistogram3D hist2) throws java.lang.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:
java.lang.IllegalArgumentException- if the two IHistogram3D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.
-
subtract
IHistogram3D subtract(java.lang.String path, IHistogram3D hist1, IHistogram3D hist2) throws java.lang.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:
java.lang.IllegalArgumentException- if the two IHistogram3D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.
-
multiply
IHistogram3D multiply(java.lang.String path, IHistogram3D hist1, IHistogram3D hist2) throws java.lang.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:
java.lang.IllegalArgumentException- if the two IHistogram3D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.
-
divide
IHistogram3D divide(java.lang.String path, IHistogram3D hist1, IHistogram3D hist2) throws java.lang.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:
java.lang.IllegalArgumentException- if the two IHistogram3D have incompatible binning, or if a directory in the path does not exist, or the path is illegal.
-
projectionX
IHistogram1D projectionX(java.lang.String path, IHistogram2D hist) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
projectionY
IHistogram1D projectionY(java.lang.String path, IHistogram2D hist) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
sliceX
IHistogram1D sliceX(java.lang.String path, IHistogram2D hist, int index) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal, or the indexes are illegal.
-
sliceY
IHistogram1D sliceY(java.lang.String path, IHistogram2D hist, int index) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal, or the indexes are illegal.
-
sliceX
IHistogram1D sliceX(java.lang.String path, IHistogram2D hist, int index1, int index2) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal, or the indexes are illegal.
-
sliceY
IHistogram1D sliceY(java.lang.String path, IHistogram2D hist, int index1, int index2) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal, or the indexes are illegal.
-
projectionXY
IHistogram2D projectionXY(java.lang.String path, IHistogram3D hist) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
projectionXZ
IHistogram2D projectionXZ(java.lang.String path, IHistogram3D hist) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
projectionYZ
IHistogram2D projectionYZ(java.lang.String path, IHistogram3D hist) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal.
-
sliceXY
IHistogram2D sliceXY(java.lang.String path, IHistogram3D hist, int index1, int index2) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal, or the indexes are illegal.
-
sliceXZ
IHistogram2D sliceXZ(java.lang.String path, IHistogram3D hist, int index1, int index2) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal, or the indexes are illegal.
-
sliceYZ
IHistogram2D sliceYZ(java.lang.String path, IHistogram3D hist, int index1, int index2) throws java.lang.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:
java.lang.IllegalArgumentException- if a directory in the path does not exist, or the path is illegal, or the indexes are illegal.
-
-
DMelt 3.0 © DataMelt by jWork.ORG