IMP  2.3.1
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-2014 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 #ifdef IMP_DOXYGEN
14 /** \name Python only
15  This functionality is only available in Python.
16  @{
17 */
18 /** In Python, you can use matplot lib, if installed,
19  to show the contents of a histogram. At the moment,
20  only 1D and 2D histograms are supported.
21 
22  \param[in] h The histogram to show; the plot is sized to the histogram's
23  bounding box.
24  \param[in] xscale Whether the xscale is "linear" or "log"
25  \param[in] yscale Whether the yscale is "linear" or "log"
26  \param[in] curves A list of Python functions to plot on the histogram as
27  curves. The functions should take one float and return a float.
28  \see HistogramD
29 */
30 void show_histogram(HistogramD h, std::string xscale = "linear",
31  std::string yscale = "linear",
32  Functions curves = Functions());
33 /** @} */
34 #endif
35 IMPSTATISTICS_END_NAMESPACE
36 #endif /* IMPSTATISTICS_PYTHON_ONLY_H */
void show_histogram(HistogramD h, std::string xscale="linear", std::string yscale="linear", Functions curves=Functions())