RAIDA  1.9.0
Public Member Functions | List of all members
AIDA::IHistogramFactory Class Referenceabstract

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

#include <IHistogramFactory.h>

Inheritance diagram for AIDA::IHistogramFactory:
AIDA::IHistogramFactoryROOT

Public Member Functions

virtual ~IHistogramFactory ()
 Destructor.
 
virtual bool destroy (IBaseHistogram *hist)=0
 Destroy an IBaseHistogram ogject. More...
 
virtual ICloud1DcreateCloud1D (const std::string &path, const std::string &title, int nMax=-1, const std::string &options="")=0
 Create a ICloud1D, an unbinned 1-dimensional histogram. More...
 
virtual ICloud1DcreateCloud1D (const std::string &pathAndTitle)=0
 Create a ICloud1D, an unbinned 1-dimensional histogram. More...
 
virtual ICloud1DcreateCopy (const std::string &path, const ICloud1D &cloud)=0
 Create a copy of an ICloud1D. More...
 
virtual ICloud2DcreateCloud2D (const std::string &path, const std::string &title, int nMax=-1, const std::string &options="")=0
 Create a ICloud2D, an unbinned 2-dimensional histogram. More...
 
virtual ICloud2DcreateCloud2D (const std::string &pathAndTitle)=0
 Create a ICloud2D, an unbinned 2-dimensional histogram. More...
 
virtual ICloud2DcreateCopy (const std::string &path, const ICloud2D &cloud)=0
 Create a copy of an ICloud2D. More...
 
virtual ICloud3DcreateCloud3D (const std::string &path, const std::string &title, int nMax=-1, const std::string &options="")=0
 Create a ICloud3D, an unbinned 3-dimensional histogram. More...
 
virtual ICloud3DcreateCloud3D (const std::string &pathAndTitle)=0
 Create a ICloud3D, an unbinned 3-dimensional histogram. More...
 
virtual ICloud3DcreateCopy (const std::string &path, const ICloud3D &cloud)=0
 Create a copy of an ICloud3D. More...
 
virtual IHistogram1DcreateHistogram1D (const std::string &path, const std::string &title, int nBins, double lowerEdge, double upperEdge, const std::string &options="")=0
 Create a IHistogram1D. More...
 
virtual IHistogram1DcreateHistogram1D (const std::string &pathAndTitle, int nBins, double lowerEdge, double upperEdge)=0
 Create a IHistogram1D. More...
 
virtual IHistogram1DcreateHistogram1D (const std::string &path, const std::string &title, const std::vector< double > &binEdges, const std::string &options="")=0
 Create a IHistogram1D. More...
 
virtual IHistogram1DcreateCopy (const std::string &path, const IHistogram1D &hist)=0
 Create a copy of an IHistogram1D. More...
 
virtual IHistogram2DcreateHistogram2D (const std::string &path, const std::string &title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, const std::string &options="")=0
 Create a IHistogram2D. More...
 
virtual IHistogram2DcreateHistogram2D (const std::string &pathAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY)=0
 Create a IHistogram2D. More...
 
virtual IHistogram2DcreateHistogram2D (const std::string &path, const std::string &title, const std::vector< double > &binEdgesX, const std::vector< double > &binEdgesY, const std::string &options="")=0
 Create a IHistogram2D. More...
 
virtual IHistogram2DcreateCopy (const std::string &path, const IHistogram2D &hist)=0
 Create a copy of an IHistogram2D. More...
 
virtual IHistogram3DcreateHistogram3D (const std::string &path, const std::string &title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ, const std::string &options="")=0
 Create a IHistogram3D. More...
 
virtual IHistogram3DcreateHistogram3D (const std::string &pathAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ)=0
 Create a IHistogram3D. More...
 
virtual IHistogram3DcreateHistogram3D (const std::string &path, const std::string &title, const std::vector< double > &binEdgesX, const std::vector< double > &binEdgesY, const std::vector< double > &binEdgesZ, const std::string &options="")=0
 Create a IHistogram3D. More...
 
virtual IHistogram3DcreateCopy (const std::string &path, const IHistogram3D &hist)=0
 Create a copy of an IHistogram3D. More...
 
virtual IProfile1DcreateProfile1D (const std::string &path, const std::string &title, int nBins, double lowerEdge, double upperEdge, const std::string &options="")=0
 Create a IProfile1D. More...
 
virtual IProfile1DcreateProfile1D (const std::string &path, const std::string &title, int nBins, double lowerEdge, double upperEdge, double lowerValue, double upperValue, const std::string &options="")=0
 Create a IProfile1D. More...
 
virtual IProfile1DcreateProfile1D (const std::string &path, const std::string &title, const std::vector< double > &binEdges, const std::string &options="")=0
 Create a IProfile1D. More...
 
virtual IProfile1DcreateProfile1D (const std::string &path, const std::string &title, const std::vector< double > &binEdges, double lowerValue, double upperValue, const std::string &options="")=0
 Create a IProfile1D. More...
 
virtual IProfile1DcreateProfile1D (const std::string &pathAndTitle, int nBins, double lowerEdge, double upperEdge)=0
 Create a IProfile1D. More...
 
virtual IProfile1DcreateProfile1D (const std::string &pathAndTitle, int nBins, double lowerEdge, double upperEdge, double lowerValue, double upperValue)=0
 Create a IProfile1D. More...
 
virtual IProfile1DcreateCopy (const std::string &path, const IProfile1D &profile)=0
 Create a copy of an IProfile1D. More...
 
virtual IProfile2DcreateProfile2D (const std::string &path, const std::string &title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, const std::string &options="")=0
 Create a IProfile2D. More...
 
virtual IProfile2DcreateProfile2D (const std::string &path, const std::string &title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, double lowerValue, double upperValue, const std::string &options="")=0
 Create a IProfile2D. More...
 
virtual IProfile2DcreateProfile2D (const std::string &path, const std::string &title, const std::vector< double > &binEdgesX, const std::vector< double > &binEdgesY, const std::string &options="")=0
 Create a IProfile2D. More...
 
virtual IProfile2DcreateProfile2D (const std::string &path, const std::string &title, const std::vector< double > &binEdgesX, const std::vector< double > &binEdgesY, double lowerValue, double upperValue, const std::string &options="")=0
 Create a IProfile2D. More...
 
virtual IProfile2DcreateProfile2D (const std::string &pathAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY)=0
 Create a IProfile2D. More...
 
virtual IProfile2DcreateProfile2D (const std::string &pathAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, double lowerValue, double upperValue)=0
 Create a IProfile2D. More...
 
virtual IProfile2DcreateCopy (const std::string &path, const IProfile2D &profile)=0
 Create a copy of an IProfile2D. More...
 
virtual IHistogram1Dadd (const std::string &path, const IHistogram1D &hist1, const IHistogram1D &hist2)=0
 Create an IHistogram1D by adding two IHistogram1D. More...
 
virtual IHistogram1Dsubtract (const std::string &path, const IHistogram1D &hist1, const IHistogram1D &hist2)=0
 Create an IHistogram1D by subtracting two IHistogram1D. More...
 
virtual IHistogram1Dmultiply (const std::string &path, const IHistogram1D &hist1, const IHistogram1D &hist2)=0
 Create an IHistogram1D by multiplying two IHistogram1D. More...
 
virtual IHistogram1Ddivide (const std::string &path, const IHistogram1D &hist1, const IHistogram1D &hist2)=0
 Create an IHistogram1D by dividing two IHistogram1D. More...
 
virtual IHistogram2Dadd (const std::string &path, const IHistogram2D &hist1, const IHistogram2D &hist2)=0
 Create an IHistogram2D by adding two IHistogram2D. More...
 
virtual IHistogram2Dsubtract (const std::string &path, const IHistogram2D &hist1, const IHistogram2D &hist2)=0
 Create an IHistogram2D by subtracting two IHistogram2D. More...
 
virtual IHistogram2Dmultiply (const std::string &path, const IHistogram2D &hist1, const IHistogram2D &hist2)=0
 Create an IHistogram2D by multiplying two IHistogram2D. More...
 
virtual IHistogram2Ddivide (const std::string &path, const IHistogram2D &hist1, const IHistogram2D &hist2)=0
 Create an IHistogram2D by dividing two IHistogram2D. More...
 
virtual IHistogram3Dadd (const std::string &path, const IHistogram3D &hist1, const IHistogram3D &hist2)=0
 Create an IHistogram3D by adding two IHistogram3D. More...
 
virtual IHistogram3Dsubtract (const std::string &path, const IHistogram3D &hist1, const IHistogram3D &hist2)=0
 Create an IHistogram3D by subtracting two IHistogram3D. More...
 
virtual IHistogram3Dmultiply (const std::string &path, const IHistogram3D &hist1, const IHistogram3D &hist2)=0
 Create an IHistogram3D by multiplying two IHistogram3D. More...
 
virtual IHistogram3Ddivide (const std::string &path, const IHistogram3D &hist1, const IHistogram3D &hist2)=0
 Create an IHistogram3D by dividing two IHistogram3D. More...
 
virtual IHistogram1DprojectionX (const std::string &path, const IHistogram2D &hist)=0
 Create an IHistogram1D by projecting an IHistogram2D along its x axis. More...
 
virtual IHistogram1DprojectionY (const std::string &path, const IHistogram2D &hist)=0
 Create an IHistogram1D by projecting an IHistogram2D along its y axis. More...
 
virtual IHistogram1DsliceX (const std::string &path, const IHistogram2D &hist, int index)=0
 Create an IHistogram1D by slicing an IHistogram2D parallel to the y axis at a given bin. More...
 
virtual IHistogram1DsliceY (const std::string &path, const IHistogram2D &hist, int index)=0
 Create an IHistogram1D by slicing an IHistogram2D parallel to the x axis at a given bin. More...
 
virtual IHistogram1DsliceX (const std::string &path, const IHistogram2D &hist, int index1, int index2)=0
 Create an IHistogram1D by slicing an IHistogram2D parallel to the y axis between two bins (inclusive). More...
 
virtual IHistogram1DsliceY (const std::string &path, const IHistogram2D &hist, int index1, int index2)=0
 Create an IHistogram1D by slicing an IHistogram2D parallel to the x axis between two bins (inclusive). More...
 
virtual IHistogram2DprojectionXY (const std::string &path, const IHistogram3D &hist)=0
 Create an IHistogram2D by projecting an IHistogram3D on the x-y plane. More...
 
virtual IHistogram2DprojectionXZ (const std::string &path, const IHistogram3D &hist)=0
 Create an IHistogram2D by projecting an IHistogram3D on the x-z plane. More...
 
virtual IHistogram2DprojectionYZ (const std::string &path, const IHistogram3D &hist)=0
 Create an IHistogram2D by projecting an IHistogram3D on the y-z plane. More...
 
virtual IHistogram2DsliceXY (const std::string &path, const IHistogram3D &hist, int index1, int index2)=0
 Create an IHistogram2D by slicing an IHistogram3D perpendicular to the Z axis, between "index1" and "index2" (inclusive). More...
 
virtual IHistogram2DsliceXZ (const std::string &path, const IHistogram3D &hist, int index1, int index2)=0
 Create an IHistogram2D by slicing an IHistogram3D perpendicular to the Y axis, between "index1" and "index2" (inclusive). More...
 
virtual IHistogram2DsliceYZ (const std::string &path, const IHistogram3D &hist, int index1, int index2)=0
 Create an IHistogram2D by slicing an IHistogram3D perpendicular to the X axis, between "index1" and "index2" (inclusive). More...
 

Detailed Description

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

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

Member Function Documentation

virtual IHistogram1D* AIDA::IHistogramFactory::add ( const std::string &  path,
const IHistogram1D hist1,
const IHistogram1D hist2 
)
pure virtual

Create an IHistogram1D by adding two IHistogram1D.

Parameters
pathThe 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.
hist1The first member of the addition.
hist2The second member of the addition.
Returns
The sum of the two IHistogram1D. if a directory in the path does not exist, or the path is illegal.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram2D* AIDA::IHistogramFactory::add ( const std::string &  path,
const IHistogram2D hist1,
const IHistogram2D hist2 
)
pure virtual

Create an IHistogram2D by adding two IHistogram2D.

Parameters
pathThe 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.
hist1The first member of the addition.
hist2The second member of the addition.
Returns
The sum of the two IHistogram2D. if a directory in the path does not exist, or the path is illegal.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram3D* AIDA::IHistogramFactory::add ( const std::string &  path,
const IHistogram3D hist1,
const IHistogram3D hist2 
)
pure virtual

Create an IHistogram3D by adding two IHistogram3D.

Parameters
pathThe 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.
hist1The first member of the addition.
hist2The second member of the addition.
Returns
The sum of the two IHistogram3D. if a directory in the path does not exist, or the path is illegal.

Implemented in AIDA::IHistogramFactoryROOT.

virtual ICloud1D* AIDA::IHistogramFactory::createCloud1D ( const std::string &  path,
const std::string &  title,
int  nMax = -1,
const std::string &  options = "" 
)
pure virtual

Create a ICloud1D, an unbinned 1-dimensional histogram.

Parameters
pathThe 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.
titleThe title of the ICloud1D.
nMaxThe maximum number of entries after which the ICloud1D will convert to an IHistogram1D. The default nMax = -1 means no autoconversion.
optionsThe options for the ICloud1D. "autoconvert=true" to enable autoconversion to an IHistogram1D.
Returns
The newly created ICloud1D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual ICloud1D* AIDA::IHistogramFactory::createCloud1D ( const std::string &  pathAndTitle)
pure virtual

Create a ICloud1D, an unbinned 1-dimensional histogram.

Parameters
pathAndTitleThe 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.

Implemented in AIDA::IHistogramFactoryROOT.

virtual ICloud2D* AIDA::IHistogramFactory::createCloud2D ( const std::string &  path,
const std::string &  title,
int  nMax = -1,
const std::string &  options = "" 
)
pure virtual

Create a ICloud2D, an unbinned 2-dimensional histogram.

Parameters
pathThe 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.
titleThe title of the ICloud2D.
nMaxThe maximum number of entries after which the ICloud2D will convert to an IHistogram2D. The default nMax = -1 means no autoconversion.
optionsThe options for the ICloud2D. "autoconvert=true" to enable autoconversion to an IHistogram2D.
Returns
The newly created ICloud2D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual ICloud2D* AIDA::IHistogramFactory::createCloud2D ( const std::string &  pathAndTitle)
pure virtual

Create a ICloud2D, an unbinned 2-dimensional histogram.

Parameters
pathAndTitleThe 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.

Implemented in AIDA::IHistogramFactoryROOT.

virtual ICloud3D* AIDA::IHistogramFactory::createCloud3D ( const std::string &  path,
const std::string &  title,
int  nMax = -1,
const std::string &  options = "" 
)
pure virtual

Create a ICloud3D, an unbinned 3-dimensional histogram.

Parameters
pathThe 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.
titleThe title of the ICloud3D.
nMaxThe maximum number of entries after which the ICloud3D will convert to an IHistogram3D. The default nMax = -1 means no autoconversion
optionsThe options for the ICloud3D. "autoconvert=true" to enable autoconversion to an IHistogram3D.
Returns
The newly created ICloud3D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual ICloud3D* AIDA::IHistogramFactory::createCloud3D ( const std::string &  pathAndTitle)
pure virtual

Create a ICloud3D, an unbinned 3-dimensional histogram.

Parameters
pathAndTitleThe 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.

Implemented in AIDA::IHistogramFactoryROOT.

virtual ICloud1D* AIDA::IHistogramFactory::createCopy ( const std::string &  path,
const ICloud1D cloud 
)
pure virtual

Create a copy of an ICloud1D.

Parameters
pathThe 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.
cloudThe ICloud1D to be copied.
Returns
The copy of the ICloud1D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual ICloud2D* AIDA::IHistogramFactory::createCopy ( const std::string &  path,
const ICloud2D cloud 
)
pure virtual

Create a copy of an ICloud2D.

Parameters
pathThe 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.
cloudThe ICloud2D to be copied.
Returns
The copy of the ICloud2D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual ICloud3D* AIDA::IHistogramFactory::createCopy ( const std::string &  path,
const ICloud3D cloud 
)
pure virtual

Create a copy of an ICloud3D.

Parameters
pathThe 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.
cloudThe ICloud3D to be copied.
Returns
The copy of the ICloud3D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram1D* AIDA::IHistogramFactory::createCopy ( const std::string &  path,
const IHistogram1D hist 
)
pure virtual

Create a copy of an IHistogram1D.

Parameters
pathThe 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.
histThe IHistogram1D to be copied.
Returns
The copy of the IHistogram1D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram2D* AIDA::IHistogramFactory::createCopy ( const std::string &  path,
const IHistogram2D hist 
)
pure virtual

Create a copy of an IHistogram2D.

Parameters
pathThe 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.
histThe IHistogram2D to be copied.
Returns
The copy of the IHistogram2D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram3D* AIDA::IHistogramFactory::createCopy ( const std::string &  path,
const IHistogram3D hist 
)
pure virtual

Create a copy of an IHistogram3D.

Parameters
pathThe 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.
histThe IHistogram3D to be copied.
Returns
The copy of the IHistogram3D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IProfile1D* AIDA::IHistogramFactory::createCopy ( const std::string &  path,
const IProfile1D profile 
)
pure virtual

Create a copy of an IProfile1D.

Parameters
pathThe 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.
profileThe IProfile1D to be copied.
Returns
The copy of the IProfile1D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IProfile2D* AIDA::IHistogramFactory::createCopy ( const std::string &  path,
const IProfile2D profile 
)
pure virtual

Create a copy of an IProfile2D.

Parameters
pathThe 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.
profileThe IProfile2D to be copied.
Returns
The copy of the IProfile2D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram1D* AIDA::IHistogramFactory::createHistogram1D ( const std::string &  path,
const std::string &  title,
int  nBins,
double  lowerEdge,
double  upperEdge,
const std::string &  options = "" 
)
pure virtual

Create a IHistogram1D.

Parameters
pathThe 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.
titleThe title of the IHistogram1D.
nBinsThe number of bins of the x axis.
lowerEdgeThe lower edge of the x axis.
upperEdgeThe upper edge of the x axis.
optionsThe options for the IHistogram1D. The default is "". "type=efficiency" for an efficiency IHistogram1D.
Returns
The newly created IHistogram1D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram1D* AIDA::IHistogramFactory::createHistogram1D ( const std::string &  pathAndTitle,
int  nBins,
double  lowerEdge,
double  upperEdge 
)
pure virtual

Create a IHistogram1D.

Parameters
pathAndTitleThe 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.
nBinsThe number of bins of the x axis.
lowerEdgeThe lower edge of the x axis.
upperEdgeThe upper edge of the x axis.
Returns
The newly created IHistogram1D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram1D* AIDA::IHistogramFactory::createHistogram1D ( const std::string &  path,
const std::string &  title,
const std::vector< double > &  binEdges,
const std::string &  options = "" 
)
pure virtual

Create a IHistogram1D.

Parameters
pathThe 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.
titleThe title of the IHistogram1D.
binEdgesThe array of the bin edges for the x axis.
optionsThe options for the IHistogram1D. The default is "". "type=efficiency" for an efficiency IHistogram1D.
Returns
The newly created IHistogram1D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram2D* AIDA::IHistogramFactory::createHistogram2D ( const std::string &  path,
const std::string &  title,
int  nBinsX,
double  lowerEdgeX,
double  upperEdgeX,
int  nBinsY,
double  lowerEdgeY,
double  upperEdgeY,
const std::string &  options = "" 
)
pure virtual

Create a IHistogram2D.

Parameters
pathThe 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.
titleThe title of the IHistogram2D.
nBinsXThe number of bins of the x axis.
lowerEdgeXThe lower edge of the x axis.
upperEdgeXThe upper edge of the x axis.
nBinsYThe number of bins of the y axis.
lowerEdgeYThe lower edge of the y axis.
upperEdgeYThe upper edge of the y axis.
optionsThe options for the IHistogram2D. The default is "". "type=efficiency" for an efficiency IHistogram2D.
Returns
The newly created IHistogram2D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram2D* AIDA::IHistogramFactory::createHistogram2D ( const std::string &  pathAndTitle,
int  nBinsX,
double  lowerEdgeX,
double  upperEdgeX,
int  nBinsY,
double  lowerEdgeY,
double  upperEdgeY 
)
pure virtual

Create a IHistogram2D.

Parameters
pathAndTitleThe 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.
nBinsXThe number of bins of the x axis.
lowerEdgeXThe lower edge of the x axis.
upperEdgeXThe upper edge of the x axis.
nBinsYThe number of bins of the y axis.
lowerEdgeYThe lower edge of the y axis.
upperEdgeYThe upper edge of the y axis.
Returns
The newly created IHistogram2D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram2D* AIDA::IHistogramFactory::createHistogram2D ( const std::string &  path,
const std::string &  title,
const std::vector< double > &  binEdgesX,
const std::vector< double > &  binEdgesY,
const std::string &  options = "" 
)
pure virtual

Create a IHistogram2D.

Parameters
pathThe 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.
titleThe title of the IHistogram2D.
binEdgesXThe array of the bin edges for the x axis.
binEdgesYThe array of the bin edges for the y axis.
optionsThe options for the IHistogram2D. The default is "". "type=efficiency" for an efficiency IHistogram2D.
Returns
The newly created IHistogram2D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram3D* AIDA::IHistogramFactory::createHistogram3D ( const std::string &  path,
const std::string &  title,
int  nBinsX,
double  lowerEdgeX,
double  upperEdgeX,
int  nBinsY,
double  lowerEdgeY,
double  upperEdgeY,
int  nBinsZ,
double  lowerEdgeZ,
double  upperEdgeZ,
const std::string &  options = "" 
)
pure virtual

Create a IHistogram3D.

Parameters
pathThe 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.
titleThe title of the IHistogram3D.
nBinsXThe number of bins of the x axis.
lowerEdgeXThe lower edge of the x axis.
upperEdgeXThe upper edge of the x axis.
nBinsYThe number of bins of the y axis.
lowerEdgeYThe lower edge of the y axis.
upperEdgeYThe upper edge of the y axis.
nBinsZThe number of bins of the z axis.
lowerEdgeZThe lower edge of the z axis.
upperEdgeZThe upper edge of the z axis.
optionsThe options for the IHistogram3D. The default is "". "type=efficiency" for an efficiency IHistogram3D.
Returns
The newly created IHistogram3D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram3D* AIDA::IHistogramFactory::createHistogram3D ( const std::string &  pathAndTitle,
int  nBinsX,
double  lowerEdgeX,
double  upperEdgeX,
int  nBinsY,
double  lowerEdgeY,
double  upperEdgeY,
int  nBinsZ,
double  lowerEdgeZ,
double  upperEdgeZ 
)
pure virtual

Create a IHistogram3D.

Parameters
pathAndTitleThe 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.
nBinsXThe number of bins of the x axis.
lowerEdgeXThe lower edge of the x axis.
upperEdgeXThe upper edge of the x axis.
nBinsYThe number of bins of the y axis.
lowerEdgeYThe lower edge of the y axis.
upperEdgeYThe upper edge of the y axis.
nBinsZThe number of bins of the z axis.
lowerEdgeZThe lower edge of the z axis.
upperEdgeZThe upper edge of the z axis.
Returns
The newly created IHistogram3D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram3D* AIDA::IHistogramFactory::createHistogram3D ( const std::string &  path,
const std::string &  title,
const std::vector< double > &  binEdgesX,
const std::vector< double > &  binEdgesY,
const std::vector< double > &  binEdgesZ,
const std::string &  options = "" 
)
pure virtual

Create a IHistogram3D.

Parameters
pathThe 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.
titleThe title of the IHistogram3D.
binEdgesXThe array of the bin edges for the x axis.
binEdgesYThe array of the bin edges for the y axis.
binEdgesZThe array of the bin edges for the z axis.
optionsThe options for the IHistogram3D. The default is "". "type=efficiency" for an efficiency IHistogram3D.
Returns
The newly created IHistogram3D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IProfile1D* AIDA::IHistogramFactory::createProfile1D ( const std::string &  path,
const std::string &  title,
int  nBins,
double  lowerEdge,
double  upperEdge,
const std::string &  options = "" 
)
pure virtual

Create a IProfile1D.

Parameters
pathThe 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.
titleThe title of the IProfile1D.
nBinsThe number of bins of the x axis.
lowerEdgeThe lower edge of the x axis.
upperEdgeThe upper edge of the x axis.
optionsThe options for the IProfile1D. The default is "".
Returns
The newly created IProfile1D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IProfile1D* AIDA::IHistogramFactory::createProfile1D ( const std::string &  path,
const std::string &  title,
int  nBins,
double  lowerEdge,
double  upperEdge,
double  lowerValue,
double  upperValue,
const std::string &  options = "" 
)
pure virtual

Create a IProfile1D.

Parameters
pathThe 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.
titleThe title of the IProfile1D.
nBinsThe number of bins of the x axis.
lowerEdgeThe lower edge of the x axis.
upperEdgeThe upper edge of the x axis.
lowerValueThe lower value displayed along the y axis.
upperValueThe upper value displayed along the y axis.
optionsThe options for the IProfile1D. The default is "".
Returns
The newly created IProfile1D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IProfile1D* AIDA::IHistogramFactory::createProfile1D ( const std::string &  path,
const std::string &  title,
const std::vector< double > &  binEdges,
const std::string &  options = "" 
)
pure virtual

Create a IProfile1D.

Parameters
pathThe 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.
titleThe title of the IProfile1D.
binEdgesThe array of the bin edges for the x axis.
optionsThe options for the IProfile1D. The default is "".
Returns
The newly created IProfile1D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IProfile1D* AIDA::IHistogramFactory::createProfile1D ( const std::string &  path,
const std::string &  title,
const std::vector< double > &  binEdges,
double  lowerValue,
double  upperValue,
const std::string &  options = "" 
)
pure virtual

Create a IProfile1D.

Parameters
pathThe 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.
titleThe title of the IProfile1D.
binEdgesThe array of the bin edges for the x axis.
lowerValueThe lower value displayed along the y axis.
upperValueThe upper value displayed along the y axis.
optionsThe options for the IProfile1D. The default is "".
Returns
The newly created IProfile1D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IProfile1D* AIDA::IHistogramFactory::createProfile1D ( const std::string &  pathAndTitle,
int  nBins,
double  lowerEdge,
double  upperEdge 
)
pure virtual

Create a IProfile1D.

Parameters
pathAndTitleThe 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.
nBinsThe number of bins of the x axis.
lowerEdgeThe lower edge of the x axis.
upperEdgeThe upper edge of the x axis.
Returns
The newly created IProfile1D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IProfile1D* AIDA::IHistogramFactory::createProfile1D ( const std::string &  pathAndTitle,
int  nBins,
double  lowerEdge,
double  upperEdge,
double  lowerValue,
double  upperValue 
)
pure virtual

Create a IProfile1D.

Parameters
pathAndTitleThe 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.
nBinsThe number of bins of the x axis.
lowerEdgeThe lower edge of the x axis.
upperEdgeThe upper edge of the x axis.
lowerValueThe lower value displayed along the y axis.
upperValueThe upper value displayed along the y axis.
Returns
The newly created IProfile1D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IProfile2D* AIDA::IHistogramFactory::createProfile2D ( const std::string &  path,
const std::string &  title,
int  nBinsX,
double  lowerEdgeX,
double  upperEdgeX,
int  nBinsY,
double  lowerEdgeY,
double  upperEdgeY,
const std::string &  options = "" 
)
pure virtual

Create a IProfile2D.

Parameters
pathThe 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.
titleThe title of the IProfile2D.
nBinsXThe number of bins of the x axis.
lowerEdgeXThe lower edge of the x axis.
upperEdgeXThe upper edge of the x axis.
nBinsYThe number of bins of the y axis.
lowerEdgeYThe lower edge of the y axis.
upperEdgeYThe upper edge of the y axis.
optionsThe options for the IProfile2D. The default is "".
Returns
The newly created IProfile2D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IProfile2D* AIDA::IHistogramFactory::createProfile2D ( const std::string &  path,
const std::string &  title,
int  nBinsX,
double  lowerEdgeX,
double  upperEdgeX,
int  nBinsY,
double  lowerEdgeY,
double  upperEdgeY,
double  lowerValue,
double  upperValue,
const std::string &  options = "" 
)
pure virtual

Create a IProfile2D.

Parameters
pathThe 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.
titleThe title of the IProfile2D.
nBinsXThe number of bins of the x axis.
lowerEdgeXThe lower edge of the x axis.
upperEdgeXThe upper edge of the x axis.
nBinsYThe number of bins of the y axis.
lowerEdgeYThe lower edge of the y axis.
upperEdgeYThe upper edge of the y axis.
lowerValueThe lower value displayed along the z axis.
upperValueThe upper value displayed along the z axis.
optionsThe options for the IProfile2D. The default is "".
Returns
The newly created IProfile2D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IProfile2D* AIDA::IHistogramFactory::createProfile2D ( const std::string &  path,
const std::string &  title,
const std::vector< double > &  binEdgesX,
const std::vector< double > &  binEdgesY,
const std::string &  options = "" 
)
pure virtual

Create a IProfile2D.

Parameters
pathThe 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.
titleThe title of the IProfile2D.
binEdgesXThe array of the bin edges for the x axis.
binEdgesYThe array of the bin edges for the y axis.
optionsThe options for the IProfile2D. The default is "".
Returns
The newly created IProfile2D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IProfile2D* AIDA::IHistogramFactory::createProfile2D ( const std::string &  path,
const std::string &  title,
const std::vector< double > &  binEdgesX,
const std::vector< double > &  binEdgesY,
double  lowerValue,
double  upperValue,
const std::string &  options = "" 
)
pure virtual

Create a IProfile2D.

Parameters
pathThe 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.
titleThe title of the IProfile2D.
binEdgesXThe array of the bin edges for the x axis.
binEdgesYThe array of the bin edges for the y axis.
lowerValueThe lower value displayed along the y axis.
upperValueThe upper value displayed along the y axis.
optionsThe options for the IProfile2D. The default is "".
Returns
The newly created IProfile2D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IProfile2D* AIDA::IHistogramFactory::createProfile2D ( const std::string &  pathAndTitle,
int  nBinsX,
double  lowerEdgeX,
double  upperEdgeX,
int  nBinsY,
double  lowerEdgeY,
double  upperEdgeY 
)
pure virtual

Create a IProfile2D.

Parameters
pathAndTitleThe 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.
nBinsXThe number of bins of the x axis.
lowerEdgeXThe lower edge of the x axis.
upperEdgeXThe upper edge of the x axis.
nBinsYThe number of bins of the y axis.
lowerEdgeYThe lower edge of the y axis.
upperEdgeYThe upper edge of the y axis.
Returns
The newly created IProfile2D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IProfile2D* AIDA::IHistogramFactory::createProfile2D ( const std::string &  pathAndTitle,
int  nBinsX,
double  lowerEdgeX,
double  upperEdgeX,
int  nBinsY,
double  lowerEdgeY,
double  upperEdgeY,
double  lowerValue,
double  upperValue 
)
pure virtual

Create a IProfile2D.

Parameters
pathAndTitleThe 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.
nBinsXThe number of bins of the x axis.
lowerEdgeXThe lower edge of the x axis.
upperEdgeXThe upper edge of the x axis.
nBinsYThe number of bins of the y axis.
lowerEdgeYThe lower edge of the y axis.
upperEdgeYThe upper edge of the y axis.
lowerValueThe lower value displayed along the z axis.
upperValueThe upper value displayed along the z axis.
Returns
The newly created IProfile2D.

Implemented in AIDA::IHistogramFactoryROOT.

virtual bool AIDA::IHistogramFactory::destroy ( IBaseHistogram hist)
pure virtual

Destroy an IBaseHistogram ogject.

Parameters
histThe IBaseHistogram to be destroyed.
Returns
false If the histogram cannot be destroyed.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram1D* AIDA::IHistogramFactory::divide ( const std::string &  path,
const IHistogram1D hist1,
const IHistogram1D hist2 
)
pure virtual

Create an IHistogram1D by dividing two IHistogram1D.

Parameters
pathThe 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.
hist1The first member of the division.
hist2The second member of the division.
Returns
The ration of the two IHistogram1D. if a directory in the path does not exist, or the path is illegal.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram2D* AIDA::IHistogramFactory::divide ( const std::string &  path,
const IHistogram2D hist1,
const IHistogram2D hist2 
)
pure virtual

Create an IHistogram2D by dividing two IHistogram2D.

Parameters
pathThe 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.
hist1The first member of the division.
hist2The second member of the division.
Returns
The ration of the two IHistogram2D. if a directory in the path does not exist, or the path is illegal.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram3D* AIDA::IHistogramFactory::divide ( const std::string &  path,
const IHistogram3D hist1,
const IHistogram3D hist2 
)
pure virtual

Create an IHistogram3D by dividing two IHistogram3D.

Parameters
pathThe 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.
hist1The first member of the division.
hist2The second member of the division.
Returns
The ration of the two IHistogram3D. if a directory in the path does not exist, or the path is illegal.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram1D* AIDA::IHistogramFactory::multiply ( const std::string &  path,
const IHistogram1D hist1,
const IHistogram1D hist2 
)
pure virtual

Create an IHistogram1D by multiplying two IHistogram1D.

Parameters
pathThe 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.
hist1The first member of the multiplication.
hist2The second member of the multiplication.
Returns
The product of the two IHistogram1D. if a directory in the path does not exist, or the path is illegal.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram2D* AIDA::IHistogramFactory::multiply ( const std::string &  path,
const IHistogram2D hist1,
const IHistogram2D hist2 
)
pure virtual

Create an IHistogram2D by multiplying two IHistogram2D.

Parameters
pathThe 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.
hist1The first member of the multiplication.
hist2The second member of the multiplication.
Returns
The product of the two IHistogram2D. if a directory in the path does not exist, or the path is illegal.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram3D* AIDA::IHistogramFactory::multiply ( const std::string &  path,
const IHistogram3D hist1,
const IHistogram3D hist2 
)
pure virtual

Create an IHistogram3D by multiplying two IHistogram3D.

Parameters
pathThe 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.
hist1The first member of the multiplication.
hist2The second member of the multiplication.
Returns
The product of the two IHistogram3D. if a directory in the path does not exist, or the path is illegal.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram1D* AIDA::IHistogramFactory::projectionX ( const std::string &  path,
const IHistogram2D hist 
)
pure virtual

Create an IHistogram1D by projecting an IHistogram2D along its x axis.

This is equivalent to sliceX(UNDERFLOW_BIN,OVERFLOW_BIN).

Parameters
pathThe 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.
histThe IHistogram2D to be projected.
Returns
The resulting projection.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram2D* AIDA::IHistogramFactory::projectionXY ( const std::string &  path,
const IHistogram3D hist 
)
pure virtual

Create an IHistogram2D by projecting an IHistogram3D on the x-y plane.

This is equivalent to sliceXY(UNDERFLOW_BIN,OVERFLOW_BIN).

Parameters
pathThe 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.
histThe IHistogram3D to be projected.
Returns
The resulting projection.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram2D* AIDA::IHistogramFactory::projectionXZ ( const std::string &  path,
const IHistogram3D hist 
)
pure virtual

Create an IHistogram2D by projecting an IHistogram3D on the x-z plane.

This is equivalent to sliceXZ(UNDERFLOW_BIN,OVERFLOW_BIN).

Parameters
pathThe 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.
histThe IHistogram3D to be projected.
Returns
The resulting projection.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram1D* AIDA::IHistogramFactory::projectionY ( const std::string &  path,
const IHistogram2D hist 
)
pure virtual

Create an IHistogram1D by projecting an IHistogram2D along its y axis.

This is equivalent to sliceY(UNDERFLOW_BIN,OVERFLOW_BIN).

Parameters
pathThe 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.
histThe IHistogram2D to be projected.
Returns
The resulting projection.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram2D* AIDA::IHistogramFactory::projectionYZ ( const std::string &  path,
const IHistogram3D hist 
)
pure virtual

Create an IHistogram2D by projecting an IHistogram3D on the y-z plane.

This is equivalent to sliceYZ(UNDERFLOW_BIN,OVERFLOW_BIN).

Parameters
pathThe 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.
histThe IHistogram3D to be projected.
Returns
The resulting projection.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram1D* AIDA::IHistogramFactory::sliceX ( const std::string &  path,
const IHistogram2D hist,
int  index 
)
pure virtual

Create an IHistogram1D by slicing an IHistogram2D parallel to the y axis at a given bin.

This is equivalent to sliceX(indexY,indexY).

Parameters
pathThe 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.
histThe IHistogram2D to be sliced.
indexThe index of the bin along the y axis where the IHistogram2D has to be sliced.
Returns
The resulting slice.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram1D* AIDA::IHistogramFactory::sliceX ( const std::string &  path,
const IHistogram2D hist,
int  index1,
int  index2 
)
pure virtual

Create an IHistogram1D by slicing an IHistogram2D parallel to the y axis between two bins (inclusive).

Parameters
pathThe 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.
histThe IHistogram2D to be sliced.
index1The index of the bin along the y axis that marks the lower edge of the slice.
index2The index of the bin along the y axis that marks the upper edge of the slice.
Returns
The resulting slice.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram2D* AIDA::IHistogramFactory::sliceXY ( const std::string &  path,
const IHistogram3D hist,
int  index1,
int  index2 
)
pure virtual

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
pathThe 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.
histThe IHistogram3D to sliced.
index1The index of the bin along the z axis that marks the lower edge of the slice.
index2The index of the bin along the z axis that marks the upper edge of the slice.
Returns
The resulting slice.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram2D* AIDA::IHistogramFactory::sliceXZ ( const std::string &  path,
const IHistogram3D hist,
int  index1,
int  index2 
)
pure virtual

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
pathThe 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.
histThe IHistogram3D to sliced.
index1The index of the bin along the y axis that marks the lower edge of the slice.
index2The index of the bin along the y axis that marks the upper edge of the slice.
Returns
The resulting slice.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram1D* AIDA::IHistogramFactory::sliceY ( const std::string &  path,
const IHistogram2D hist,
int  index 
)
pure virtual

Create an IHistogram1D by slicing an IHistogram2D parallel to the x axis at a given bin.

This is equivalent to sliceY(indexX,indexX).

Parameters
pathThe 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.
histThe IHistogram2D to be sliced.
indexThe index of the bin along the x axis where the IHistogram2D has to be sliced.
Returns
The resulting slice.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram1D* AIDA::IHistogramFactory::sliceY ( const std::string &  path,
const IHistogram2D hist,
int  index1,
int  index2 
)
pure virtual

Create an IHistogram1D by slicing an IHistogram2D parallel to the x axis between two bins (inclusive).

Parameters
pathThe 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.
histThe IHistogram2D to be sliced.
index1The index of the bin along the x axis that marks the lower edge of the slice.
index2The index of the bin along the x axis that marks the upper edge of the slice.
Returns
The resulting slice.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram2D* AIDA::IHistogramFactory::sliceYZ ( const std::string &  path,
const IHistogram3D hist,
int  index1,
int  index2 
)
pure virtual

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
pathThe 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.
histThe IHistogram3D to sliced.
index1The index of the bin along the x axis that marks the lower edge of the slice.
index2The index of the bin along the x axis that marks the upper edge of the slice.
Returns
The resulting slice.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram1D* AIDA::IHistogramFactory::subtract ( const std::string &  path,
const IHistogram1D hist1,
const IHistogram1D hist2 
)
pure virtual

Create an IHistogram1D by subtracting two IHistogram1D.

Parameters
pathThe 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.
hist1The first member of the subtraction.
hist2The second member of the subtraction.
Returns
The difference of the two IHistogram1D. if a directory in the path does not exist, or the path is illegal.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram2D* AIDA::IHistogramFactory::subtract ( const std::string &  path,
const IHistogram2D hist1,
const IHistogram2D hist2 
)
pure virtual

Create an IHistogram2D by subtracting two IHistogram2D.

Parameters
pathThe 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.
hist1The first member of the subtraction.
hist2The second member of the subtraction.
Returns
The difference of the two IHistogram2D. if a directory in the path does not exist, or the path is illegal.

Implemented in AIDA::IHistogramFactoryROOT.

virtual IHistogram3D* AIDA::IHistogramFactory::subtract ( const std::string &  path,
const IHistogram3D hist1,
const IHistogram3D hist2 
)
pure virtual

Create an IHistogram3D by subtracting two IHistogram3D.

Parameters
pathThe 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.
hist1The first member of the subtraction.
hist2The second member of the subtraction.
Returns
The difference of the two IHistogram3D. if a directory in the path does not exist, or the path is illegal.

Implemented in AIDA::IHistogramFactoryROOT.


The documentation for this class was generated from the following file: