IMP  2.0.0
The Integrative Modeling Platform
statistics/python_only.h
Go to the documentation of this file.
1 /**
2  * \file IMP/statistics/python_only.h \brief Python-only functionality
3  *
4  * Copyright 2007-2013 IMP Inventors. All rights reserved.
5  *
6  */
7 
8 #ifndef IMPSTATISTICS_PYTHON_ONLY_H
9 #define IMPSTATISTICS_PYTHON_ONLY_H
10 #include <IMP/statistics/statistics_config.h>
11 IMPSTATISTICS_BEGIN_NAMESPACE
12 
13 
14 #ifdef IMP_DOXYGEN
15 /** \name Python only
16  This functionality is only available in python.
17  @{
18 */
19 /** In python, you can use matplot lib, if installed,
20  to show the contents of a histogram. At the moment,
21  only 1D and 2D histograms are supported.
22 
23  \param[in] h The histogram to show, the plot is sized to the histograms
24  bounding box.
25  \param[in] xscale Whether the xscale is "linear" or "log"
26  \param[in] yscale Whether the yscale is "linear" or "log"
27  \param[in] curves A list of python functions to plot on the histogram as
28  curves. The functions should take one float and return a float.
29  \relatesalso HistogramD
30 */
31 void show_histogram(HistogramD h, std::string xscale="linear",
32  std::string yscale="linear",
33  Functions curves=Functions());
34 /** @} */
35 #endif
36 IMPSTATISTICS_END_NAMESPACE
37 #endif /* IMPSTATISTICS_PYTHON_ONLY_H */