Basic user-level interface class for holding and managing a single set of "data points". More...

#include <IDataPointSetROOT.h>

Inheritance diagram for AIDA::IDataPointSetROOT:

Public Member Functions
virtual	~IDataPointSetROOT ()
	Destructor.

virtual IAnnotation &	annotation ()
	Get the IAnnotation of the IDataPointSet. More...

virtual const IAnnotation &	annotation () const

virtual std::string	title () const
	Get the title of the IDataPointSet. More...

virtual bool	setTitle (const std::string &title)
	Set the title of the IDataPointSet. More...

virtual int	dimension () const
	Get the dimension of the IDataPoints that can be stored in the set. More...

virtual void	clear ()
	Remove all the IDataPoints in the set. More...

virtual int	size () const
	Get the current size of the IDataPointSet, i.e. More...

virtual IDataPoint *	point (int index)
	Get the IDataPoint at a give index in the set. More...

virtual bool	setCoordinate (int coord, const std::vector< double > &val, const std::vector< double > &err)
	Set the values and errors of a given coordinate all at once. More...

virtual bool	setCoordinate (int coord, const std::vector< double > &val, const std::vector< double > &errp, const std::vector< double > &errm)
	Set the values and errors of a given coordinate all at once. More...

virtual const IDataPoint *	point (int index) const

virtual IDataPoint *	addPoint ()
	Add a new empty IDataPoint at the end of the set. More...

virtual bool	addPoint (const IDataPoint &point)
	Add a copy of an IDataPoint at the end of the set. More...

virtual bool	removePoint (int index)
	Remove the IDataPoint at a given index. More...

virtual double	lowerExtent (int coord) const
	Get the lower value for a give axis. More...

virtual double	upperExtent (int coord) const
	Get the upper value for a give axis. More...

virtual bool	scale (double scaleFactor)
	Scales the values and the errors of all the measurements of each point by a given factor. More...

virtual bool	scaleValues (double scaleFactor)
	Scales the values of all the measurements of each point by a given factor. More...

virtual bool	scaleErrors (double scaleFactor)
	Scales the errors of all the measurements of each point by a given factor. More...

virtual void *	cast (const std::string &className) const
	See IManagedObject for a description. More...

Public Member Functions inherited from AIDA::IDataPointSet
virtual	~IDataPointSet ()
	Destructor.

Detailed Description

Basic user-level interface class for holding and managing a single set of "data points".

Author: T. Kraemer, DESY

Version

Id:: IDataPointSetROOT.h,v 1.1 2006-12-08 10:58:59 tkraemer Exp

Member Function Documentation

IDataPoint * IDataPointSetROOT::addPoint ( )

virtual

Add a new empty IDataPoint at the end of the set.

Returns: The newly added point.

Implements AIDA::IDataPointSet.

bool IDataPointSetROOT::addPoint ( const IDataPoint & point )

virtual

Add a copy of an IDataPoint at the end of the set.

Parameters

point The IDataPoint to be added.

Returns: false If the point has the wrong dimension or if the point cannot be added.

Implements AIDA::IDataPointSet.

IAnnotation & IDataPointSetROOT::annotation ( )

virtual

Get the IAnnotation of the IDataPointSet.

Returns: The IAnnotation.

Implements AIDA::IDataPointSet.

void * IDataPointSetROOT::cast ( const std::string & className ) const

virtual

See IManagedObject for a description.

Parameters

className The name of the class to cast on.

Returns: The right pointer. Return 0 if failure.

Implements AIDA::IDataPointSet.

void IDataPointSetROOT::clear ( )

virtual

Remove all the IDataPoints in the set.

After this the IDataPointSet is as just created.

Implements AIDA::IDataPointSet.

int IDataPointSetROOT::dimension ( ) const

virtual

Get the dimension of the IDataPoints that can be stored in the set.

Returns: The dimension of the IDataPoints storable in the set.

Implements AIDA::IDataPointSet.

double IDataPointSetROOT::lowerExtent ( int coord ) const

virtual

Get the lower value for a give axis.

Parameters

coord The coordinate of the axis.

Returns: The lower edge of the corresponding axis. If coord < 0 or coord >= dimension(), or if the set is empty NaN is returned.

Implements AIDA::IDataPointSet.

IDataPoint * IDataPointSetROOT::point ( int index )

virtual

Get the IDataPoint at a give index in the set.

Parameters

index The IDataPoint index.

Returns: The corresponding IDataPoint.

Implements AIDA::IDataPointSet.

bool IDataPointSetROOT::removePoint ( int index )

virtual

Remove the IDataPoint at a given index.

Parameters

index The index of the IDataPoint to be removed.

Returns: false If the index is < 0 or >= size().

Implements AIDA::IDataPointSet.

bool IDataPointSetROOT::scale ( double scaleFactor )

virtual

Scales the values and the errors of all the measurements of each point by a given factor.

Parameters

scaleFactor The scale factor.

Returns: false If an illegal scaleFactor is provided.

Implements AIDA::IDataPointSet.

bool IDataPointSetROOT::scaleErrors ( double scaleFactor )

virtual

Scales the errors of all the measurements of each point by a given factor.

Parameters

scaleFactor The scale factor.

Returns: false If an illegal scaleFactor is provided.

Implements AIDA::IDataPointSet.

bool IDataPointSetROOT::scaleValues ( double scaleFactor )

virtual

Scales the values of all the measurements of each point by a given factor.

Parameters

scaleFactor The scale factor.

Returns: false If an illegal scaleFactor is provided.

Implements AIDA::IDataPointSet.

bool IDataPointSetROOT::setCoordinate	(	int	coord,
		const std::vector< double > &	val,
		const std::vector< double > &	err
	)

virtual

Set the values and errors of a given coordinate all at once.

If this method is called on an empty IDataPointSet, a number of points equal to the size of the arrays provided is created; if the IDataPointSet is not empty the dimension of the array must match with the size of the IDataPointSet.

Parameters

coord	The coordinate's index
val	The array of the values for the given coordinate
err	The array with the symmetric errors.

Returns: false if an illegal coordinate is provided or if there is a mismatch between the size of the array and the size of the IDataPointSet.

Implements AIDA::IDataPointSet.

bool IDataPointSetROOT::setCoordinate	(	int	coord,
		const std::vector< double > &	val,
		const std::vector< double > &	errp,
		const std::vector< double > &	errm
	)

virtual

Set the values and errors of a given coordinate all at once.

If this method is called on an empty IDataPointSet, a number of points equal to the size of the arrays provided is created; if the IDataPointSet is not empty the dimension of the array must match with the size of the IDataPointSet.

Parameters