Plotter.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//
//  $Id: Plotter.h 912 2015-07-26 00:50:29Z weegreenblobbie $
//
//  Nsound is a C++ library and Python module for audio synthesis featuring
//  dynamic digital filters. Nsound lets you easily shape waveforms and write
//  to disk or plot them. Nsound aims to be as powerful as Csound but easy to
//  use.
//
//  Copyright (c) 2005-Present Nick Hilton
//
//  weegreenblobbie_yahoo_com (replace '_' with '@' and '.')
//
//-----------------------------------------------------------------------------

//-----------------------------------------------------------------------------
//
//  This program is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation; either version 2 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU Library General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
//-----------------------------------------------------------------------------
#ifndef _NSOUND_PLOTTER_H_
#define _NSOUND_PLOTTER_H_

#include <Nsound/Nsound.h>

#include <map>
#include <string>


namespace Nsound
{

class AudioStream;
class Buffer;

#if ! ( defined(NSOUND_C_PYLAB) || defined(NSOUND_IN_PYTHON_MODULE) )
    typedef void PyObject;
#endif

//-----------------------------------------------------------------------------
class Axes
{
    public:

    Axes(PyObject * axes_ptr);
    Axes(const Axes & copy);
    ~Axes();
    Axes & operator=(const Axes & rhs);
    PyObject * get_axes(){return axes_ptr_;};

    private:

    PyObject * axes_ptr_;
};

//-----------------------------------------------------------------------------
// DOXME
class Plotter
{
    public:

    Plotter();

    virtual ~Plotter();

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

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

    void xlim(const float64 & xmin, const float64 & xmax);
    void ylim(const float64 & ymin, const float64 & ymax);

    void figure(const std::string & kwargs="") const;

    void grid(boolean flag);

    void hide();

    void hold(boolean flag);

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

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

    void legend(const std::string & kwargs="");

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

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

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

    void run_string(const std::string & command) const;

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

    void
    set_xscale(const std::string & s);

    void
    set_yscale(const std::string & s);

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

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

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

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

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

    static
    void
    show();

    void _swig_shadow(){};

    protected:

    typedef std::pair < std::string, PyObject * > StringPyObjectPair;
    typedef std::map  < std::string, PyObject * > PylabTable;

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

    static int32 count_;

    static PylabTable table_;

    enum PlotterState
    {
        BOOTING,
        INITALIZED,
        UNLOADED,
    };

    static PlotterState state_;

    static boolean grid_is_on_;
    static boolean hold_is_on_;

    static float64 xmin_;
    static float64 xmax_;
    static float64 ymin_;
    static float64 ymax_;

    // disable these
    private:

    Plotter(const Plotter & rhs);

    Plotter & operator=(const Plotter & rhs);

    PyObject * makePyListFromBuffer(const Buffer & buffer) const;

    PyObject * makePyIntFromUint32(const uint32 & i) const;

};

} // namespace

// :mode=c++: jEdit modeline

#endif