Mercurial > hg > kwantix

comparison src/include/vtkplot.hpp @ 61:b3bf4ac981ec default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update the doxygen documentation
author Jordi Gutiérrez Hermoso <jordigh@gmail.com>
date Sat, 29 May 2010 20:01:40 -0500 (2010-05-30)
parents 11395e64852f
children
comparison
equal deleted inserted replaced
60:0288895c1071 61:b3bf4ac981ec
1 /*! \file vtkplot.hpp
2 * \brief VTK plotting utils
3 *
4 * \file vtkplot.cpp
5 * \brief Implementations and pinstantiations of the functions and
6 * classes declared in vtkplot.hpp
7 */
8
1 #pragma once 9 #pragma once
2 10
3 #include <string> 11 #include <string>
4 12
5 #include <vtkSmartPointer.h> 13 #include <vtkSmartPointer.h>
6 #include <vtkProgrammableFilter.h> 14 #include <vtkProgrammableFilter.h>
7 #include <vtkRenderWindow.h> 15 #include <vtkRenderWindow.h>
8 #include <vtkRenderer.h> 16 #include <vtkRenderer.h>
9 17
10 #include "interpolator.hpp" 18 #include "interpolator.hpp"
19
11 namespace kwantix{ 20 namespace kwantix{
12 21
22 /** \defgroup VTK */
23 /// \{
13 ///A class for creating VTK plots 24 ///A class for creating VTK plots
14 class vtkplot{ 25 class vtkplot{
15 public: 26 public:
16 /*! \brief Constructor performs a Delaunay triangulation on data 27 /*! \brief Constructor performs a Delaunay triangulation on data
17 * \param data - An \f$n \times 3\f$ matrix where the first two 28 * \param u - An interpolator on a 2d domain
18 * columns are points in the x-y plane on which a 29 * \param zmin_in - Minimum value this interpolator is expected to take
19 * Delaunay triangulation will be done, and the 30 * (for colouring purposes)
20 * third column is the value at this point. 31 * \param zmax_in - Maximum value this interpolator is expected to take
32 * (for colouring purposes)
33 * \param offscreen_in - Whether it will be offscreen plotting or not
21 */ 34 */
22 template<typename RBF> 35 template<typename RBF>
23 vtkplot(const interpolator<RBF>& u, 36 vtkplot(const interpolator<RBF>& u,
24 double zmin_in, double zmax_in, 37 double zmin_in, double zmax_in,
25 bool offscreen_in = false); 38 bool offscreen_in = false);
78 string basename; 91 string basename;
79 ///Whether to plot offscreen or not 92 ///Whether to plot offscreen or not
80 bool offscreen; 93 bool offscreen;
81 }; 94 };
82 95
96 /// \}
97
83 } //namespace kwantix 98 } //namespace kwantix
99 ///\}