Nsound::Plotter Class Reference

#include <Nsound/Plotter.h>

Public Member Functions
	Plotter ()
	Construct the Plotter. More...
virtual	~Plotter ()
	Deconstruct the Plotter. More...
void	axhline (const float64 &y_pos=0.0, const std::string &kwargs="")
	Draws a horizontal line at y and spans xmin to xmax (ralitive). More...
void	axvline (const float64 &x_pos=0.0, const std::string &kwargs="")
	Draws a vertical line at x and spans ymin to ymax (ralitive). More...
void	xlim (const float64 &xmin, const float64 &xmax)
	Sets the limit for the x & y axis. More...
void	ylim (const float64 &ymin, const float64 &ymax)
void	figure (const std::string &kwargs="") const
	Creates a new figure window to plot in. More...
void	grid (boolean flag)
	Sets the grid state. More...
void	hide ()
	Hides all plots, prevents any plot window being rendered to the screen. Usefull if only saveing plots to disk. More...
void	hold (boolean flag)
	Sets the hold state. More...
void	imagesc (const AudioStream &Z, const std::string &kwargs="")
	Plots the AudioStream like a 2D matrix. More...
void	imagesc (const Buffer &x_axis, const Buffer &y_axis, const AudioStream &Z, const std::string &kwargs="")
	Plots the AudioStream like a 2D matrix with axis labels. More...
void	legend (const std::string &kwargs="")
	Shows the legend on the current axes. More...
void	plot (const Buffer &y, const std::string &fmt="", const std::string &kwargs="")
	Plots the Buffer on the current figure. More...
void	plot (const Buffer &x, const Buffer &y, const std::string &fmt="", const std::string &kwargs="")
	Plots x vs y on the current figure, length(x) must equal length(y) More...
void	plot (const float64 &x, const float64 &y, const std::string &fmt="", const std::string &kwargs="")
	Plots x vs y on the current figure. More...
void	run_string (const std::string &command) const
	executes the python string More...
void	savefig (const std::string &filename, const std::string &kwargs="")
	Saves the last figure drawn to filename. More...
void	set_xscale (const std::string &s)
	Sets the x axis scaling: log or linear. More...
void	set_yscale (const std::string &s)
	Sets the y axis scaling: log or linear. More...
Axes	subplot (const uint32 n_rows, const uint32 n_cols, const uint32 n, const std::string &kwargs="", Axes *sharex=NULL, Axes *sharey=NULL)
	Creates a figure in a subplot, subplot(A, B, C, **kwargs) More...
void	text (const float64 &x, const float64 &y, const std::string &text, const std::string &kwargs="")
	Adds text at the x, y data point. More...
void	title (const std::string &title, const std::string &kwargs="")
	Add a title to the plot at the top and centered. More...
void	xlabel (const std::string &label, const std::string &kwargs="")
	Add a label x axis. More...
void	ylabel (const std::string &label, const std::string &kwargs="")
	Add a label y axis. More...
void	_swig_shadow ()
	SWIG helper function function to shadow. More...

Static Public Member Functions
static void	show ()
	Acutally draw the plots to the screen. More...

Protected Types
enum	PlotterState { BOOTING, INITALIZED, UNLOADED }
typedef std::pair< std::string, PyObject * >	StringPyObjectPair
typedef std::map< std::string, PyObject * >	PylabTable

Protected Member Functions
PyObject *	_make_kwargs (const std::string &kwargs) const

Static Protected Attributes
static int32	count_ = 0
static PylabTable	table_
static PlotterState	state_ = Plotter::BOOTING
static boolean	grid_is_on_ = true
static boolean	hold_is_on_ = false
static float64	xmin_ = 1e300
static float64	xmax_ = -1e300
static float64	ymin_ = 1e300
static float64	ymax_ = -1e300

Private Member Functions
	Plotter (const Plotter &rhs)
	Copy constructor disabled. More...
Plotter &	operator= (const Plotter &rhs)
	Asignment disabled. More...
PyObject *	makePyListFromBuffer (const Buffer &buffer) const
	Create a PyList object from a buffer! More...
PyObject *	makePyIntFromUint32 (const uint32 &i) const
	Create a PyInt. More...

Detailed Description

Definition at line 71 of file Plotter.h.

Member Typedef Documentation

typedef std::pair< std::string, PyObject * > Nsound::Plotter::StringPyObjectPair

protected

Definition at line 198 of file Plotter.h.

typedef std::map< std::string, PyObject * > Nsound::Plotter::PylabTable

protected

Definition at line 203 of file Plotter.h.

Member Enumeration Documentation

enum Nsound::Plotter::PlotterState

protected

Enumerator
BOOTING
INITALIZED
UNLOADED

Definition at line 211 of file Plotter.h.

    {
        BOOTING,
        INITALIZED,
        UNLOADED,
    };

Constructor & Destructor Documentation

Plotter::Plotter

(

)

Construct the Plotter.

Definition at line 114 of file Plotter.cc.

References BOOTING, count_, INITALIZED, M_CHECK_PY_PTR_RETURN, M_THROW, run_string(), state_, and table_.

{
    #ifdef NSOUND_C_PYLAB

        ++count_;

        if(Plotter::state_ != BOOTING)
        {
            return;
        }

        #ifndef NSOUND_IN_PYTHON_MODULE

            Py_Initialize();

            // Initialize/import the Numeric::arrayobject module
//            import_array();

            if(PyErr_Occurred())
            {
                PyErr_Print();
                M_THROW("Py_Initialize() failed");
                return;
            }

        #endif

        //---------------------------------------------------------------------
        // importing modules

        PyObject * matplotlib = PyImport_ImportModule("matplotlib");

        M_CHECK_PY_PTR_RETURN( matplotlib, "import matplotlib failed." );

        PyObject * pylab = PyImport_ImportModule("matplotlib.pylab");

        M_CHECK_PY_PTR_RETURN( pylab, "import matplotlib.pylab failed." );

        Py_DECREF(matplotlib);

        //---------------------------------------------------------------------
        // Grabbing pylab's funciton dictionary

        PyObject * pylab_dict = PyModule_GetDict(pylab);

        M_CHECK_PY_PTR_RETURN( pylab_dict, "dir(pylab) failed" );

        table_.insert(StringPyObjectPair("pylab", pylab_dict));

        Py_DECREF(pylab);

        std::vector< std::string > functions;

        functions.push_back("axhline");
        functions.push_back("axis");
        functions.push_back("axvline");
        functions.push_back("close");
        functions.push_back("detrend");
        functions.push_back("figure");
        functions.push_back("gca");
        functions.push_back("hold");
        functions.push_back("imshow");
        functions.push_back("legend");
        functions.push_back("plot");
        functions.push_back("show");
        functions.push_back("subplot");
        functions.push_back("text");
        functions.push_back("title");
        functions.push_back("window_hanning");
        functions.push_back("xlabel");
        functions.push_back("xlim");
        functions.push_back("ylabel");
        functions.push_back("ylim");

        const uint32 N_FUNCTIONS = static_cast<uint32>(functions.size());

        for(uint32 i = 0; i < N_FUNCTIONS; ++i)
        {
            PyObject * func = PyDict_GetItemString(
                pylab_dict, functions[i].c_str());

            M_CHECK_PY_PTR_RETURN(
                func, "PyDict_GetItemString('" << functions[i] << "') failed");

            if(! PyCallable_Check(func))
            {
                M_THROW("pylab." << functions[i] << " isn't callable?!");
            }

            table_.insert(
                StringPyObjectPair("pylab." + functions[i], func));
        }

        // Globals

        PyObject * __main__ = PyImport_ImportModule("__main__");

        M_CHECK_PY_PTR_RETURN(__main__, "PyImport_ImportModule() failed");

        PyObject * globals = PyModule_GetDict(__main__);

        M_CHECK_PY_PTR_RETURN(globals, "globals() failed");

        table_.insert(StringPyObjectPair("globals", globals));

        Py_DECREF(__main__);

        run_string("import matplotlib.pylab as _pylab_nsound_");

        Plotter::state_ = INITALIZED;

    #endif
}

Plotter::~Plotter ( )

virtual

Deconstruct the Plotter.

Definition at line 230 of file Plotter.cc.

References count_, state_, and UNLOADED.

{
    #ifdef NSOUND_C_PYLAB

        --count_;

        if(count_ == 0)
        {
            #ifndef NSOUND_IN_PYTHON_MODULE

                Py_Finalize();

            #endif

            Plotter::state_ = UNLOADED;
        }

    #endif
}

Nsound::Plotter::Plotter ( const Plotter &  rhs )

private

Copy constructor disabled.

Member Function Documentation

void Plotter::axhline	(	const float64 &	y_pos = 0.0,
		const std::string &	kwargs = ""
	)

Draws a horizontal line at y and spans xmin to xmax (ralitive).

Definition at line 327 of file Plotter.cc.

References _make_kwargs(), INITALIZED, M_CHECK_PY_PTR_RETURN, state_, and table_.

{
    #ifdef NSOUND_C_PYLAB

        if(Plotter::state_ != INITALIZED)
        {
            return;
        }

        PyObject * args = Py_BuildValue("(d)", y_pos);

        M_CHECK_PY_PTR_RETURN(args, "Py_BuildValue() failed");

        PyObject * kw_args = _make_kwargs(kwargs);

        PyObject * ret = PyObject_Call(table_["pylab.axhline"], args, kw_args);

        Py_DECREF(args);
        Py_XDECREF(kw_args);

        M_CHECK_PY_PTR_RETURN(ret, "pylab.axhline() failed");

        Py_DECREF(ret);

    #endif
}

void Plotter::axvline	(	const float64 &	x_pos = 0.0,
		const std::string &	kwargs = ""
	)

Draws a vertical line at x and spans ymin to ymax (ralitive).

Definition at line 358 of file Plotter.cc.

References _make_kwargs(), INITALIZED, M_CHECK_PY_PTR_RETURN, state_, and table_.

Referenced by Nsound::FilterLowPassMoogVcf::plot(), Nsound::FilterTone::plot(), Nsound::FilterHighPassIIR::plot(), Nsound::FilterLowPassIIR::plot(), Nsound::FilterCombLowPassFeedback::plot(), Nsound::FilterLowPassFIR::plot(), Nsound::FilterHighPassFIR::plot(), Nsound::FilterBandPassVocoder::plot(), Nsound::FilterBandPassFIR::plot(), Nsound::FilterBandRejectFIR::plot(), Nsound::FilterBandRejectIIR::plot(), and Nsound::FilterParametricEqualizer::plot().

{
    #ifdef NSOUND_C_PYLAB

        if(Plotter::state_ != INITALIZED)
        {
            return;
        }

        PyObject * args = Py_BuildValue("(d)", x_pos);

        M_CHECK_PY_PTR_RETURN(args, "Py_BuildValue() failed");

        PyObject * kw_args = _make_kwargs(kwargs);

        PyObject * ret = PyObject_Call(table_["pylab.axvline"], args, kw_args);

        Py_DECREF(args);
        Py_XDECREF(kw_args);

        M_CHECK_PY_PTR_RETURN(ret, "pylab.axvline() failed");

        Py_DECREF(ret);

    #endif
}

void Plotter::xlim	(	const float64 &	xmin,
		const float64 &	xmax
	)

Sets the limit for the x & y axis.

Definition at line 389 of file Plotter.cc.

References INITALIZED, M_ASSERT_VALUE, M_CHECK_PY_PTR_RETURN, state_, and table_.

Referenced by main(), my_main(), Nsound::FilterIIR::savePlot(), and Nsound::Vocoder::Vocoder().

{
    #ifdef NSOUND_C_PYLAB

        if(Plotter::state_ != INITALIZED)
        {
            return;
        }

        M_ASSERT_VALUE(xmin, <, xmax);

        PyObject * args = Py_BuildValue("(d, d)", xmin, xmax);

        M_CHECK_PY_PTR_RETURN(args, "Py_BuildValue() failed");

        PyObject * kw_args = NULL; //_make_kwargs(kwargs);

        PyObject * ret = PyObject_Call(table_["pylab.xlim"], args, kw_args);

        Py_DECREF(args);
        Py_XDECREF(kw_args);

        M_CHECK_PY_PTR_RETURN(ret, "pylab.xlim() failed");

        Py_DECREF(ret);

    #endif
}

void Plotter::ylim	(	const float64 &	ymin,
		const float64 &	ymax
	)

Definition at line 422 of file Plotter.cc.

References INITALIZED, M_ASSERT_VALUE, M_CHECK_PY_PTR_RETURN, state_, and table_.

Referenced by main(), my_main(), Nsound::Filter::plot(), Nsound::FilterIIR::savePlot(), and Nsound::Vocoder::Vocoder().

{
    #ifdef NSOUND_C_PYLAB

        if(Plotter::state_ != INITALIZED)
        {
            return;
        }

        M_ASSERT_VALUE(ymin, <, ymax);

        PyObject * args = Py_BuildValue("(d, d)", ymin, ymax);

        M_CHECK_PY_PTR_RETURN(args, "Py_BuildValue() failed");

        PyObject * kw_args = NULL; //_make_kwargs(kwargs);

        PyObject * ret = PyObject_Call(table_["pylab.ylim"], args, kw_args);

        Py_DECREF(args);
        Py_XDECREF(kw_args);

        M_CHECK_PY_PTR_RETURN(ret, "pylab.ylim() failed");

        Py_DECREF(ret);

    #endif
}

void Plotter::figure

(

const std::string &

kwargs = ""

)

const

Creates a new figure window to plot in.

Definition at line 455 of file Plotter.cc.

References _make_kwargs(), INITALIZED, M_CHECK_PY_PTR_RETURN, state_, and table_.

Referenced by main(), my_main(), Nsound::Spectrogram::plot(), Nsound::FFTChunk::plot(), Nsound::Filter::plot(), Nsound::AudioStream::plot(), Nsound::Buffer::plot(), Nsound::FilterIIR::savePlot(), and Nsound::Vocoder::Vocoder().

{
    #ifdef NSOUND_C_PYLAB

        if(Plotter::state_ != INITALIZED)
        {
            return;
        }

//~        if(Plotter::state_ != INITALIZED || hold_is_on_)
//~        {
//~            hold_is_on_ = false; // toggle it.
//~            return;
//~        }

        PyObject * args = Py_BuildValue("()");

        M_CHECK_PY_PTR_RETURN(args, "Py_BuildValue() failed");

        PyObject * kw_args = _make_kwargs(kwargs);

        PyObject * ret = PyObject_Call(table_["pylab.figure"], args, kw_args);

        Py_DECREF(args);
        Py_XDECREF(kw_args);

        M_CHECK_PY_PTR_RETURN(ret, "pylab.figure() failed");

        Py_DECREF(ret);

//~        // Reset limits
//~        xmax_ = -1e20;
//~        xmin_ = 1e20;
//~        ymin_ = xmin_;
//~        ymax_ = xmax_;

    #endif
}

void Plotter::grid

(

boolean

flag

)

Sets the grid state.

Definition at line 496 of file Plotter.cc.

References run_string().

Referenced by Generator_UnitTest(), hold(), and Nsound::Vocoder::Vocoder().

{
//~    grid_is_on_ = flag;

        if(flag)
        {
            run_string(
                "try:\n"
                "    ax__ = _pylab_nsound_.gca();\n"
                "    ax__.grid(True);\n"
                "except:\n"
                "    pass\n\n");
        }

        else
        {
            run_string(
                "try:\n"
                "    ax__ = _pylab_nsound_.gca();\n"
                "    ax__.grid(False);\n"
                "except:\n"
                "    pass\n\n");
        }


}

void Plotter::hide

(

)

Hides all plots, prevents any plot window being rendered to the screen. Usefull if only saveing plots to disk.

Definition at line 525 of file Plotter.cc.

References INITALIZED, M_CHECK_PY_PTR_RETURN, state_, and table_.

{
    #ifdef NSOUND_C_PYLAB

        if(Plotter::state_ != INITALIZED)
        {
            return;
        }

        PyObject * args = Py_BuildValue("(s)", "all");

        M_CHECK_PY_PTR_RETURN(args, "Py_BuildValue() failed");

        PyObject * kw_args = NULL; //_make_kwargs(kwargs);

        PyObject * ret = PyObject_Call(table_["pylab.close"], args, kw_args);

        Py_DECREF(args);
        Py_XDECREF(kw_args);

        M_CHECK_PY_PTR_RETURN(ret, "pylab.close() failed");

        Py_DECREF(ret);

    #endif
}

void Plotter::hold

(

boolean

flag

)

Sets the hold state.

Definition at line 554 of file Plotter.cc.

References grid(), hold_is_on_, INITALIZED, M_CHECK_PY_PTR_RETURN, state_, and table_.

Referenced by Nsound::Vocoder::Vocoder().

{
    #ifdef NSOUND_C_PYLAB

        hold_is_on_ = flag;

        if(Plotter::state_ != INITALIZED)
        {
            return;
        }

        // Put the list in a tuple.
        PyObject * args = NULL;

        if(hold_is_on_)
        {
            args = PyTuple_Pack(1, Py_True);
        }
        else
        {
            args = PyTuple_Pack(1, Py_False);
        }

        PyObject * ret = PyObject_CallObject(table_["pylab.hold"], args);

        Py_DECREF(args);

        M_CHECK_PY_PTR_RETURN(ret, "pylab.hold() failed");

        if(hold_is_on_)
        {
            grid(false);
        }

    #endif
}

void Plotter::imagesc	(	const AudioStream &	Z,
		const std::string &	kwargs = ""
	)

Plots the AudioStream like a 2D matrix.

Definition at line 593 of file Plotter.cc.

Referenced by my_main(), and Nsound::Spectrogram::plot().

{
    imagesc(Buffer(), Buffer(), Z, kwargs);
}

void Plotter::imagesc	(	const Buffer &	x_axis,
		const Buffer &	y_axis,
		const AudioStream &	Z,
		const std::string &	kwargs = ""
	)

Plots the AudioStream like a 2D matrix with axis labels.

Definition at line 600 of file Plotter.cc.

References _make_kwargs(), Nsound::AudioStream::getLength(), Nsound::Buffer::getLength(), Nsound::AudioStream::getNChannels(), grid_is_on_, INITALIZED, M_CHECK_PY_PTR_RETURN, M_THROW, makePyListFromBuffer(), run_string(), state_, and table_.

{
    #ifdef NSOUND_C_PYLAB

        if(Plotter::state_ != INITALIZED)
        {
            return;
        }

        uint32 M = Z.getNChannels();
        uint32 N = Z.getLength();
        uint32 x_size = x_axis.getLength();
        uint32 y_size = y_axis.getLength();

        if(N == 0)
        {
            M_THROW("Nsound::Plotter::imagesc(): "
                 << "Z has zero columns! ("
                 << M
                 << " x "
                 << N
                 << ")");
            return;
        }

        if(x_size > 0 && x_size != N)
        {
            M_THROW("Nsound::Plotter::imagesc(): "
                 << "shape mismatch between x_axis and Z ("
                 << x_size
                 << " != "
                 << N
                 << ")");
            return;
        }

        if(y_size > 0 && y_size != M)
        {
            M_THROW("Nsound::Plotter::imagesc(): "
                 << "shape mismatch between y_axis and Z ("
                 << y_size
                 << " != "
                 << M
                 << ")");
            return;
        }

        float64 xmin = 0.0;
        float64 xmax = 0.0;
        float64 ymin = 0.0;
        float64 ymax = 0.0;

        if(x_size == 0 && y_size == 0)
        {
            xmin = -0.5;
            xmax = static_cast<float64>(N - 1) + 0.5;
            ymin = -0.5;
            ymax = static_cast<float64>(M - 1) + 0.5;
        }
        else if(x_size > 0 && y_size > 0)
        {
            float64 dx = x_axis[1] - x_axis[0];
            float64 dy = y_axis[1] - y_axis[0];

            xmin = x_axis[0]     - 0.5 * dx;
            xmax = x_axis[N - 1] + 0.5 * dx;
            ymin = y_axis[0]     - 0.5 * dy;
            ymax = y_axis[M - 1] + 0.5 * dy;
        }

        // Create python list of lists to represent the matrix

        PyObject * matrix_list = PyList_New(M);

        M_CHECK_PY_PTR_RETURN(matrix_list, "PyList_New() failed");

        for(uint32 m = 0; m < M; ++m)
        {
            PyObject * array = makePyListFromBuffer(Z[m]);

            M_CHECK_PY_PTR_RETURN(array, "makePyListFromBuffer() failed");

            PyList_SET_ITEM(matrix_list, m, array);
        }

        // Now build imshow's arguments and keyword args

        PyObject * args = Py_BuildValue("(O)", matrix_list);

        M_CHECK_PY_PTR_RETURN(args, "Py_BuildValue() failed");

        // build keywords
        std::stringstream ss;

        ss << "extent=["
            << xmin << "," << xmax << "," << ymin << "," << ymax << "],"
            << "interpolation='nearest',"
            << "origin='lower'";

        if(kwargs != "")
        {
            ss << "," << kwargs;
        }

        PyObject * kw_args = _make_kwargs(ss.str());

        // Call pylab.plot().
        PyObject * ret = PyObject_Call(table_["pylab.imshow"], args, kw_args);

        Py_DECREF(args);
        Py_XDECREF(kw_args);

        M_CHECK_PY_PTR_RETURN(ret, "pylab.imshow() failed");

        Py_DECREF(ret);

        // Axis tight & Grid

        run_string(
            "try:\n"
            "    ax__ = _pylab_nsound_.gca();\n"
            "    trash__ = ax__.axis('tight');\n"
            "except:\n"
            "    pass\n\n");

        if(grid_is_on_)
        {
            run_string(
                "try:\n"
                "    ax__ = _pylab_nsound_.gca();\n"
                "    ax__.grid(True);\n"
                "except:\n"
                "    pass\n\n");
        }

    #endif
}

void Plotter::legend

(

const std::string &

kwargs = ""

)

Shows the legend on the current axes.

Definition at line 745 of file Plotter.cc.

References _make_kwargs(), M_CHECK_PY_PTR_RETURN, and table_.

Referenced by Generator_UnitTest().

{
    #ifdef NSOUND_C_PYLAB

        // Create args & kwargs.
        PyObject * args = Py_BuildValue("()");
        PyObject * kw_args = _make_kwargs(kwargs);

        PyObject * ret = PyObject_Call(table_["pylab.legend"], args, kw_args);

        M_CHECK_PY_PTR_RETURN(ret, "pylab.legend() failed");

        Py_DECREF(args);
        Py_DECREF(kw_args);

    #endif
}

void Plotter::plot	(	const Buffer &	y,
		const std::string &	fmt = "",
		const std::string &	kwargs = ""
	)

Plots the Buffer on the current figure.

Definition at line 765 of file Plotter.cc.

Referenced by Generator_UnitTest(), main(), my_main(), Nsound::FFTChunk::plot(), Nsound::Filter::plot(), plot(), Nsound::AudioStream::plot(), Nsound::Buffer::plot(), Nsound::FilterIIR::savePlot(), and Nsound::Vocoder::Vocoder().

{
    plot(Buffer(), buffer, fmt, kwargs);
}

void Plotter::plot	(	const Buffer &	x,
		const Buffer &	y,
		const std::string &	fmt = "",
		const std::string &	kwargs = ""
	)

Plots x vs y on the current figure, length(x) must equal length(y)

Definition at line 775 of file Plotter.cc.

References _make_kwargs(), Nsound::Buffer::getLength(), grid_is_on_, INITALIZED, M_ASSERT_VALUE, M_CHECK_PY_PTR_RETURN, makePyListFromBuffer(), run_string(), state_, and table_.

{
    #ifdef NSOUND_C_PYLAB

        if(Plotter::state_ != INITALIZED)
        {
            return;
        }

        M_ASSERT_VALUE(y.getLength(), >, 0);

        PyObject * x_list = NULL;

        // X may be empty here.
        if(x.getLength() > 0)
        {
            M_ASSERT_VALUE(x.getLength(), ==, y.getLength());

            x_list = makePyListFromBuffer(x);
        }

        PyObject * y_list = makePyListFromBuffer(y);

        // Put the list in a tuple.
        PyObject * args = NULL;

        // Count how many items are going into args.
        uint32 n_args = 1;

        if(x_list != NULL) ++n_args;
        if(fmt != "") ++n_args;

        args = PyTuple_New(n_args);

        M_CHECK_PY_PTR_RETURN(args, "PyTuple_New() failed");

        Py_ssize_t pos = 0;

        if(x_list != NULL)
        {
            PyTuple_SetItem(args, pos, x_list);
            pos += 1;
        }

        PyTuple_SetItem(args, pos, y_list);
        pos += 1;

        PyObject * fmt_str = NULL;

        if(fmt != "")
        {
            fmt_str = PyString_FromString(fmt.c_str());
            M_CHECK_PY_PTR_RETURN(
                fmt_str, "PyString_FromString('" << fmt << "') failed");
            PyTuple_SetItem(args, pos, fmt_str);
        }

        PyObject * kw_args = _make_kwargs(kwargs);

        // Call pylab.plot().
        PyObject * ret = PyObject_Call(table_["pylab.plot"], args, kw_args);

        Py_DECREF(kw_args);
        Py_DECREF(args);

        M_CHECK_PY_PTR_RETURN(ret, "pylab.plot() failed");

        Py_DECREF(ret);

//~        ///////////////////////////////////////////////////////////////////////
//~        // Setup plot limits to make stuff fit nicely

//~        float64 xmin = 0.0;
//~        float64 xmax = y.getLength() - 1;

//~        if(x.getLength() > 0)
//~        {
//~            xmin = x[0];
//~            xmax = x[x.getLength() - 1];
//~        }

//~        float64 ymin = y.getMin();
//~        float64 ymax = y.getMax();

//~        float64 margin = 0.05;

//~        float64 dist = xmax - xmin;

//~        xmin -= margin * dist;
//~        xmax += margin * dist;

//~        dist = ymax - ymin;

//~        ymin -= margin * dist;
//~        ymax += margin * dist;

//~        // Create python list for [xmin, xmax, ymin, ymax]

//~        PyObject * limits = PyList_New(4);
//~        PyList_SET_ITEM(limits, 0, PyFloat_FromDouble(xmin - 1e-19));
//~        PyList_SET_ITEM(limits, 1, PyFloat_FromDouble(xmax + 1e-19));
//~        PyList_SET_ITEM(limits, 2, PyFloat_FromDouble(ymin - 1e-19));
//~        PyList_SET_ITEM(limits, 3, PyFloat_FromDouble(ymax + 1e-19));

//~        args = PyTuple_Pack(1, limits);

//~        // Call pylab.axis().
//~        ret = PyObject_CallObject(table_["pylab.axis"], args);

//~        Py_DECREF(args);
//~        Py_DECREF(limits);

//~        if(!ret)
//~        {
//~            PyErr_Print();
//~            cerr << PRINT_LINE
//~                 << "failed to call python pylab.axis()"
//~                 << "\n";
//~            return;
//~        }

        if(grid_is_on_)
        {
            run_string(
                "try:\n"
                "    ax__ = _pylab_nsound_.gca();\n"
                "    ax__.grid(True);\n"
                "except:\n"
                "    pass\n\n");
        }

    #endif
}

void Plotter::plot	(	const float64 &	x,
		const float64 &	y,
		const std::string &	fmt = "",
		const std::string &	kwargs = ""
	)

Plots x vs y on the current figure.

Definition at line 915 of file Plotter.cc.

References plot().

{
    #ifdef NSOUND_C_PYLAB

       Buffer xx(1); xx << x;
       Buffer yy(1); yy << y;

       plot(xx, yy, fmt, kwargs);

    #endif
}

void Plotter::run_string

(

const std::string &

command

)

const

executes the python string

Definition at line 933 of file Plotter.cc.

References M_CHECK_PY_PTR_RETURN, and table_.

Referenced by grid(), imagesc(), plot(), Plotter(), savefig(), set_xscale(), set_yscale(), and subplot().

{
    #ifdef NSOUND_C_PYLAB

        std::string str = command + "\n";

        PyObject * ret = PyRun_String(
            str.c_str(), Py_file_input, table_["globals"], NULL);

        M_CHECK_PY_PTR_RETURN(ret, "run_string() failed");

        Py_DECREF(ret);

    #endif
}

void Plotter::savefig	(	const std::string &	filename,
		const std::string &	kwargs = ""
	)

Saves the last figure drawn to filename.

Definition at line 951 of file Plotter.cc.

References INITALIZED, run_string(), and state_.

{
    #ifdef NSOUND_C_PYLAB

        if(Plotter::state_ != INITALIZED)
        {
            return;
        }

        std::stringstream ss;

        ss << "savefig('"
           << filename
           << "'";

        if(kwargs.length() > 0)
        {
            ss << ", " << kwargs;
        }

        ss << ")";

        run_string(ss.str());

//~        std::string command(ss.str());

//~        PyObject * ret = PyRun_String(command.c_str(), Py_eval_input, table_["pylab"], NULL);

//~        if(!ret)
//~        {
//~            PyErr_Print();
//~            cerr << PRINT_LINE
//~                 << "failed to call python '"
//~                 << command
//~                 << "'"
//~                 << "\n";
//~            return;
//~        }

    #endif
}

void Plotter::set_xscale

(

const std::string &

s

)

Sets the x axis scaling: log or linear.

Definition at line 995 of file Plotter.cc.

References run_string().

{
    if(s != "log" && s != "linear") return;

    std::stringstream ss;

    ss
        << "try:\n"
        << "    ax = _pylab_nsound_.gca();\n"
        << "    ax.set_xscale('" << s << "')\n"
        << "except:\n"
        << "    pass\n\n";

    run_string(ss.str());
}

void Plotter::set_yscale

(

const std::string &

s

)

Sets the y axis scaling: log or linear.

Definition at line 1013 of file Plotter.cc.

References run_string().

{
    if(s != "log" && s != "linear") return;

    std::stringstream ss;

    ss
        << "try:\n"
        << "    ax = _pylab_nsound_.gca();\n"
        << "    ax.set_yscale('" << s << "')\n"
        << "except:\n"
        << "    pass\n\n";

    run_string(ss.str());
}

Axes Plotter::subplot	(	const uint32	n_rows,
		const uint32	n_cols,
		const uint32	n,
		const std::string &	kwargs = "",
		Axes *	sharex = NULL,
		Axes *	sharey = NULL
	)

Creates a figure in a subplot, subplot(A, B, C, **kwargs)

A = number of rows B = number of columns C = axes number kwargs - keyword arguments sharex - an axes to share xlimits with sharey - an axes to share ylimits with

Definition at line 1031 of file Plotter.cc.

References _make_kwargs(), Nsound::Axes::get_axes(), grid_is_on_, INITALIZED, M_CHECK_PY_PTR, run_string(), state_, and table_.

Referenced by main(), my_main(), Nsound::FilterLowPassMoogVcf::plot(), Nsound::FilterPhaser::plot(), Nsound::FilterTone::plot(), Nsound::FilterHighPassIIR::plot(), Nsound::FFTChunk::plot(), Nsound::FilterLowPassIIR::plot(), Nsound::FilterCombLowPassFeedback::plot(), Nsound::FilterLowPassFIR::plot(), Nsound::FilterAllPass::plot(), Nsound::FilterHighPassFIR::plot(), Nsound::FilterBandPassVocoder::plot(), Nsound::Filter::plot(), Nsound::FilterBandPassFIR::plot(), Nsound::FilterLeastSquaresFIR::plot(), Nsound::FilterFlanger::plot(), Nsound::FilterBandRejectFIR::plot(), Nsound::FilterBandRejectIIR::plot(), and Nsound::AudioStream::plot().

{
    #ifdef NSOUND_C_PYLAB

        if(Plotter::state_ != INITALIZED)
        {
            return Axes(NULL);
        }

        // args
        PyObject * args = Py_BuildValue("(iii)", n_rows, n_columns, n);

        // kwargs
        PyObject * kw_args = _make_kwargs(kwargs);

        // Stick in sharex & sharey
        if(sharex != NULL)
        {
            PyObject * key = PyString_FromString("sharex");
            PyDict_SetItem(kw_args, key, sharex->get_axes());
        }

        if(sharey != NULL)
        {
            PyObject * key = PyString_FromString("sharey");
            PyDict_SetItem(kw_args, key, sharey->get_axes());
        }

        // Call pylab.subplot()
        PyObject * ret = PyObject_Call(table_["pylab.subplot"], args, kw_args);

        Py_DECREF(args);
        Py_DECREF(kw_args);

        M_CHECK_PY_PTR(ret, "pylab.subplot() failed");

        if(grid_is_on_)
        {
            run_string(
                "try:\n"
                "    ax = _pylab_nsound_.gca();\n"
                "    ax.grid(True);\n"
                "except:\n"
                "    pass\n\n");
        }

        return Axes(ret);

    #endif

    return Axes(NULL);
}

void Plotter::text	(	const float64 &	x,
		const float64 &	y,
		const std::string &	text,
		const std::string &	kwargs = ""
	)

Adds text at the x, y data point.

Definition at line 1092 of file Plotter.cc.

References _make_kwargs(), INITALIZED, M_CHECK_PY_PTR_RETURN, state_, and table_.

Referenced by main(), and Nsound::FilterIIR::savePlot().

{
    #ifdef NSOUND_C_PYLAB

        if(Plotter::state_ != INITALIZED)
        {
            return;
        }

        // Create a python string.

        PyObject * args = Py_BuildValue("(dds)",
            x, y, text.c_str());

        PyObject * kw_args = _make_kwargs(kwargs);

        // Call pylab.title()
        PyObject * ret = PyObject_Call(table_["pylab.text"], args, kw_args);

        Py_DECREF(kw_args);
        Py_DECREF(args);

        M_CHECK_PY_PTR_RETURN(ret, "pylab.text() failed");

        Py_DECREF(ret);

    #endif
}

void Plotter::title	(	const std::string &	title,
		const std::string &	kwargs = ""
	)

Add a title to the plot at the top and centered.

Definition at line 1127 of file Plotter.cc.

References _make_kwargs(), INITALIZED, M_CHECK_PY_PTR_RETURN, state_, and table_.

Referenced by main(), my_main(), Nsound::FilterLowPassMoogVcf::plot(), Nsound::Spectrogram::plot(), Nsound::FilterPhaser::plot(), Nsound::FilterTone::plot(), Nsound::FilterHighPassIIR::plot(), Nsound::FFTChunk::plot(), Nsound::FilterLowPassIIR::plot(), Nsound::FilterCombLowPassFeedback::plot(), Nsound::FilterLowPassFIR::plot(), Nsound::FilterAllPass::plot(), Nsound::FilterHighPassFIR::plot(), Nsound::FilterBandPassVocoder::plot(), Nsound::FilterBandPassFIR::plot(), Nsound::FilterLeastSquaresFIR::plot(), Nsound::FilterFlanger::plot(), Nsound::FilterBandRejectFIR::plot(), Nsound::FilterBandRejectIIR::plot(), Nsound::FilterParametricEqualizer::plot(), Nsound::AudioStream::plot(), Nsound::Buffer::plot(), and Nsound::FilterIIR::savePlot().

{
    #ifdef NSOUND_C_PYLAB

        if(Plotter::state_ != INITALIZED)
        {
            return;
        }

        PyObject * args = Py_BuildValue("(s)", title.c_str());
        PyObject * kw_args = _make_kwargs(kwargs);

        // Call pylab.title()
        PyObject * ret = PyObject_Call(table_["pylab.title"], args, kw_args);

        Py_DECREF(kw_args);
        Py_DECREF(args);

        M_CHECK_PY_PTR_RETURN(ret, "pylab.title() failed");

        Py_DECREF(ret);

    #endif
}

void Plotter::xlabel	(	const std::string &	label,
		const std::string &	kwargs = ""
	)

Add a label x axis.

Definition at line 1154 of file Plotter.cc.

References _make_kwargs(), INITALIZED, M_CHECK_PY_PTR_RETURN, state_, and table_.

Referenced by main(), my_main(), Nsound::Spectrogram::plot(), Nsound::FFTChunk::plot(), Nsound::Filter::plot(), Nsound::AudioStream::plot(), Nsound::FilterIIR::savePlot(), and Nsound::Vocoder::Vocoder().

{
    #ifdef NSOUND_C_PYLAB

        if(Plotter::state_ != INITALIZED)
        {
            return;
        }

        PyObject * args = Py_BuildValue("(s)", label.c_str());
        PyObject * kw_args = _make_kwargs(kwargs);

        PyObject * ret = PyObject_Call(table_["pylab.xlabel"], args, kw_args);

        Py_DECREF(kw_args);
        Py_DECREF(args);

        M_CHECK_PY_PTR_RETURN(ret, "pylab.xlabel() failed");

        Py_DECREF(ret);

    #endif
}

void Plotter::ylabel	(	const std::string &	label,
		const std::string &	kwargs = ""
	)

Add a label y axis.

Definition at line 1180 of file Plotter.cc.

References _make_kwargs(), INITALIZED, M_CHECK_PY_PTR_RETURN, state_, and table_.

Referenced by main(), my_main(), Nsound::Spectrogram::plot(), Nsound::FFTChunk::plot(), Nsound::Filter::plot(), Nsound::AudioStream::plot(), Nsound::FilterIIR::savePlot(), and Nsound::Vocoder::Vocoder().

{
    #ifdef NSOUND_C_PYLAB

        if(Plotter::state_ != INITALIZED)
        {
            return;
        }

        PyObject * args = Py_BuildValue("(s)", label.c_str());
        PyObject * kw_args = _make_kwargs(kwargs);

        PyObject * ret = PyObject_Call(table_["pylab.ylabel"], args, kw_args);

        Py_DECREF(kw_args);
        Py_DECREF(args);

        M_CHECK_PY_PTR_RETURN(ret, "pylab.ylabel() failed");

        Py_DECREF(ret);

    #endif
}

void Plotter::show ( )

static

Acutally draw the plots to the screen.

Definition at line 252 of file Plotter.cc.

References INITALIZED, M_CHECK_PY_PTR_RETURN, state_, and table_.

Referenced by Buffer_UnitTest(), BufferResample_UnitTest(), DelayLine_UnitTest(), FFTransform_UnitTest(), FilterCombLowPassFeedback_UnitTest(), FilterDelay_UnitTest(), FilterLeastSquaresFIR_UnitTest(), FilterParametricEqualizer_UnitTest(), Generator_UnitTest(), main(), my_main(), Sine_UnitTest(), testBufferAdd(), Triangle_UnitTest(), and Wavefile_UnitTest().

{
    #ifdef NSOUND_C_PYLAB

        if(Plotter::state_ != INITALIZED)
        {
            return;
        }

        // Call pylab.show()

        PyObject * ret = PyObject_CallObject(table_["pylab.show"], NULL);

        M_CHECK_PY_PTR_RETURN(ret, "pylab.show() failed");

        Py_DECREF(ret);

    #else
        // This function is overwridden in the Python module,
        // See the file shadowed.i for how this is implemented in Python module

        #ifndef NSOUND_IN_PYTHON_MODULE

            static bool once = true;

            if(once)
            {
                once = false;
                std::cerr
                    << "WARNING: Nsound::Plotter::show(): Nsound wasn't "
                    "compiled with matplotlib" << std::endl;
                std::cerr.flush();
            }
        #endif
    #endif
}

void Nsound::Plotter::_swig_shadow ( )

inline

SWIG helper function function to shadow.

Definition at line 198 of file Plotter.h.

{};

PyObject * Plotter::_make_kwargs ( const std::string &  kwargs ) const

protected

Definition at line 292 of file Plotter.cc.

References M_CHECK_PY_PTR, and table_.

Referenced by axhline(), axvline(), figure(), imagesc(), legend(), plot(), subplot(), text(), title(), xlabel(), and ylabel().

{
    #ifdef NSOUND_C_PYLAB

        if(kwargs == "") return PyDict_New();

        std::stringstream ss;

        ss << "dict(" << kwargs << ")\n";

        PyCodeObject * code = (PyCodeObject*) Py_CompileString(
            ss.str().c_str(), "Plotter.cc", Py_eval_input);

        M_CHECK_PY_PTR(code, "Py_CompileString() failed");

        PyObject * globals = table_["globals"];

        PyObject * locals = PyDict_New();

        M_CHECK_PY_PTR(locals, "PyDict_New() failed");

        PyObject * kwdict = PyEval_EvalCode(code, globals, locals);

        Py_DECREF(code);
        Py_DECREF(locals);

        return kwdict;

    #endif

    return NULL;
}

Plotter& Nsound::Plotter::operator= ( const Plotter &  rhs )

private

Asignment disabled.

PyObject* Nsound::Plotter::makePyListFromBuffer ( const Buffer &  buffer ) const

private

Create a PyList object from a buffer!

Referenced by imagesc(), and plot().

PyObject* Nsound::Plotter::makePyIntFromUint32 ( const uint32 &  i ) const

private

Create a PyInt.

Member Data Documentation

int32 Plotter::count_ = 0

staticprotected

Definition at line 207 of file Plotter.h.

Referenced by Plotter(), and ~Plotter().

Plotter::PylabTable Plotter::table_

staticprotected

Definition at line 209 of file Plotter.h.

Referenced by _make_kwargs(), axhline(), axvline(), figure(), hide(), hold(), imagesc(), legend(), plot(), Plotter(), run_string(), show(), subplot(), text(), title(), xlabel(), xlim(), ylabel(), and ylim().

Plotter::PlotterState Nsound::Plotter::state_ = Plotter::BOOTING

staticprotected

Definition at line 218 of file Plotter.h.

Referenced by axhline(), axvline(), figure(), hide(), hold(), imagesc(), plot(), Plotter(), savefig(), show(), subplot(), text(), title(), xlabel(), xlim(), ylabel(), ylim(), and ~Plotter().

boolean Plotter::grid_is_on_ = true

staticprotected

Definition at line 220 of file Plotter.h.

Referenced by imagesc(), plot(), and subplot().

boolean Plotter::hold_is_on_ = false

staticprotected

Definition at line 221 of file Plotter.h.

Referenced by hold().

float64 Plotter::xmin_ = 1e300

staticprotected

Definition at line 223 of file Plotter.h.

float64 Plotter::xmax_ = -1e300

staticprotected

Definition at line 224 of file Plotter.h.

float64 Plotter::ymin_ = 1e300

staticprotected

Definition at line 225 of file Plotter.h.

float64 Plotter::ymax_ = -1e300

staticprotected

Definition at line 226 of file Plotter.h.

---

The documentation for this class was generated from the following files:

• Nsound/Plotter.h
• Nsound/Plotter.cc