WavePlotter

Namespaces
namespace	wavePlotter
	Custom plotter class.

Classes
class	wavePlotter::Plotter
	This class is used to plot the wave field TODO: make it multithreaded. More...

Functions
	wavePlotter::Plotter::Plotter (const boost::multi_array< double, 3 > &u, const matplot::vector_2d &Xp, const matplot::vector_2d &Zp, int num_levels, int nt)
	Constructor.
void	wavePlotter::Plotter::renderFrame (int index)
	Renders a frame of the wave field to a image on disk.
void	wavePlotter::Plotter::renderAllFrames (int begin_frame_index, int end_frame_index)
	Renders all frames of the wave field to form an animation to be saved on disk.
void	wavePlotter::Plotter::animate (std::string output_file_name, int begin_frame_index, int end_frame_index, int frame_rate)
	Renders a complete video animation of the wave field.
void	wavePlotter::Plotter::exportFrame (int index)
	Export a frame of the wave field to a .csv format for external use.
void	wavePlotter::Plotter::exportAllFrames (int begin_frame_index, int end_frame_index)
	Export all frames of the wave field to a .csv format for external use.
void	wavePlotter::Plotter::setSaveDirectory (std::string save_directory)
	Set the save directory for the rendered frames.

Detailed Description

Function Documentation

animate()

void wavePlotter::Plotter::animate ( std::string  output_file_name, int  begin_frame_index, int  end_frame_index, int  frame_rate  )

inline

Renders a complete video animation of the wave field.

Definition at line 56 of file wavePlotter.hpp.

        {
            renderAllFrames(begin_frame_index, end_frame_index);
            std::string ffmpeg_render_command = "ffmpeg -framerate " + std::to_string(frame_rate) + " -pattern_type glob -i '" + save_directory + "/*.png' -c:v libx264 -pix_fmt yuv420p " + output_file_name;
            std::system(ffmpeg_render_command.c_str());
        }

exportAllFrames()

void wavePlotter::Plotter::exportAllFrames ( int  begin_frame_index, int  end_frame_index  )

inline

Export all frames of the wave field to a .csv format for external use.

Definition at line 82 of file wavePlotter.hpp.

        {
            for (int i = begin_frame_index; i < end_frame_index; i++)
            {
                exportFrame(i);
            }
        }

exportFrame()

void wavePlotter::Plotter::exportFrame ( int  index )

inline

Export a frame of the wave field to a .csv format for external use.

Definition at line 63 of file wavePlotter.hpp.

        {
            matplot::vector_2d Up = np::convert_to_matplot(this->u[index]);
            std::ofstream outfile;
            outfile.open(save_directory + "/frame_" + format_num(index) + ".csv");
            for (std::size_t i = 0; i < Up.size(); i++)
            {
                for (std::size_t j = 0; j < Up[i].size(); j++)
                {
                    outfile << Up[i][j];
                    if (j != Up[i].size() - 1)
                        outfile << ",";
                }
                outfile << "\n";
            }
            outfile.close();
        }

Plotter()

wavePlotter::Plotter::Plotter ( const boost::multi_array< double, 3 > &  u, const matplot::vector_2d &  Xp, const matplot::vector_2d &  Zp, int  num_levels, int  nt  )

inline

Constructor.

Definition at line 25 of file wavePlotter.hpp.

        {
            this->u.resize(boost::extents[u.shape()[0]][u.shape()[1]][u.shape()[2]]);
            this->u = u;
            this->Xp = Xp;
            this->Zp = Zp;
            this->num_levels = num_levels;
            this->nt = nt;
            double min_u = np::min(u);
            double max_u = np::max(u);
            std::cout << "min_u = " << min_u << " max_u = " << max_u << "\n";
            this->levels = matplot::linspace(min_u, max_u, num_levels);
        }

renderAllFrames()

void wavePlotter::Plotter::renderAllFrames ( int  begin_frame_index, int  end_frame_index  )

inline

Renders all frames of the wave field to form an animation to be saved on disk.

Definition at line 47 of file wavePlotter.hpp.

        {
            for (int i = begin_frame_index; i < end_frame_index; i++)
            {
                renderFrame(i);
            }
        }

renderFrame()

void wavePlotter::Plotter::renderFrame ( int  index )

inline

Renders a frame of the wave field to a image on disk.

Definition at line 39 of file wavePlotter.hpp.

        {
            matplot::vector_2d Up = np::convert_to_matplot(this->u[index]);
            matplot::contourf(this->Xp, this->Zp, Up, this->levels);
            matplot::save(save_directory + "/contourf_" + format_num(index) + ".png");
        }

setSaveDirectory()

void wavePlotter::Plotter::setSaveDirectory ( std::string  save_directory )

inline

Set the save directory for the rendered frames.

Definition at line 91 of file wavePlotter.hpp.

        {
            this->save_directory = save_directory;
        }