hippodraw::Python Namespace Reference

---

Detailed Description

A namespace encapsulating functions to interface HippoDraw classes to Python using Boost.Python.

For the list of C++ member functions that are exported, see which functions are referenced by the functions declared in this name space.

Requests:

Make it possible to disable the build of the Boost.Python module with configure.

Requests:

A suggestion in C++sig Python mailing list suggests putting things in anonymous name space so as to expose less symbols to linker and therefore speeding up linking and loading time.

Requests:

On Mac OS X, get lots of warning messages about use of long double, must have a gcc flag to fix that.

Author:

Paul F. Kunz <Paul_Kunz@slac.stanford.edu>

Matthew Langston <langston@slac.stanford.edu>

Functions
void	export_Canvas ()
	Exports the PyCanvas class to Python.
void	export_CanvasWindow ()
	Exports the CanvasWindow class to Python.
void	export_CircularBuffer ()
	Exports the CircularBuffer class to Python.
void	export_DataArray ()
	Export PyDataSourceWrapper.
void	export_DataRep ()
	Exports the PyDataRep class to Python.
void	export_DataSource ()
	Exports the DataSource class to Python.
void	export_Factory_PointRep ()
	Exports the template base class of PointRepFactory.
void	export_FCNBase ()
	Export the base class of objective functions.
void	export_FitsController ()
	Exports the FitsController.
void	export_FitsNTuple ()
	Exports the FitsNTuple.
void	export_Fitter ()
	Exports the Fitter class to Python.
void	export_FitterFactory ()
	Exports the FitterFactory.
void	export_Function ()
	Exports the PyFunctionRep class to Python.
void	export_FunctionBase ()
	Export the FunctionBase and its FunctionWrap.
void	export_FunctionFactory ()
	Exports the FitterFactory.
void	export_HDApp ()
	Exports the PyApp class to Python.
void	export_ListTuple ()
	Exports the ListTuple class to Python.
void	export_NTuple ()
	Exports the NTuple class to Python.
void	export_NTupleController ()
	Exports the NTupleController class to Python.
void	export_NTupleFCN ()
	Exports the base class of data source objective functions.
void	export_NumArrayTuple ()
	Exports the NumArrayTuple class to Python.
void	export_Observer ()
	Exports the Observer class to Python.
void	export_PointRepFactory ()
	Exports the PointRepFactory class to Python.
void	export_QtCut ()
	Exports the QtCut class to Python.
void	export_QtDisplay ()
	Exports the QtDisplay class to Python.
void	export_RepBase ()
	Exports the RepBase class to Python.
void	export_RootController ()
	Exports the RootController.
void	export_RootNTuple ()
	Exports the RootNTuple.
void	export_StatedFCN ()
	Export the base class of stated objective functions.
void	exportToPython ()
	Exports HippoDraw C++ classes to Python.
void	PyDataSourceExceptionTranslator (const PyDataSource::StopIteration &e)
void	translate (const std::exception &e)
	Translate a C++ exception to a Python one.

---

Function Documentation

void hippodraw::Python::export_Canvas (   )

Exports the PyCanvas class to Python. PyCanvas class Definition at line 43 of file PyCanvas.cxx. References PyCanvas::addDisplay(), PyCanvas::addText(), PyCanvas::addTextAt(), PyCanvas::addTextRep(), PyCanvas::clear(), PyCanvas::close(), PyCanvas::getCut(), PyCanvas::getDisplay(), PyCanvas::getDisplays(), PyCanvas::getTextRepTypes(), PyCanvas::mouseData(), PyCanvas::print(), PyCanvas::removeDisplay(), PyCanvas::saveAs(), PyCanvas::saveAsImage(), PyCanvas::saveSelectedImages(), PyCanvas::selectAllDisplays(), PyCanvas::selectDisplay(), PyCanvas::setPlotMatrix(), and PyCanvas::show(). Referenced by exportToPython().

void hippodraw::Python::export_CanvasWindow (   )

Exports the CanvasWindow class to Python. Directly exports CanvasWindow to Python. There is no locking and unlocking of QApplication singleton object, so this object must be instantiated from the same thread as the QApplication object. Definition at line 31 of file export_CanvasWindow.cxx. References CanvasWindow::fileNew(). Referenced by exportToPython().

void hippodraw::Python::export_CircularBuffer (   )

Exports the CircularBuffer class to Python. Directly exports CircularBuffer to Python. There is no locking and unlocking of the QApplication singleton object. However, since invoking member functions of this class do not directly change the GUI, they may be invoked from any thread. Definition at line 36 of file export_CircularBuffer.cxx. References CircularBuffer::addRow(), CircularBuffer::clear(), DataSource::columns(), CircularBuffer::reserve(), and NTuple::rows(). Referenced by exportToPython().

void hippodraw::Python::export_DataArray (   )

Export PyDataSourceWrapper. Definition at line 53 of file PyDataSource.cxx. References PyDataSource::addColumn(), PyDataSource::columnAsNumArray(), PyDataSource::columns(), PyDataSource::dataSource(), PyDataSource::getColumn(), PyDataSource::getLabels(), PyDataSource::getTitle(), PyDataSource::hasColumn(), PyDataSourceExceptionTranslator(), PyDataSource::registerNTuple(), PyDataSource::replaceColumn(), PyDataSource::rows(), PyDataSource::saveColumnFromNumArray(), PyDataSource::setName(), and PyDataSource::setTitle(). Referenced by exportToPython().

void hippodraw::Python::export_DataRep (   )

Exports the PyDataRep class to Python. Definition at line 49 of file PyDataRep.cxx. References PyDataRep::applyCut(), PyDataRep::createNTuple(), PyDataRep::getBinWidth(), PyDataRep::getMean(), PyDataRep::getNTupleWithCuts(), PyDataRep::getRMS(), PyDataRep::name(), PyDataRep::normalizeTo(), PyDataRep::numberOfEntries(), PyDataRep::setAxisBinding(), PyDataRep::setAxisBindings(), PyDataRep::setBinWidth(), PyDataRep::setColor(), PyDataRep::setErrorDisplay(), PyDataRep::setLineStyle(), PyDataRep::setPointRep(), PyDataRep::setSymbol(), and PyDataRep::setWeight(). Referenced by exportToPython().

void hippodraw::Python::export_DataSource (   )

Exports the DataSource class to Python. Directly exports the DataSource class to Python. There is no locking and unlocking of the QApplication singleton object. However, since invoking member functions of this class do not directly change the GUI, they may be invoked from any thread. Definition at line 37 of file export_DataSource.cxx. References DataSource::clear(), DataSource::columns(), DataSource::getColumn(), DataSource::getLabels(), DataSource::rows(), DataSource::setName(), DataSource::setTitle(), and DataSource::title(). Referenced by exportToPython().

void hippodraw::Python::export_Factory_PointRep (   )

Exports the template base class of PointRepFactory. Definition at line 39 of file export_PointRepFactory.cxx. Referenced by exportToPython().

void hippodraw::Python::export_FCNBase (   )

Export the base class of objective functions. Definition at line 38 of file export_FCNBase.cxx. Referenced by exportToPython().

void hippodraw::Python::export_FitsController (   )

Exports the FitsController. Definition at line 44 of file PyFitsController.cxx. References PyFitsController::createDataArray(), PyFitsController::createNTuple(), PyFitsController::getNTupleNames(), and PyFitsController::instance(). Referenced by exportToPython().

void hippodraw::Python::export_FitsNTuple (   )

Exports the FitsNTuple. Definition at line 37 of file export_FitsNTuple.cxx. References FitsNTuple::addColumn(), and FitsNTuple::replaceColumn(). Referenced by exportToPython().

void hippodraw::Python::export_Fitter (   )

Exports the Fitter class to Python. Definition at line 39 of file export_Fitter.cxx. References Fitter::calcBestFit(), Fitter::calcDegreesOfFreedom(), Fitter::getFCN(), Fitter::name(), Fitter::objectiveValue(), Fitter::setFixedFlags(), Fitter::setLimits(), and Fitter::setStepSize(). Referenced by exportToPython().

void hippodraw::Python::export_FitterFactory (   )

Exports the FitterFactory. Definition at line 38 of file export_FitterFactory.cxx. References Factory< Fitter >::create(), FitterFactory::instance(), and Factory< Fitter >::names(). Referenced by exportToPython().

void hippodraw::Python::export_Function (   )

Exports the PyFunctionRep class to Python. Definition at line 41 of file PyFunctionRep.cxx. References PyFunctionRep::addTo(), PyFunctionRep::createResidualsDisplay(), PyFunctionRep::degreesOfFreedom(), PyFunctionRep::fitFunction(), PyFunctionRep::getFitterName(), PyFunctionRep::objectiveValue(), PyFunctionRep::parameters(), PyFunctionRep::parmNames(), PyFunctionRep::principleErrors(), PyFunctionRep::setFitRange(), PyFunctionRep::setFitRangeEnabled(), PyFunctionRep::setFitter(), PyFunctionRep::setFixedFlags(), and PyFunctionRep::setParameters(). Referenced by exportToPython().

void hippodraw::Python::export_FunctionBase (   )

Export the FunctionBase and its FunctionWrap. Definition at line 29 of file FunctionWrap.cxx. References FunctionBase::getParameters(), FunctionWrap::initialize(), FunctionBase::name(), FunctionBase::parmNames(), FunctionWrap::setName(), FunctionBase::setParameters(), and FunctionWrap::setParmNames(). Referenced by exportToPython().

void hippodraw::Python::export_FunctionFactory (   )

Exports the FitterFactory. Definition at line 38 of file export_FunctionFactory.cxx. References Factory< FunctionBase >::add(), Factory< FunctionBase >::create(), FunctionFactory::instance(), and Factory< FunctionBase >::names(). Referenced by exportToPython().

void hippodraw::Python::export_HDApp (   )

Exports the PyApp class to Python. Definition at line 36 of file PyApp.cxx. References PyApp::currentCanvas(), PyApp::exec(), PyApp::instance(), PyApp::lock(), PyApp::openDocument(), PyApp::quit(), and PyApp::unlock(). Referenced by exportToPython().

void hippodraw::Python::export_ListTuple (   )

Exports the ListTuple class to Python. Directly exports ListTuple to Python. There is no locking and unlocking of the QApplication singleton object. However, since invoking member functions of this class do not directly change the GUI, they may be invoked from any thread. Definition at line 34 of file export_ListTuple.cxx. References ListTuple::addColumn(), DataSource::getLabelAt(), ListTuple::notifyObservers(), ListTuple::replaceColumn(), and DataSource::setLabels(). Referenced by exportToPython().

void hippodraw::Python::export_NTuple (   )

Exports the NTuple class to Python. Directly exports NTuple to Python. There is no locking and unlocking of the QApplication singleton object. However, since invoking member functions of this class do not directly change the GUI, they may be invoked from any thread. Definition at line 37 of file export_NTuple.cxx. References NTuple::addColumn(), NTuple::addRow(), DataSource::getLabelAt(), NTuple::getRow(), NTuple::replaceColumn(), NTuple::setIntervalCount(), NTuple::setIntervalEnabled(), and NTuple::setLabels(). Referenced by exportToPython().

void hippodraw::Python::export_NTupleController (   )

Exports the NTupleController class to Python. Requests: Provide interface to DataSourceController. Definition at line 40 of file export_NTupleController.cxx. References NTupleController::changeName(), NTupleController::createCircularBuffer(), NTupleController::createNTuple(), NTupleController::findDataSource(), NTupleController::instance(), NTupleController::registerNTuple(), and NTupleController::writeNTupleToFile(). Referenced by exportToPython().

void hippodraw::Python::export_NTupleFCN (   )

Exports the base class of data source objective functions. Definition at line 41 of file export_NTupleFCN.cxx. References NTupleFCN::setDataSource(). Referenced by exportToPython().

void hippodraw::Python::export_NumArrayTuple (   )

Exports the NumArrayTuple class to Python. Definition at line 37 of file export_NumArrayTuple.cxx. References NumArrayTuple::addColumn(), DataSource::getLabelAt(), NumArrayTuple::notifyObservers(), NumArrayTuple::replaceColumn(), and DataSource::setLabels(). Referenced by exportToPython().

void hippodraw::Python::export_Observer (   )

Exports the Observer class to Python. Definition at line 27 of file ObserverWrap.cxx. Referenced by exportToPython().

void hippodraw::Python::export_PointRepFactory (   )

Exports the PointRepFactory class to Python. Definition at line 53 of file export_PointRepFactory.cxx. References Factory< RepBase >::create(), PointRepFactory::instance(), and Factory< RepBase >::names(). Referenced by exportToPython().

void hippodraw::Python::export_QtCut (   )

Exports the QtCut class to Python. Definition at line 43 of file QtCut.cxx. References QtCut::addTarget(), QtCut::addTargets(), QtCut::cutRange(), QtCut::setCutRange(), QtCut::setEnabled(), and QtCut::toggleInverted(). Referenced by exportToPython().

void hippodraw::Python::export_QtDisplay (   )

Exports the QtDisplay class to Python. Definition at line 66 of file QtDisplay.cxx. References QtDisplay::addDataRep(), QtDisplay::addDataRepStacked(), QtDisplay::addFunction(), QtDisplay::addObserver(), QtDisplay::addValues(), QtDisplay::createDataArray(), QtDisplay::createNTuple(), QtDisplay::currentView(), QtDisplay::deleteView(), QtDisplay::getBinWidth(), QtDisplay::getDataRep(), QtDisplay::getDataReps(), QtDisplay::getLabel(), QtDisplay::getLog(), QtDisplay::getRange(), QtDisplay::getTitle(), QtDisplay::nextView(), QtDisplay::numberOfEntries(), QtDisplay::numViews(), QtDisplay::plotterId(), QtDisplay::reset(), QtDisplay::resize(), QtDisplay::saveView(), QtDisplay::setAspectRatio(), QtDisplay::setAutoRanging(), QtDisplay::setAutoTicks(), QtDisplay::setBinWidth(), QtDisplay::setColorMap(), QtDisplay::setContourLevels(), QtDisplay::setLabel(), QtDisplay::setLog(), QtDisplay::setNumberOfBins(), QtDisplay::setOffset(), QtDisplay::setPointRep(), QtDisplay::setRange(), QtDisplay::setTicks(), QtDisplay::setTitle(), QtDisplay::setTransform(), QtDisplay::setView(), QtDisplay::unlock(), and QtDisplay::update(). Referenced by exportToPython().

void hippodraw::Python::export_RepBase (   )

Exports the RepBase class to Python. Definition at line 39 of file export_RepBase.cxx. Referenced by exportToPython().

void hippodraw::Python::export_RootController (   )

Exports the RootController. Definition at line 44 of file export_RootController.cxx. References QtRootController::createDataArray(), QtRootController::createNTuple(), QtRootController::getNTupleNames(), and QtRootController::instance(). Referenced by exportToPython().

void hippodraw::Python::export_RootNTuple (   )

Exports the RootNTuple. Definition at line 46 of file export_RootNTuple.cxx. References QtRootNTuple::addColumn(), QtRootNTuple::columns(), QtRootNTuple::getColumn(), QtRootNTuple::getLabels(), QtRootNTuple::isMultiDimensional(), RootNTuple::replaceColumn(), QtRootNTuple::rowDataDimSize(), QtRootNTuple::rows(), and QtRootNTuple::valueAt(). Referenced by exportToPython().

void hippodraw::Python::export_StatedFCN (   )

Export the base class of stated objective functions. Definition at line 44 of file export_StatedFCN.cxx. References StatedFCN::objectiveValue(), StatedFCN::setDataSource(), StatedFCN::setFunction(), and StatedFCN::setUseErrors(). Referenced by exportToPython().

void hippodraw::Python::exportToPython (   )

Exports HippoDraw C++ classes to Python. Call this function from within a BOOST_PYTHON_MODULE definition to incorporate HippoDraw classes within that module. Author: Paul F. Kunz <Paul_Kunz@slac.stanford.edu> Matthew Langston <langston@slac.stanford.edu> Selim Tuvi <stuvi@slac.stanford.edu> Definition at line 57 of file exportToPython.cxx. References export_Canvas(), export_CanvasWindow(), export_CircularBuffer(), export_DataArray(), export_DataRep(), export_DataSource(), export_Factory_PointRep(), export_FCNBase(), export_FitsController(), export_FitsNTuple(), export_Fitter(), export_FitterFactory(), export_Function(), export_FunctionBase(), export_FunctionFactory(), export_HDApp(), export_ListTuple(), export_NTuple(), export_NTupleController(), export_NTupleFCN(), export_NumArrayTuple(), export_Observer(), export_PointRepFactory(), export_QtCut(), export_QtDisplay(), export_RepBase(), export_RootController(), export_RootNTuple(), export_StatedFCN(), and translate(). Referenced by BOOST_PYTHON_MODULE().

void hippodraw::Python::PyDataSourceExceptionTranslator (  const PyDataSource::StopIteration &  e  )

Definition at line 48 of file PyDataSource.cxx. References PyDataSource::StopIteration::what(). Referenced by export_DataArray().

void hippodraw::Python::translate (  const std::exception &  e  )

Translate a C++ exception to a Python one. The exception e must a derived class of std::exception. Attention: This function seems to be required by GCC less than verion 3.0. Definition at line 50 of file exportToPython.cxx. Referenced by exportToPython().

---