CERN Accelerating science

• Sign in
• Directory

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

               

---

AIDA::IFitData Class Reference

#include <IFitData.h>

List of all members.

Public Methods
virtual	~IFitData ()
	Destructor. More...
virtual bool	create1DConnection (const IHistogram1D &h)=0
virtual bool	create1DConnection (const ICloud1D &c)=0
virtual bool	create1DConnection (const IProfile1D &p)=0
virtual bool	create1DConnection (const IDataPointSet &dp, int xIndex, int valIndex)=0
virtual bool	create2DConnection (const IHistogram2D &h)=0
virtual bool	create2DConnection (const IHistogram2D &h, int xIndex, int yIndex)=0
virtual bool	create2DConnection (const ICloud2D &c)=0
virtual bool	create2DConnection (const ICloud2D &c, int xIndex, int yIndex)=0
virtual bool	create2DConnection (const IProfile2D &p)=0
virtual bool	create2DConnection (const IProfile2D &p, int xIndex, int yIndex)=0
virtual bool	create2DConnection (const IDataPointSet &dp, int xIndex, int yIndex, int valIndex)=0
virtual bool	create3DConnection (const IHistogram3D &h)=0
virtual bool	create3DConnection (const IHistogram3D &h, int xIndex, int yIndex, int zIndex)=0
virtual bool	create3DConnection (const ICloud3D &c)=0
virtual bool	create3DConnection (const ICloud3D &c, int xIndex, int yIndex, int zIndex)=0
virtual bool	create3DConnection (const IDataPointSet &dp, int xIndex, int yIndex, int zIndex, int valIndex)=0
virtual bool	createConnection (const ITuple &t, std::vector< std::string > colNames)=0
virtual bool	createConnection (const ITuple &t, std::vector< IEvaluator > evals)=0
virtual bool	createConnection (const IDataPointSet &dp, std::vector< int > indeces, int valIndex)=0
virtual void	reset ()=0
virtual int	dimension () const=0
virtual std::string	dataDescription () const=0
	Return a string describing the data. This should be considered as a hint to the user where to find the original data objects and how to connect the data pipes. PENDING: probably this can be part of XML streaming. More...
virtual IRangeSet&	range (int index) const=0

---

Detailed Description

@interface

Abstract representation of the fit data. Serves for several purposes:

• decouple fitter from the details of the particular data objects (Histograms etc)
• provide range restriction capability ("cut of the tails...")
• creates the image of the virtual data source

Design notes:

1) we try to be explicit in the method names which should indicate the dimensionality of the fit data.

this way we have more compile-time/run-time safety and clearer code. in C++ we can handle default arguments which otherwise would be ambigeous.

2) string names of the arguments are at the end of the methods' signatures and have default (empty) values. so if function argument name is missing, assume the ordering is taken from the histogram axis it connects to the name of the pipes then are generated automatically using the same default scheme as for functions x[1], x[2] etc.

3) There are two ends to pipes: one connected to the data source and one pouring data out. Both their orders has to be specified.

For IHistogram, ICloud, IProfile the connections to the data source are ordered as the axis (x=0, y=1, z=2); the user has to provide the order with which the pipes are providing the data. So for example in the constructor create2DConnection(hist2D,xIndex,yIndex); xIndex specifies the exit order of the pipe connected to the x Axis (and similarly for yIndex). So the default method create2DConnection(hist2D); corresponds to create2DConnection(hist2D,0,1); In the methods for IHistograms, IClouds, and IProfiles one index could have been dropped as the second could be inferred by the dimensionality. We preferred being redundant just to avoid confusion in interpreting what create2DConnection(hist2D,1); really means.

For ITuple and IDataPointSet the order in the connection to the data source is specified by the user by providing, respectively, the array of column names (or evaluators) and the array of coordinate indexes to which to connect the pipes. In this case we assume that the pipes are parallel, i.e. the exit order is the same as the one of the connection to the data source. In the createXDConnection methods to IDataPointSets we preferred not to provide defaults for the valIndex to avoid confusion in interpreting it. We can always add it later.

PENDING: clarify the relation between data range and normalization range

Author:

The AIDA Team.

Definition at line 92 of file IFitData.h.

---

Constructor & Destructor Documentation

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

Definition at line 96 of file IFitData.h.

---

Member Function Documentation

bool AIDA::IFitData::create1DConnection ( const IDataPointSet & dp, int xIndex, int valIndex ) [pure virtual]

Create a one dimensional connection to an IDataPointSet. Parameters: dp   The dataPointSet to which to connect to. xIndex   The index of the coordinate to which the variable is connected. valIndex   The index of the coordinate used as "height". Returns: false If something is wrong.

bool AIDA::IFitData::create1DConnection ( const IProfile1D & p ) [pure virtual]

Create a one dimensional connection to an IProfile1D. Parameters: p   The 1D profile to which to connect to. Returns: false If something is wrong.

bool AIDA::IFitData::create1DConnection ( const ICloud1D & c ) [pure virtual]

Create a one dimensional connection to an ICloud1D. Parameters: c   The 1D cloud to which to connect to. Returns: false If something is wrong.

bool AIDA::IFitData::create1DConnection ( const IHistogram1D & h ) [pure virtual]

Create a one dimensional connection to an IHistogram1D. Parameters: h   The 1D histogram to which to connect to. Returns: false If something is wrong.

bool AIDA::IFitData::create2DConnection ( const IDataPointSet & dp, int xIndex, int yIndex, int valIndex ) [pure virtual]

Create a two dimensional connection to an IDataPointSet. Parameters: dp   The dataPointSet to which to connect to. xIndex   The index of the coordinate to which the x variable is connected. yIndex   The index of the coordinate to which the y variable is connected. valIndex   The index of the coordinate used as "height". Returns: false If something is wrong.

bool AIDA::IFitData::create2DConnection ( const IProfile2D & p, int xIndex, int yIndex ) [pure virtual]

Create a two dimensional connection to an IProfile2D. Parameters: p   The 2D profile to which to connect to. xIndex   The index of the axis to which the x variable is connected. yIndex   The index of the axis to which the y variable is connected. Returns: false If something is wrong.

bool AIDA::IFitData::create2DConnection ( const IProfile2D & p ) [pure virtual]

Create a two dimensional connection to an IProfile2D. Parameters: p   The 2D profile to which to connect to. Returns: false If something is wrong.

bool AIDA::IFitData::create2DConnection ( const ICloud2D & c, int xIndex, int yIndex ) [pure virtual]

Create a two dimensional connection to an ICloud2D. Parameters: c   The 2D cloud to which to connect to. xIndex   The index of the axis to which the x variable is connected. yIndex   The index of the axis to which the y variable is connected. Returns: false If something is wrong.

bool AIDA::IFitData::create2DConnection ( const ICloud2D & c ) [pure virtual]

Create a two dimensional connection to an ICloud2D. Parameters: c   The 2D cloud to which to connect to. Returns: false If something is wrong.

bool AIDA::IFitData::create2DConnection ( const IHistogram2D & h, int xIndex, int yIndex ) [pure virtual]

Create a two dimensional connection to an IHistogram2D. Parameters: h   The 2D histogram to which to connect to. xIndex   The index of the axis to which the x variable is connected. yIndex   The index of the axis to which the y variable is connected. Returns: false If something is wrong.

bool AIDA::IFitData::create2DConnection ( const IHistogram2D & h ) [pure virtual]

Create a two dimensional connection to an IHistogram2D. Parameters: h   The 2D histogram to which to connect to. Returns: false If something is wrong.

bool AIDA::IFitData::create3DConnection ( const IDataPointSet & dp, int xIndex, int yIndex, int zIndex, int valIndex ) [pure virtual]

Create a three dimensional connection to an IDataPointSet. Parameters: dp   The dataPointSet to which to connect to. xIndex   The index of the coordinate to which the x variable is connected. yIndex   The index of the coordinate to which the y variable is connected. zIndex   The index of the coordinate to which the z variable is connected. valIndex   The index of the coordinate used as "height". Returns: false If something is wrong.

bool AIDA::IFitData::create3DConnection ( const ICloud3D & c, int xIndex, int yIndex, int zIndex ) [pure virtual]

Create a three dimensional connection to an ICloud3D. Parameters: c   The 3D cloud to which to connect to. xIndex   The index of the axis to which the x variable is connected. yIndex   The index of the axis to which the y variable is connected. zIndex   The index of the axis to which the z variable is connected. Returns: false If something is wrong.

bool AIDA::IFitData::create3DConnection ( const ICloud3D & c ) [pure virtual]

Create a three dimensional connection to an ICloud3D. Parameters: c   The 3D cloud to which to connect to. Returns: false If something is wrong.

bool AIDA::IFitData::create3DConnection ( const IHistogram3D & h, int xIndex, int yIndex, int zIndex ) [pure virtual]

Create a three dimensional connection to an IHistogram3D. Parameters: h   The 3D histogram to which to connect to. xIndex   The index of the axis to which the x variable is connected. yIndex   The index of the axis to which the y variable is connected. zIndex   The index of the axis to which the z variable is connected. Returns: false If something is wrong.

bool AIDA::IFitData::create3DConnection ( const IHistogram3D & h ) [pure virtual]

Create a three dimensional connection to an IHistogram3D. Parameters: h   The 3D histogram to which to connect to. Returns: false If something is wrong.

bool AIDA::IFitData::createConnection ( const IDataPointSet & dp, std::vector< int > indeces, int valIndex ) [pure virtual]

Create a connection to an IDataPointSet. Parameters: dp   The dataPointSet to which to connect to. indeces   The indeces of the coordinates to which the variables are connected. valIndex   The index of the coordinate used as "height". Returns: false If something is wrong.

bool AIDA::IFitData::createConnection ( const ITuple & t, std::vector< IEvaluator > evals ) [pure virtual]

Create a connection to an ITuple. Parameters: t   The ITuple. evals   The list of the IEvaluator used to calculate the variable's value. Returns: false If something is wrong.

bool AIDA::IFitData::createConnection ( const ITuple & t, std::vector< std::string > colNames ) [pure virtual]

Create a connection to an ITuple. Parameters: t   The ITuple. colNames   The names of the columns to which to connect. Returns: false If something is wrong.

std::string AIDA::IFitData::dataDescription ( ) const [pure virtual]

int AIDA::IFitData::dimension ( ) const [pure virtual]

The dimension of this IFitData, i.e. the number of connections. Returns: The dimension of the IFitData.

IRangeSet & AIDA::IFitData::range ( int index ) const [pure virtual]

Get Range of the corresponding connection by index. The index represent the order in which connections are coming out of the IFitData. Parameters: The   index of the connection. Returns: The Range

void AIDA::IFitData::reset ( ) [pure virtual]

Remove all Ranges and connections; after this is like newly create.

---

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

• IFitData.h

---