ListTuple Class Reference

#include <ListTuple.h>

Inheritance diagram for ListTuple:

Inheritance graph
DataSourceObservable
[legend]
Collaboration diagram for ListTuple:

Collaboration graph
DataSourceObservable
[legend]
List of all members.

Detailed Description

A DataSource class implemented with a Python list to store the column data.

The data elements are stored in Python and are not copied or modified.

Note:
Some compilers do not handle the using boost::python completely correct, they see the name `list' in a declaration as an object name, not the boost type. Gcc 2.95.3 is one of them. Thus the implementation gives the full scoped name.
Todo:
Could implement addRow()
Author:
Paul F. Kunz <Paul_Kunz@slac.stanford.edu>

Definition at line 40 of file ListTuple.h.

Public Types

typedef void(Observer::*) Action (const Observable *)
 The member function of the Observer that is called.
typedef std::list< Observer * > ObserverList_t
 The type of STL container to maintain list of Observer objects.

Public Member Functions

virtual int addColumn (const std::string &label, const std::vector< double > &data)
 Adds column vector.
virtual int addColumn (const std::string &label, const std::vector< double > &data, const std::vector< intptr_t > &shape)
 Adds column vector.
int addColumn (const std::string &label, boost::python::list seq)
 Adds a column to the end of the ListTuple.
void addObserver (Observer *)
 Adds an Observer to the Observer list.
virtual void addRow (const std::vector< double > &row)
 Adds a row to the data source.
virtual void append (const DataSource *source)
 Appends the contents of the DataSource source.
virtual void clear ()
 Raises assertion because the contained Python list should not be changed.
unsigned int columns () const
 Returns the number of columns or data arrays available from this DataSource.
virtual void copy (const DataSource &)
 Raises an exception as with this release copying is not supported.
virtual double * doubleArrayAt (unsigned int row, unsigned int column) const
 Returns an array at row and column.
virtual bool empty () const
 Returns true, if ListTuple is empty, i.e.
virtual void eraseRow (unsigned int index)
 Erase a row from the data source.
virtual void expandIfNeeded (const std::vector< std::string > &labels) const
 Expand the multidimension column if needed.
virtual bool fillRange (unsigned int column, Range &) const
 Fills the Range object from data indexed by column.
virtual void fillShape (std::vector< int > &v, const std::string &label) const
 Fills the vector with the shape of a column.
virtual void fillShape (std::vector< int > &v, unsigned int column) const
 Fills the vector with the shape of a column.
virtual const std::vector<
double > & 
getColumn (unsigned int column) const
 Returns the data in the column with index column.
virtual const std::vector<
double > & 
getColumn (const std::string &name) const
 Returns the data in the column with label name.
const std::vector< std::string > & getDuplicatedLabels () const
 Returns the column labels that were duplicated, or an empty vector.
virtual const std::string & getLabelAt (unsigned int index) const
 Returns the label for the column at index index.
virtual const std::vector<
std::string > & 
getLabels () const
 Returns the list of available labels.
const std::string & getName () const
 Returns the name of the data source.
const ObserverList_tgetObservers () const
 Returns the list of observers.
unsigned int getRank () const
 Returns the rank of the data source.
virtual const std::vector<
double > & 
getRow (unsigned int index) const
 Returns a const reference to slice along the axis known as a row.
const std::vector< unsigned
int > & 
getShape () const
 Returns the shape of the data elements.
virtual int indexOf (const std::string &label) const
 Returns the index of the column whose label is label.
virtual unsigned int indexOfMaxElement (unsigned int index) const
 Returns row index of the maximum element in a column for the given column.
virtual unsigned int indexOfMinElement (unsigned int index) const
 Returns row index of the minimum element in a column for the given column.
virtual bool isMultiDimensional (const std::string &column) const
 Returns true if the column contains multidimensional data.
bool isNull () const
 Returns true if the receiving objects is a null object.
virtual bool isUseable (const std::string &column) const
 Returns true if the column is usable.
bool isValidLabel (const std::string &label) const
 Returns true if label is a valid label for a column in the DataSource.
 ListTuple ()
 The default constructor.
virtual void notifyObservers () const
 Notifies observers.
virtual double operator[] (std::vector< unsigned int > &indices) const
 Raises assertion because this method is not implemented yet.
void removeObserver (Observer *)
 Removes an Observer from the Observer list.
virtual void replaceColumn (const std::string &label, const std::vector< double > &data, const std::vector< intptr_t > &shape)
 Replaces or adds column vector.
virtual void replaceColumn (unsigned int index, const std::vector< double > &array)
 Replaces column at index with the contents of array.
virtual void replaceColumn (const std::string &label, const std::vector< double > &array)
 Replaces data in column label with contents of array.
void replaceColumn (const std::string &label, boost::python::list array)
 Replaces the column.
void replaceColumn (unsigned int index, boost::python::list array)
 Replaces the column indexed by index with the array.
virtual void reserve (unsigned int count)
 Raises assertion because the contained Python list should not be changed.
virtual unsigned int rows () const
 Returns the size of the slice for the next to last dimension.
virtual bool setLabelAt (const std::string &s, unsigned int index)
 Changes the label of a data column to s.
virtual void setLabels (const std::vector< std::string > &v)
 Assigns the label to each column from the vector of strings @ v.
void setName (const std::string &name)
 Sets the name of the data source.
virtual bool setReleventIndex (const std::string &column, const std::vector< unsigned int > &index)
 In case we are dealing with multidimensional data in rows of this column we would like to deal with on one entry of this multidimensional data.
virtual void setShape (std::vector< unsigned int > &shape)
 Sets the shape of the data elements.
virtual void setTitle (const std::string &title)
 Sets the title of the data source to title.
virtual double sum (unsigned int column) const
 Returns the sum of all the elements in the sequence of column column.
virtual void throwIfInvalidLabel (const std::string &label) const
 Throws a DataSourceException object if label is not a valid label for this DataSource.
void throwIfInvalidRowSize (const std::vector< double > &row)
 Throws a DataSourceException if the size of the row is not equal to the number of columns, otherwise does nothing.
const std::string & title () const
 Returns a const reference to the title of the data source.
virtual double valueAt (unsigned int row, unsigned int column) const
 Returns the value in the table in position given by the row and column indexes.
virtual double valueAtNoCache (unsigned int row, unsigned int column) const
 Returns the value in the table in position given by the row and column indexes without storing it into cache.
virtual ~ListTuple ()
 The destructor.

Protected Member Functions

virtual void addLabel (const std::string &label)
 Adds a new label for a column.
virtual void checkWidth (const DataSource *source)
 Checks the number of columns.
virtual void copyPrivate (const DataSource &other)
 Copies the contents of the other DataSource.
bool isValidColumn (unsigned int index) const
 Returns true if index is valid, otherwise throws a DataSourceException.
void notifyObservers (Action action) const
 An internal method to iterate over all observers and to send the message action.

Protected Attributes

std::vector< double > m_array
 A temporary array that can be returned by const reference.
std::vector< std::string > m_dups
 A list of labels that duplicated others in a DataSource file.
std::vector< unsigned int > m_shape
 The shape of the data.

Private Member Functions

bool isAcceptable (const boost::python::list &seq)
 Returns true if all the elements of the list seq can be converted to type double, otherwise returns false.

Private Attributes

std::vector< boost::python::listm_data
 The numarray objects that contains the data.
std::vector< double > m_row
 A temporary array of data from one row of each column.


Member Typedef Documentation

typedef void( Observer::*) Action(const Observable *) [inherited]

The member function of the Observer that is called.

Definition at line 86 of file Observable.h.

typedef std::list< Observer * > ObserverList_t [inherited]

The type of STL container to maintain list of Observer objects.

Definition at line 45 of file Observable.h.


Constructor & Destructor Documentation

ListTuple (  ) 

The default constructor.

Definition at line 67 of file ListTuple.cxx.

~ListTuple (  )  [virtual]

The destructor.

Definition at line 72 of file ListTuple.cxx.


Member Function Documentation

int addColumn ( const std::string &  label,
const std::vector< double > &  data 
) [virtual, inherited]

Adds column vector.

If implemented in a derived class, adds a new column with label and returns its index.

Note:
Not all derived classes support the notion of adding columns. The implementation in this base class throws a std::runtime_error object if called.

Reimplemented in NTuple, FitsNTuple, PyNTuple, QtRootNTuple, and RootNTuple.

Definition at line 390 of file DataSource.cxx.

int addColumn ( const std::string &  label,
const std::vector< double > &  data,
const std::vector< intptr_t > &  shape 
) [virtual, inherited]

Adds column vector.

Adds a new column with label and returns its index. The number of rows, as defined by first element of the shape, must be the same as existing columns, if any. Not all derived classes support the notion of shape, therefore as convenience to developers, the implementation in this base class throws a std::runtime_error object.

Reimplemented in FitsNTuple.

Definition at line 400 of file DataSource.cxx.

int addColumn ( const std::string &  label,
boost::python::list  seq 
)

Adds a column to the end of the ListTuple.

If the size of the input array is the same as the size of the existing columns adds input array to then end of the ListTuple . Gives the column the label label. Returns the index of the newly created column. If the size of the input array differs from the size of existing columns or if the label already exists, then throws a DataSourceException object.

Definition at line 167 of file ListTuple.cxx.

References DataSource::addLabel(), getSize(), DataSource::indexOf(), ListTuple::isAcceptable(), ListTuple::m_data, and ListTuple::rows().

Referenced by PyDataSource::addColumn(), hippodraw::Python::export_ListTuple(), and PyDataSource::saveColumnFromNumArray().

void addLabel ( const std::string &  label  )  [protected, virtual, inherited]

Adds a new label for a column.

Definition at line 154 of file DataSource.cxx.

References DataSource::m_labels.

Referenced by RootNTuple::addColumn(), NumArrayTuple::addColumn(), NTuple::addColumn(), ListTuple::addColumn(), and FitsNTuple::addColumn().

void addObserver ( Observer  )  [inherited]

Adds an Observer to the Observer list.

Definition at line 52 of file Observable.cxx.

References Observable::m_list.

Referenced by XyPlotter::addDataRep(), FunctionRep::FunctionRep(), BinningProjector::normalizeTo(), DataRepController::setAxisBindings(), DisplayController::setNTuple(), CutPlotter::setNTuple(), and TextPlotter::setParentDataRep().

void addRow ( const std::vector< double > &  row  )  [virtual, inherited]

Adds a row to the data source.

Since most derived classes are not capable of adding a row, the implementation of this member functions throws std::runtime_error.

Reimplemented in CircularBuffer, NTuple, RTuple, and PyNTuple.

Definition at line 548 of file DataSource.cxx.

Referenced by DataSource::append().

void append ( const DataSource source  )  [virtual, inherited]

Appends the contents of the DataSource source.

Appends the contents of the DataSource source to end by adding rows.

Note:
If a derived class has a more efficient way of appending, it should override this method.

Reimplemented in NTuple, and PyNTuple.

Definition at line 580 of file DataSource.cxx.

References DataSource::addRow(), DataSource::checkWidth(), DataSource::getRow(), DataSource::rows(), and num_util::size().

Referenced by NTuple::append().

void checkWidth ( const DataSource source  )  [protected, virtual, inherited]

Checks the number of columns.

Check that the number of columns of source is the same as the receiving object. Throws a std::runtime_error if they are different, otherwise does nothing.

Definition at line 565 of file DataSource.cxx.

References DataSource::columns(), and hippodraw::String::convert().

Referenced by NTuple::append(), and DataSource::append().

void clear (  )  [virtual]

Raises assertion because the contained Python list should not be changed.

Implements DataSource.

Definition at line 251 of file ListTuple.cxx.

unsigned int columns (  )  const [inline, inherited]

Returns the number of columns or data arrays available from this DataSource.

Note:
This function was selected to be in line sine it contributes heavily in time for addRow member function.

Reimplemented in QtRootNTuple.

Definition at line 458 of file DataSource.h.

References DataSource::m_labels.

Referenced by PyDataSource::addColumn(), ProfileProjector::changedNTuple(), Profile2DProjector::changedNTuple(), MeshProjector::changedNTuple(), MapMatrixProjector::changedNTuple(), Map3Projector::changedNTuple(), Map2Projector::changedNTuple(), Map1Projector::changedNTuple(), EqualEntriesHist1DProjector::changedNTuple(), DyHist2DProjector::changedNTuple(), DyHist1DProjector::changedNTuple(), DataSource::checkWidth(), QtRootNTuple::columns(), PyDataSource::columns(), NTupleSorter::columns(), NTuple::copy(), CreateNTuple::createButtonClicked(), NTupleXML::createChildren(), NTupleProjector::createEmptyNTuple(), NTupleProjector::dataRange(), NTupleProjector::dataRangeWithError(), hippodraw::Python::export_CircularBuffer(), hippodraw::Python::export_DataSource(), DataSource::fillRange(), NTuple::getColumn(), NumArrayTuple::getNumArray(), NTupleProjector::getPos(), NTupleProjector::getPosWithError(), NTuple::getRow(), DataSource::indexOfMaxElement(), DataSource::indexOfMinElement(), DataSource::isValidColumn(), RTuple::operator[](), RootNTuple::replaceColumn(), NumArrayTuple::replaceColumn(), NTuple::replaceColumn(), ListTuple::replaceColumn(), FitsNTuple::replaceColumn(), NTuple::setLabels(), DataSource::sum(), and DataSource::throwIfInvalidRowSize().

void copy ( const DataSource  )  [virtual]

Raises an exception as with this release copying is not supported.

Definition at line 78 of file ListTuple.cxx.

void copyPrivate ( const DataSource other  )  [protected, virtual, inherited]

Copies the contents of the other DataSource.

For use by derived classes only.

Definition at line 114 of file DataSource.cxx.

References DataSource::m_ds_name, DataSource::m_is_null, DataSource::m_labels, DataSource::m_shape, and DataSource::m_title.

Referenced by RTuple::copy(), and NTuple::copy().

double * doubleArrayAt ( unsigned int  row,
unsigned int  column 
) const [virtual, inherited]

Returns an array at row and column.

If the DataSource is capable of containing an array in a column, then returns pointer to the array for a single row, otherwise throws std::runtime_error exception.

Reimplemented in FitsNTuple, and RootNTuple.

Definition at line 593 of file DataSource.cxx.

bool empty (  )  const [virtual]

Returns true, if ListTuple is empty, i.e.

has no data.

Implements DataSource.

Definition at line 106 of file ListTuple.cxx.

References ListTuple::rows().

void eraseRow ( unsigned int  index  )  [virtual, inherited]

Erase a row from the data source.

The implementation throws std::runtime_error.

Reimplemented in NTuple.

Definition at line 556 of file DataSource.cxx.

void expandIfNeeded ( const std::vector< std::string > &  labels  )  const [virtual, inherited]

Expand the multidimension column if needed.

Do nothing in base class. Reimplemented in RootNTuple.

Reimplemented in QtRootNTuple, and RootNTuple.

Definition at line 602 of file DataSource.cxx.

Referenced by DataRepController::createDataRep(), and DisplayController::createDisplay().

bool fillRange ( unsigned int  column,
Range  
) const [virtual, inherited]

Fills the Range object from data indexed by column.

Returns true if all the data in the column was valid, otherwise returns false. Invalid data is +/- HUGE_VAL or NAN. Invalid data is not used in setting the range.

Reimplemented in NTuple, and FitsNTuple.

Definition at line 415 of file DataSource.cxx.

References DataSource::columns(), DataSource::rows(), Range::setRange(), num_util::size(), and DataSource::valueAt().

void fillShape ( std::vector< int > &  v,
const std::string &  label 
) const [virtual, inherited]

Fills the vector with the shape of a column.

Returns via the vector v, the shape of the data at column column. Most derived classes will only support a vector in a column. Thus as convenience to implementers of derived classes the implementation of this base class returns a shape of size 1 containing the number of rows.

Definition at line 328 of file DataSource.cxx.

References DataSource::fillShape(), and DataSource::indexOf().

void fillShape ( std::vector< int > &  v,
unsigned int  column 
) const [virtual, inherited]

Fills the vector with the shape of a column.

Returns via the vector v, the shape of the data at column column. Most derived classes will only support a vector in a column. Thus as convenience to implementers of derived classes this base class implementation returns a shape of size 1 containing the number of rows.

Reimplemented in RootNTuple.

Definition at line 320 of file DataSource.cxx.

References DataSource::rows().

Referenced by DataSource::fillShape().

const vector< double > & getColumn ( unsigned int  column  )  const [virtual, inherited]

Returns the data in the column with index column.

Reimplemented in NTuple, FitsNTuple, QtRootNTuple, and RootNTuple.

Definition at line 228 of file DataSource.cxx.

References DataSource::isValidColumn(), DataSource::m_array, DataSource::rows(), num_util::size(), and DataSource::valueAt().

const vector< double > & getColumn ( const std::string &  name  )  const [virtual, inherited]

Returns the data in the column with label name.

Reimplemented in NTuple, QtRootNTuple, and RootNTuple.

Definition at line 243 of file DataSource.cxx.

References DataSource::indexOf().

Referenced by PyDataSource::columnAsNumArray(), NTupleXML::createChildren2D(), hippodraw::Python::export_DataSource(), NTupleProjector::fillColumnAfterCuts(), PyDataSource::getColumn(), and ProjectorBase::getZValues().

const vector< string > & getDuplicatedLabels (  )  const [inherited]

Returns the column labels that were duplicated, or an empty vector.

Definition at line 534 of file DataSource.cxx.

References DataSource::m_dups.

const string & getLabelAt ( unsigned int  index  )  const [virtual, inherited]

Returns the label for the column at index index.

Returns the label for the column at index index, or throws a DataSourceException if index is out of range.

Definition at line 179 of file DataSource.cxx.

References DataSource::isNull(), DataSource::m_labels, and DataSource::title().

Referenced by NTupleXML::createChildren2D(), hippodraw::Python::export_ListTuple(), hippodraw::Python::export_NTuple(), hippodraw::Python::export_NumArrayTuple(), NTupleProjector::getAxisBindings(), NTupleProjector::getXLabel(), NTupleProjector::getYLabel(), Map1Projector::getYLabel(), Profile2DProjector::getZLabel(), MeshProjector::getZLabel(), MapMatrixProjector::getZLabel(), and Map3Projector::getZLabel().

const vector< string > & getLabels (  )  const [virtual, inherited]

Returns the list of available labels.

Reimplemented in QtRootNTuple.

Definition at line 172 of file DataSource.cxx.

References DataSource::m_labels.

Referenced by Inspector::availPlotTypesActivated(), NTupleProjector::createEmptyNTuple(), hippodraw::Python::export_DataSource(), DisplayController::getDataSourceLabels(), QtRootNTuple::getLabels(), PyDataSource::getLabels(), RootNTuple::getRow(), PyDataSource::replaceColumn(), RootNTuple::smartExpandRootNTuple(), Inspector::updateCutVarGroupBox(), and NTupleController::writeNTupleToFile().

const string & getName (  )  const [inherited]

Returns the name of the data source.

See also:
m_ds_name.

Definition at line 136 of file DataSource.cxx.

References DataSource::m_ds_name.

Referenced by HiNTupleXML::createElement(), NTupleProjector::getNTupleName(), DataSourceController::registerNTuple(), and NTupleXML::setAttributes().

const Observable::ObserverList_t & getObservers (  )  const [inherited]

Returns the list of observers.

Definition at line 60 of file Observable.cxx.

References Observable::m_list.

unsigned int getRank (  )  const [inherited]

Returns the rank of the data source.

Returns the number of axes of the data source, i.e the rank.

Definition at line 343 of file DataSource.cxx.

References DataSource::m_shape.

Referenced by RTuple::operator[](), NTuple::operator[](), and RootNTuple::smartExpandRootNTuple().

const std::vector< double > & getRow ( unsigned int  row  )  const [virtual]

Returns a const reference to slice along the axis known as a row.

Todo:
Could bypass calling valueAt if performance is shown to be an issue.

Implements DataSource.

Definition at line 135 of file ListTuple.cxx.

References ListTuple::m_data, ListTuple::m_row, num_util::size(), and ListTuple::valueAt().

const vector< unsigned int > & getShape (  )  const [virtual]

Returns the shape of the data elements.

Reimplemented from DataSource.

Definition at line 245 of file ListTuple.cxx.

References DataSource::m_shape.

int indexOf ( const std::string &  label  )  const [virtual, inherited]

Returns the index of the column whose label is label.

Returns the index of the data column whose label is label, or -1 if label does not exist.

Definition at line 193 of file DataSource.cxx.

References DataSource::m_labels.

Referenced by RootNTuple::addColumn(), NumArrayTuple::addColumn(), NTuple::addColumn(), ListTuple::addColumn(), NTupleController::createNTuple(), DataSource::fillShape(), RootNTuple::getColumn(), NTuple::getColumn(), DataSource::getColumn(), QtRootNTuple::getColumnAsArray(), QtRootNTuple::getColumnShape(), NumArrayTuple::getNumArray(), RootNTuple::getTBranch(), NTupleProjector::indexOf(), RootNTuple::initBranches(), FitsNTuple::initColumns(), RootNTuple::isMultiDimensional(), RootNTuple::isUseable(), NumArrayTuple::replaceColumn(), ListTuple::replaceColumn(), FitsNTuple::replaceColumn(), DataSource::replaceColumn(), NTupleProjector::setAxisBinding(), RootNTuple::setReleventIndex(), RootNTuple::smartExpandRootNTuple(), and QtRootNTuple::valueAt().

unsigned int indexOfMaxElement ( unsigned int  index  )  const [virtual, inherited]

Returns row index of the maximum element in a column for the given column.

Reimplemented in NTuple.

Definition at line 476 of file DataSource.cxx.

References DataSource::columns(), DataSource::rows(), num_util::size(), and DataSource::valueAt().

unsigned int indexOfMinElement ( unsigned int  index  )  const [virtual, inherited]

Returns row index of the minimum element in a column for the given column.

Reimplemented in NTuple.

Definition at line 497 of file DataSource.cxx.

References DataSource::columns(), DataSource::rows(), num_util::size(), and DataSource::valueAt().

bool isAcceptable ( const boost::python::list seq  )  [private]

Returns true if all the elements of the list seq can be converted to type double, otherwise returns false.

Definition at line 148 of file ListTuple.cxx.

References getSize(), and num_util::size().

Referenced by ListTuple::addColumn().

bool isMultiDimensional ( const std::string &  column  )  const [virtual, inherited]

Returns true if the column contains multidimensional data.

Returns false. Derived classes should return true if the column contains multidimensional data.

Reimplemented in QtRootNTuple, and RootNTuple.

Definition at line 451 of file DataSource.cxx.

bool isNull (  )  const [inherited]

Returns true if the receiving objects is a null object.

See also:
DataSource( bool ).

Definition at line 125 of file DataSource.cxx.

References DataSource::m_is_null.

Referenced by ProfileProjector::execute(), Profile2DProjector::execute(), DataSource::getLabelAt(), NTupleProjector::NTupleProjector(), NTupleProjector::setNTuple(), and NTupleProjector::~NTupleProjector().

bool isUseable ( const std::string &  column  )  const [virtual, inherited]

Returns true if the column is usable.

Returns true. Derived classes should return false if the column is not usable in the context of a DataSource.

Reimplemented in RootNTuple.

Definition at line 458 of file DataSource.cxx.

bool isValidColumn ( unsigned int  index  )  const [protected, inherited]

Returns true if index is valid, otherwise throws a DataSourceException.

Definition at line 212 of file DataSource.cxx.

References DataSource::columns(), hippodraw::String::convert(), and num_util::size().

Referenced by RootNTuple::getColumn(), NTuple::getColumn(), FitsNTuple::getColumn(), and DataSource::getColumn().

bool isValidLabel ( const std::string &  label  )  const [inherited]

Returns true if label is a valid label for a column in the DataSource.

The search is case sensitive. If the label is not found, returns false.

Definition at line 257 of file DataSource.cxx.

References DataSource::m_labels.

Referenced by FitsNTuple::checkLabel(), and DataSource::throwIfInvalidLabel().

void notifyObservers ( Action  action  )  const [protected, inherited]

An internal method to iterate over all observers and to send the message action.

Definition at line 72 of file Observable.cxx.

References Observable::m_list.

void notifyObservers (  )  const [virtual]

Notifies observers.

Todo:
remove this method when Observable is exposed to Python.

Reimplemented from Observable.

Definition at line 85 of file ListTuple.cxx.

References Observable::notifyObservers().

Referenced by hippodraw::Python::export_ListTuple(), and ListTuple::replaceColumn().

double operator[] ( std::vector< unsigned int > &  indices  )  const [virtual]

Raises assertion because this method is not implemented yet.

Implements DataSource.

Definition at line 265 of file ListTuple.cxx.

void removeObserver ( Observer  )  [inherited]

Removes an Observer from the Observer list.

Definition at line 66 of file Observable.cxx.

References Observable::m_list.

Referenced by BinningProjector::normalizeTo(), CutPlotter::removeFromTarget(), DisplayController::removeTextObservers(), NTupleProjector::setNTuple(), FunctionRep::willDelete(), FunctionRep::~FunctionRep(), and NTupleProjector::~NTupleProjector().

void replaceColumn ( const std::string &  label,
const std::vector< double > &  data,
const std::vector< intptr_t > &  shape 
) [virtual, inherited]

Replaces or adds column vector.

If column label exists, replaces that column with data, otherwise adds a new column with label. In both cases, the number of rows, as defined by first element of the shape, must be the same as existing columns, if any. Not all derived classes support the notion of shape, therefore as convenience to developers, the implementation in this base class throws a std::runtime_error object.

Reimplemented in FitsNTuple.

Definition at line 378 of file DataSource.cxx.

void replaceColumn ( unsigned int  index,
const std::vector< double > &  array 
) [virtual, inherited]

Replaces column at index with the contents of array.

Note:
Not all derived classes support replacing a column and a std::runtime_error may be thrown if called.

Reimplemented in NTuple, FitsNTuple, PyNTuple, and RootNTuple.

Definition at line 350 of file DataSource.cxx.

void replaceColumn ( const std::string &  label,
const std::vector< double > &  array 
) [virtual, inherited]

Replaces data in column label with contents of array.

If column label label exists, replace it contents with array, otherwise throw std::runtime_error.

Note:
Not all derived classes support replacing a column and this base class implementation throws a std::runtime_error if called.

Reimplemented in PyNTuple.

Definition at line 360 of file DataSource.cxx.

References DataSource::indexOf().

Referenced by hippodraw::Python::export_DataSource(), hippodraw::Python::export_FitsNTuple(), PyNTuple::replaceColumn(), and PyDataSource::saveColumnFromNumArray().

void replaceColumn ( const std::string &  label,
boost::python::list  array 
)

Replaces the column.

Replaces the numarray at the column with label label. This is a convenience member function for using indexOf() and replaceColumn ( unsigned int, boost::python::list array ).

Definition at line 228 of file ListTuple.cxx.

References DataSource::indexOf(), and ListTuple::replaceColumn().

void replaceColumn ( unsigned int  index,
boost::python::list  array 
)

Replaces the column indexed by index with the array.

If a column with index doesn't exits or if the column to be replace is not empty and the size of array is not the same as existing columns, then a DataSourceException is thrown.

Definition at line 203 of file ListTuple.cxx.

References DataSource::columns(), getSize(), ListTuple::m_data, ListTuple::notifyObservers(), and num_util::size().

Referenced by hippodraw::Python::export_ListTuple(), PyDataSource::replaceColumn(), ListTuple::replaceColumn(), and PyDataSource::saveColumnFromNumArray().

void reserve ( unsigned int  count  )  [virtual]

Raises assertion because the contained Python list should not be changed.

Implements DataSource.

Definition at line 258 of file ListTuple.cxx.

unsigned int rows (  )  const [virtual]

Returns the size of the slice for the next to last dimension.

Implements DataSource.

Definition at line 92 of file ListTuple.cxx.

References getSize(), ListTuple::m_data, and num_util::size().

Referenced by ListTuple::addColumn(), and ListTuple::empty().

bool setLabelAt ( const std::string &  s,
unsigned int  index 
) [virtual, inherited]

Changes the label of a data column to s.

Parameters:
s the new label.
index the column number starting at zero.
Returns:
true if index is less than the width of the data source; otherwise, it does nothing and returns false.

Definition at line 161 of file DataSource.cxx.

References DataSource::m_labels, and Observable::notifyObservers().

void setLabels ( const std::vector< std::string > &  v  )  [virtual, inherited]

Assigns the label to each column from the vector of strings @ v.

Reimplemented in NTuple.

Definition at line 297 of file DataSource.cxx.

References DataSource::m_labels, and Observable::notifyObservers().

Referenced by hippodraw::Python::export_ListTuple(), hippodraw::Python::export_NumArrayTuple(), RTuple::RTuple(), and NTuple::setLabels().

void setName ( const std::string &  name  )  [inherited]

Sets the name of the data source.

See also:
m_ds_name.

Definition at line 130 of file DataSource.cxx.

References DataSource::m_ds_name, and Observable::notifyObservers().

Referenced by hippodraw::Python::export_DataSource(), PyDataSource::registerNTuple(), DataSourceController::registerNTuple(), and PyDataSource::setName().

bool setReleventIndex ( const std::string &  column,
const std::vector< unsigned int > &  index 
) [virtual, inherited]

In case we are dealing with multidimensional data in rows of this column we would like to deal with on one entry of this multidimensional data.

So here we set index of this relevant entry.

Reimplemented in RootNTuple.

Definition at line 465 of file DataSource.cxx.

void setShape ( std::vector< unsigned int > &  shape  )  [virtual]

Sets the shape of the data elements.

Sets the shape data elements from the vector shape. The rank is given by the size of the vector. A rank of 2 correspond to table. If the total number of elements in the ListTuple is not equal to the product of the shape, then an assertion is raised.

Reimplemented from DataSource.

Definition at line 238 of file ListTuple.cxx.

References DataSource::m_shape.

void setTitle ( const std::string &  title  )  [virtual, inherited]

Sets the title of the data source to title.

Reimplemented in PyNTuple.

Definition at line 146 of file DataSource.cxx.

References DataSource::m_title, and Observable::notifyObservers().

Referenced by hippodraw::Python::export_DataSource(), NTupleController::readAsciiNTuple(), PyNTuple::setTitle(), and PyDataSource::setTitle().

double sum ( unsigned int  column  )  const [virtual, inherited]

Returns the sum of all the elements in the sequence of column column.

Reimplemented in NTuple.

Definition at line 518 of file DataSource.cxx.

References DataSource::columns(), DataSource::rows(), num_util::size(), and DataSource::valueAt().

void throwIfInvalidLabel ( const std::string &  label  )  const [virtual, inherited]

Throws a DataSourceException object if label is not a valid label for this DataSource.

The exception object contains a message that the label is invalid. Derived classes may over-ride this method with more information on why the label is invalid.

Definition at line 268 of file DataSource.cxx.

References DataSource::isValidLabel().

Referenced by RootNTuple::getColumn(), NTuple::getColumn(), QtRootNTuple::getColumnAsArray(), and QtRootNTuple::valueAt().

void throwIfInvalidRowSize ( const std::vector< double > &  row  )  [inherited]

Throws a DataSourceException if the size of the row is not equal to the number of columns, otherwise does nothing.

Definition at line 281 of file DataSource.cxx.

References DataSource::columns(), hippodraw::String::convert(), and num_util::size().

Referenced by RTuple::addRow(), NTuple::addRow(), and NTuple::replaceRow().

const string & title (  )  const [inherited]

Returns a const reference to the title of the data source.

Definition at line 141 of file DataSource.cxx.

References DataSource::m_title.

Referenced by hippodraw::Python::export_DataSource(), DataSource::getLabelAt(), PyDataSource::getTitle(), NTupleProjector::getTitle(), and NTupleController::writeNTupleToFile().

double valueAt ( unsigned int  row,
unsigned int  column 
) const [virtual]

Returns the value in the table in position given by the row and column indexes.

Implements DataSource.

Definition at line 113 of file ListTuple.cxx.

References getSize(), ListTuple::m_data, and num_util::size().

Referenced by ListTuple::getRow().

double valueAtNoCache ( unsigned int  row,
unsigned int  column 
) const [virtual, inherited]

Returns the value in the table in position given by the row and column indexes without storing it into cache.

Reimplemented in RootNTuple.

Definition at line 541 of file DataSource.cxx.

References DataSource::valueAt().

Referenced by NTupleController::createNTuple().


Member Data Documentation

std::vector< double > m_array [mutable, protected, inherited]

A temporary array that can be returned by const reference.

Definition at line 88 of file DataSource.h.

Referenced by DataSource::getColumn(), RootNTuple::getRow(), and FitsNTuple::getRow().

std::vector< boost::python::list > m_data [private]

The numarray objects that contains the data.

Definition at line 47 of file ListTuple.h.

Referenced by ListTuple::addColumn(), ListTuple::getRow(), ListTuple::replaceColumn(), ListTuple::rows(), and ListTuple::valueAt().

std::vector< std::string > m_dups [protected, inherited]

A list of labels that duplicated others in a DataSource file.

Definition at line 100 of file DataSource.h.

Referenced by DataSource::getDuplicatedLabels(), RootNTuple::initBranches(), and FitsNTuple::initColumns().

std::vector< double > m_row [mutable, private]

A temporary array of data from one row of each column.

The object is mutable because some const member functions fill it.

Definition at line 53 of file ListTuple.h.

Referenced by ListTuple::getRow().

std::vector< unsigned int > m_shape [protected, inherited]

The shape of the data.

The elements the DataSource can have an arbitrary number of dimensions, called rank. An ordinary table has rank of 2 and the shape is number of columns and number of rows. That is m_shape[0] is number of columns and m_share[1] is number of rows.

Definition at line 96 of file DataSource.h.

Referenced by DataSource::copyPrivate(), DataSource::getRank(), RootNTuple::getShape(), NumArrayTuple::getShape(), ListTuple::getShape(), FitsNTuple::getShape(), DataSource::getShape(), RTuple::operator[](), NTuple::operator[](), RootNTuple::setShape(), NumArrayTuple::setShape(), ListTuple::setShape(), FitsNTuple::setShape(), and DataSource::setShape().


The documentation for this class was generated from the following files:
Generated for HippoDraw Class Library by doxygen