CERN Accelerating science

This website is no longer maintained. Its content may be obsolete. Please visit http://home.cern/ for current CERN information.

Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

AIDA::IHistogramFactory Class Reference

#include <IHistogramFactory.h>

List of all members.

Public Methods

virtual ~IHistogramFactory ()
 Destructor. More...

virtual bool destroy (IBaseHistogram *hist)=0
virtual ICloud1D* createCloud1D (const std::string &name, const std::string &title, int nMax=-1, const std::string &options="")=0
virtual ICloud1D* createCloud1D (const std::string &nameAndTitle)=0
virtual ICloud1D* createCopy (const std::string &name, const ICloud1D &cloud)=0
virtual ICloud2D* createCloud2D (const std::string &name, const std::string &title, int nMax=-1, const std::string &options="")=0
virtual ICloud2D* createCloud2D (const std::string &nameAndTitle)=0
virtual ICloud2D* createCopy (const std::string &name, const ICloud2D &cloud)=0
virtual ICloud3D* createCloud3D (const std::string &name, const std::string &title, int nMax=-1, const std::string &options="")=0
virtual ICloud3D* createCloud3D (const std::string &nameAndTitle)=0
virtual ICloud3D* createCopy (const std::string &name, const ICloud3D &cloud)=0
virtual IHistogram1D* createHistogram1D (const std::string &name, const std::string &title, int nBins, double lowerEdge, double upperEdge, const std::string &options="")=0
virtual IHistogram1D* createHistogram1D (const std::string &nameAndTitle, int nBins, double lowerEdge, double upperEdge)=0
virtual IHistogram1D* createHistogram1D (const std::string &name, const std::string &title, const std::vector< double > &binEdges, const std::string &options="")=0
virtual IHistogram1D* createCopy (const std::string &name, const IHistogram1D &hist)=0
virtual IHistogram2D* createHistogram2D (const std::string &name, const std::string &title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, const std::string &options="")=0
virtual IHistogram2D* createHistogram2D (const std::string &nameAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY)=0
virtual IHistogram2D* createHistogram2D (const std::string &name, const std::string &title, const std::vector< double > &binEdgesX, const std::vector< double > &binEdgesY, const std::string &options="")=0
virtual IHistogram2D* createCopy (const std::string &name, const IHistogram2D &hist)=0
virtual IHistogram3D* createHistogram3D (const std::string &name, 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
virtual IHistogram3D* createHistogram3D (const std::string &nameAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ)=0
virtual IHistogram3D* createHistogram3D (const std::string &name, const std::string &title, const std::vector< double > &binEdgesX, const std::vector< double > &binEdgesY, const std::vector< double > &binEdgesZ, const std::string &options="")=0
virtual IHistogram3D* createCopy (const std::string &name, const IHistogram3D &hist)=0
virtual IProfile1D* createProfile1D (const std::string &name, const std::string &title, int nBins, double lowerEdge, double upperEdge, const std::string &options="")=0
virtual IProfile1D* createProfile1D (const std::string &name, const std::string &title, int nBins, double lowerEdge, double upperEdge, double lowerValue, double upperValue, const std::string &options="")=0
virtual IProfile1D* createProfile1D (const std::string &name, const std::string &title, const std::vector< double > &binEdges, const std::string &options="")=0
virtual IProfile1D* createProfile1D (const std::string &name, const std::string &title, const std::vector< double > &binEdges, double lowerValue, double upperValue, const std::string &options="")=0
virtual IProfile1D* createProfile1D (const std::string &nameAndTitle, int nBins, double lowerEdge, double upperEdge)=0
virtual IProfile1D* createProfile1D (const std::string &nameAndTitle, int nBins, double lowerEdge, double upperEdge, double lowerValue, double upperValue)=0
virtual IProfile1D* createCopy (const std::string &name, const IProfile1D &profile)=0
virtual IProfile2D* createProfile2D (const std::string &name, const std::string &title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, const std::string &options="")=0
virtual IProfile2D* createProfile2D (const std::string &name, 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
virtual IProfile2D* createProfile2D (const std::string &name, const std::string &title, const std::vector< double > &binEdgesX, const std::vector< double > &binEdgesY, const std::string &options="")=0
virtual IProfile2D* createProfile2D (const std::string &name, const std::string &title, const std::vector< double > &binEdgesX, const std::vector< double > &binEdgesY, double lowerValue, double upperValue, const std::string &options="")=0
virtual IProfile2D* createProfile2D (const std::string &nameAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY)=0
virtual IProfile2D* createProfile2D (const std::string &nameAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, double lowerValue, double upperValue)=0
virtual IProfile2D* createCopy (const std::string &name, const IProfile2D &profile)=0
virtual IHistogram1D* add (const std::string &name, const IHistogram1D &hist1, const IHistogram1D &hist2)=0
virtual IHistogram1D* subtract (const std::string &name, const IHistogram1D &hist1, const IHistogram1D &hist2)=0
virtual IHistogram1D* multiply (const std::string &name, const IHistogram1D &hist1, const IHistogram1D &hist2)=0
virtual IHistogram1D* divide (const std::string &name, const IHistogram1D &hist1, const IHistogram1D &hist2)=0
virtual IHistogram2D* add (const std::string &name, const IHistogram2D &hist1, const IHistogram2D &hist2)=0
virtual IHistogram2D* subtract (const std::string &name, const IHistogram2D &hist1, const IHistogram2D &hist2)=0
virtual IHistogram2D* multiply (const std::string &name, const IHistogram2D &hist1, const IHistogram2D &hist2)=0
virtual IHistogram2D* divide (const std::string &name, const IHistogram2D &hist1, const IHistogram2D &hist2)=0
virtual IHistogram3D* add (const std::string &name, const IHistogram3D &hist1, const IHistogram3D &hist2)=0
virtual IHistogram3D* subtract (const std::string &name, const IHistogram3D &hist1, const IHistogram3D &hist2)=0
virtual IHistogram3D* multiply (const std::string &name, const IHistogram3D &hist1, const IHistogram3D &hist2)=0
virtual IHistogram3D* divide (const std::string &name, const IHistogram3D &hist1, const IHistogram3D &hist2)=0
virtual IHistogram1D* projectionX (const std::string &name, const IHistogram2D &hist)=0
virtual IHistogram1D* projectionY (const std::string &name, const IHistogram2D &hist)=0
virtual IHistogram1D* sliceX (const std::string &name, const IHistogram2D &hist, int index)=0
virtual IHistogram1D* sliceY (const std::string &name, const IHistogram2D &hist, int index)=0
virtual IHistogram1D* sliceX (const std::string &name, const IHistogram2D &hist, int index1, int index2)=0
virtual IHistogram1D* sliceY (const std::string &name, const IHistogram2D &hist, int index1, int index2)=0
virtual IHistogram2D* projectionXY (const std::string &name, const IHistogram3D &hist)=0
virtual IHistogram2D* projectionXZ (const std::string &name, const IHistogram3D &hist)=0
virtual IHistogram2D* projectionYZ (const std::string &name, const IHistogram3D &hist)=0
virtual IHistogram2D* sliceXY (const std::string &name, const IHistogram3D &hist, int index1, int index2)=0
virtual IHistogram2D* sliceXZ (const std::string &name, const IHistogram3D &hist, int index1, int index2)=0
virtual IHistogram2D* sliceYZ (const std::string &name, const IHistogram3D &hist, int index1, int index2)=0

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/)

Definition at line 38 of file IHistogramFactory.h.

Constructor & Destructor Documentation

AIDA::IHistogramFactory::~IHistogramFactory ( ) [inline, virtual]
 

Definition at line 42 of file IHistogramFactory.h.

Member Function Documentation

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

Create an IHistogram3D by adding two IHistogram3D.

Parameters:
name   The name of the resulting IHistogram3D.
hist1   The first member of the addition.
hist2   The second member of the addition.
Returns:
The sum of the two IHistogram3D.

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

Create an IHistogram2D by adding two IHistogram2D.

Parameters:
name   The name of the resulting IHistogram2D.
hist1   The first member of the addition.
hist2   The second member of the addition.
Returns:
The sum of the two IHistogram2D.

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

Create an IHistogram1D by adding two IHistogram1D.

Parameters:
name   The name of the resulting IHistogram1D.
hist1   The first member of the addition.
hist2   The second member of the addition.
Returns:
The sum of the two IHistogram1D.

ICloud1D * AIDA::IHistogramFactory::createCloud1D ( const std::string & nameAndTitle ) [pure virtual]
 

Create a ICloud1D, an unbinned 1-dimensional histogram.

Parameters:
nameAndTitle   The name of the ICloud1D; it is also its title.
Returns:
The newly created ICloud1D.

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

Create a ICloud1D, an unbinned 1-dimensioal histogram.

Parameters:
name   The name of the ICloud1D.
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 indicates no limit of entries before aoutoconversion to a IHistogram1D.
options   The options for the ICloud1D. "autoconvert=true" to enable autoconversion to an IHistogram1D.
Returns:
The newly created ICloud1D.

ICloud2D * AIDA::IHistogramFactory::createCloud2D ( const std::string & nameAndTitle ) [pure virtual]
 

Create a ICloud2D, an unbinned 2-dimensional histogram.

Parameters:
nameAndTitle   The name of the ICloud2D; it is also its title.
Returns:
The newly created ICloud2D.

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

Create a ICloud2D, an unbinned 2-dimensional histogram.

Parameters:
name   The name of the ICloud2D.
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 indicates no limit of entries before aoutoconversion to a IHistogram2D.
options   The options for the ICloud2D. "autoconvert=true" to enable autoconversion to an IHistogram2D.
Returns:
The newly created ICloud2D.

ICloud3D * AIDA::IHistogramFactory::createCloud3D ( const std::string & nameAndTitle ) [pure virtual]
 

Create a ICloud3D, an unbinned 3-dimensional histogram.

Parameters:
nameAndTitle   The name of the ICloud3D; it is also its title.
Returns:
The newly created ICloud3D.

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

Create a ICloud3D, an unbinned 3-dimensional histogram.

Parameters:
name   The name of the ICloud3D.
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 indicates no limit of entries before aoutoconversion to a IHistogram3D.
options   The options for the ICloud3D. "autoconvert=true" to enable autoconversion to an IHistogram3D.
Returns:
The newly created ICloud3D.

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

Create a copy of an IProfile2D.

Parameters:
name   The name of the new copy.
profile   The IProfile2D to be copied.
Returns:
The copy of the IProfile2D.

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

Create a copy of an IProfile1D.

Parameters:
name   The name of the new copy.
profile   The IProfile1D to be copied.
Returns:
The copy of the IProfile1D.

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

Create a copy of an IHistogram3D.

Parameters:
name   The name of the new copy.
hist   The IHistogram3D to be copied.
Returns:
The copy of the IHistogram3D.

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

Create a copy of an IHistogram2D.

Parameters:
name   The name of the new copy.
hist   The IHistogram2D to be copied.
Returns:
The copy of the IHistogram2D.

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

Create a copy of an IHistogram1D.

Parameters:
name   The name of the new copy.
hist   The IHistogram1D to be copied.
Returns:
The copy of the IHistogram1D.

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

Create a copy of an ICloud3D.

Parameters:
name   The name of the new copy.
cloud   The ICloud3D to be copied.
Returns:
The copy of the ICloud3D.

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

Create a copy of an ICloud2D.

Parameters:
name   The name of the new copy.
cloud   The ICloud2D to be copied.
Returns:
The copy of the ICloud2D.

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

Create a copy of an ICloud1D.

Parameters:
name   The name of the new copy.
cloud   The ICloud1D to be copied.
Returns:
The copy of the ICloud1D.

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

Create a IHistogram1D.

Parameters:
name   The name of the IHistogram1D.
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.
Returns:
The newly created IHistogram1D.

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

Create a IHistogram1D.

Parameters:
nameAndTitle   The name of the IHistogram1D; it is also the title.
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.

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

Create a IHistogram1D.

Parameters:
name   The name of the IHistogram1D.
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.
Returns:
The newly created IHistogram1D.

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

Create a IHistogram2D.

Parameters:
name   The name of the IHistogram2D.
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.
Returns:
The newly created IHistogram2D.

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

Create a IHistogram2D.

Parameters:
nameAndTitle   The name of the IHistogram2D; it is also the title.
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.

IHistogram2D * AIDA::IHistogramFactory::createHistogram2D ( const std::string & name,
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:
name   The name of the IHistogram2D.
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.
Returns:
The newly created IHistogram2D.

IHistogram3D * AIDA::IHistogramFactory::createHistogram3D ( const std::string & name,
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:
name   The name of the IHistogram3D.
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 "". "type=efficiency" for an efficiency IHistogram3D.
Returns:
The newly created IHistogram3D.

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

Create a IHistogram3D.

Parameters:
nameAndTitle   The name of the IHistogram3D; it is also the title.
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.

IHistogram3D * AIDA::IHistogramFactory::createHistogram3D ( const std::string & name,
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:
name   The name of the IHistogram3D.
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.
Returns:
The newly created IHistogram3D.

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

Create a IProfile1D.

Parameters:
nameAndTitle   The name of the IProfile1D; it is also the title.
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.

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

Create a IProfile1D.

Parameters:
nameAndTitle   The name of the IProfile1D; it is also the title.
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.

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

Create a IProfile1D.

Parameters:
name   The name of the IProfile1D.
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 "".
Returns:
The newly created IProfile1D.

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

Create a IProfile1D.

Parameters:
name   The name of the IProfile1D.
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 "".
Returns:
The newly created IProfile1D.

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

Create a IProfile1D.

Parameters:
name   The name of the IProfile1D.
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 "".
Returns:
The newly created IProfile1D.

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

Create a IProfile1D.

Parameters:
name   The name of the IProfile1D.
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 "".
Returns:
The newly created IProfile1D.

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

Create a IProfile2D.

Parameters:
nameAndTitle   The name of the IProfile2D; it is also the title.
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.

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

Create a IProfile2D.

Parameters:
nameAndTitle   The name of the IProfile2D; it is also the title.
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.

IProfile2D * AIDA::IHistogramFactory::createProfile2D ( const std::string & name,
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:
name   The name of the IProfile2D.
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 "".
Returns:
The newly created IProfile2D.

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

Create a IProfile2D.

Parameters:
name   The name of the IProfile2D.
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 "".
Returns:
The newly created IProfile2D.

IProfile2D * AIDA::IHistogramFactory::createProfile2D ( const std::string & name,
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:
name   The name of the IProfile2D.
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 "".
Returns:
The newly created IProfile2D.

IProfile2D * AIDA::IHistogramFactory::createProfile2D ( const std::string & name,
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:
name   The name of the IProfile2D.
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 "".
Returns:
The newly created IProfile2D.

bool AIDA::IHistogramFactory::destroy ( IBaseHistogram * hist ) [pure virtual]
 

Destroy an IBaseHistogram ogject.

Parameters:
hist   The IBaseHistogram to be destroyed.
Returns:
false If the histogram cannot be destroyed.

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

Create an IHistogram3D by dividing two IHistogram3D.

Parameters:
name   The name of the resulting IHistogram3D.
hist1   The first member of the division.
hist2   The second member of the division.
Returns:
The ration of the two IHistogram3D.

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

Create an IHistogram2D by dividing two IHistogram2D.

Parameters:
name   The name of the resulting IHistogram2D.
hist1   The first member of the division.
hist2   The second member of the division.
Returns:
The ration of the two IHistogram2D.

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

Create an IHistogram1D by dividing two IHistogram1D.

Parameters:
name   The name of the resulting IHistogram1D.
hist1   The first member of the division.
hist2   The second member of the division.
Returns:
The ration of the two IHistogram1D.

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

Create an IHistogram3D by multiplying two IHistogram3D.

Parameters:
name   The name of the resulting IHistogram3D.
hist1   The first member of the multiplication.
hist2   The second member of the multiplication.
Returns:
The product of the two IHistogram3D.

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

Create an IHistogram2D by multiplying two IHistogram2D.

Parameters:
name   The name of the resulting IHistogram2D.
hist1   The first member of the multiplication.
hist2   The second member of the multiplication.
Returns:
The product of the two IHistogram2D.

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

Create an IHistogram1D by multiplying two IHistogram1D.

Parameters:
name   The name of the resulting IHistogram1D.
hist1   The first member of the multiplication.
hist2   The second member of the multiplication.
Returns:
The product of the two IHistogram1D.

IHistogram1D * AIDA::IHistogramFactory::projectionX ( const std::string & name,
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:
name   The name of the resulting IHistogram1D.
hist   The IHistogram2D to be projected.
Returns:
The resulting projection.

IHistogram2D * AIDA::IHistogramFactory::projectionXY ( const std::string & name,
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:
name   The name of the resulting IHistogram2D.
hist   The IHistogram3D to be projected.
Returns:
The resulting projection.

IHistogram2D * AIDA::IHistogramFactory::projectionXZ ( const std::string & name,
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:
name   The name of the resulting IHistogram2D.
hist   The IHistogram3D to be projected.
Returns:
The resulting projection.

IHistogram1D * AIDA::IHistogramFactory::projectionY ( const std::string & name,
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:
name   The name of the resulting IHistogram1D.
hist   The IHistogram2D to be projected.
Returns:
The resulting projection.

IHistogram2D * AIDA::IHistogramFactory::projectionYZ ( const std::string & name,
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:
name   The name of the resulting IHistogram2D.
hist   The IHistogram3D to be projected.
Returns:
The resulting projection.

IHistogram1D * AIDA::IHistogramFactory::sliceX ( const std::string & name,
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:
name   The name of the resulting IHistogram1D.
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.

IHistogram1D * AIDA::IHistogramFactory::sliceX ( const std::string & name,
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:
name   The name of the resulting IHistogram1D.
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.

IHistogram2D * AIDA::IHistogramFactory::sliceXY ( const std::string & name,
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:
name   The name of the resulting IHistogram2D.
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.

IHistogram2D * AIDA::IHistogramFactory::sliceXZ ( const std::string & name,
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:
name   The name of the resulting IHistogram2D.
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.

IHistogram1D * AIDA::IHistogramFactory::sliceY ( const std::string & name,
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:
name   The name of the resulting IHistogram1D.
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.

IHistogram1D * AIDA::IHistogramFactory::sliceY ( const std::string & name,
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:
name   The name of the resulting IHistogram1D.
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.

IHistogram2D * AIDA::IHistogramFactory::sliceYZ ( const std::string & name,
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:
name   The name of the resulting IHistogram2D.
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.

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

Create an IHistogram3D by subtracting two IHistogram3D.

Parameters:
name   The name of the resulting IHistogram3D.
hist1   The first member of the subtraction.
hist2   The second member of the subtraction.
Returns:
The difference of the two IHistogram3D.

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

Create an IHistogram2D by subtracting two IHistogram2D.

Parameters:
name   The name of the resulting IHistogram2D.
hist1   The first member of the subtraction.
hist2   The second member of the subtraction.
Returns:
The difference of the two IHistogram2D.

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

Create an IHistogram1D by subtracting two IHistogram1D.

Parameters:
name   The name of the resulting IHistogram1D.
hist1   The first member of the subtraction.
hist2   The second member of the subtraction.
Returns:
The difference of the two IHistogram1D.

The documentation for this class was generated from the following file:
Generated at Tue Feb 18 15:48:24 2003 for AIDA_Interfaces by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001