MRPT logo

mrpt::gui::CDisplayWindowPlots Class Reference

Create a GUI window and display plots with MATLAB-like interfaces and commands. More...

#include <mrpt/gui/CDisplayWindowPlots.h>

Inheritance diagram for mrpt::gui::CDisplayWindowPlots:

mrpt::utils::CSerializable mrpt::gui::CBaseGUIWindow

List of all members.

Public Types

typedef void(* TCallbackMenu )(int menuID, float cursor_x, float cursor_y, void *userParam)
 Type for the callback function used in setMenuCallback.

Public Member Functions

 CDisplayWindowPlots (const std::string &windowCaption=std::string(), unsigned int initialWidth=350, unsigned int initialHeight=300)
 Constructor.
virtual ~CDisplayWindowPlots ()
 Destructor.
void resize (unsigned int width, unsigned int height)
 Resizes the window, stretching the image to fit into the display area.
void setPos (int x, int y)
 Changes the position of the window on the screen.
void setWindowTitle (const std::string &str)
 Changes the window title text.
void enableMousePanZoom (bool enabled)
 Enable/disable the feature of pan/zoom with the mouse (default=enabled).
template<typename T >
void MRPTDLLIMPEXP plot (const std::vector< T > &x, const std::vector< T > &y, const std::string &lineFormat=std::string("b-"), const std::string &plotName=std::string("plotXY"))
 Adds a new layer with a 2D plot based on two vectors of X and Y points, using a MATLAB-like syntax.
template<typename T >
void MRPTDLLIMPEXP plot (const std::vector< T > &y, const std::string &lineFormat=std::string("b-"), const std::string &plotName=std::string("plotXY"))
 Adds a new layer with a 2D plot based on the vector Y, using a MATLAB-like syntax.
void axis (float x_min, float x_max, float y_min, float y_max, bool aspectRatioFix=false)
 Set the view area according to the passed coordinated.
void axis_equal (bool enable=true)
 Enable/disable the fixed X/Y aspect ratio fix feature (default=disabled).
void axis_fit (bool aspectRatioFix=false)
 Fix automatically the view area according to existing graphs.
template<typename T >
void MRPTDLLIMPEXP plotEllipse (const T mean_x, const T mean_y, const CMatrixTemplateNumeric< T > &cov22, const float quantiles, const std::string &lineFormat=std::string("b-"), const std::string &plotName=std::string("plotEllipse"), bool showName=false)
 Plots a 2D ellipse given its mean, covariance matrix, and Each call to this function creates a new plot, unless the plot name coincides with an already existing plot: in this case the new values are used to update this existing layer (this also applies to using the default plot name).
template<typename T >
void MRPTDLLIMPEXP plotEllipse (const T mean_x, const T mean_y, const CMatrixFixedNumeric< T, 2, 2 > &cov22, const float quantiles, const std::string &lineFormat=std::string("b-"), const std::string &plotName=std::string("plotEllipse"), bool showName=false)
 Plots a 2D ellipse given its mean, covariance matrix, and Each call to this function creates a new plot, unless the plot name coincides with an already existing plot: in this case the new values are used to update this existing layer (this also applies to using the default plot name).
void image (const utils::CImage &img, const float &x_left, const float &y_bottom, const float &x_width, const float &y_height, const std::string &plotName=std::string("image"))
 Adds a bitmap image layer.
void clear ()
 Remove all plot objects in the display.
void clf ()
 Remove all plot objects in the display (clear and clf do exactly the same).
void hold_on ()
 Enables keeping all the graphs, instead of overwritting them.
void hold_off ()
 Disables keeping all the graphs (this is the default behavior).
void addPopupMenuEntry (const std::string &label, int menuID)
 Disables keeping all the graphs (this is the default behavior).
void setMenuCallback (TCallbackMenu userFunction, void *userParam=NULL)
 Must be called to have a callback when the user selects one of the user-defined entries in the popup menu.

Protected Attributes

bool m_holdon
 Whether hold_on is enabled.
bool m_holdon_just_disabled
uint32_t m_holdon_cnt
 Counter for hold_on.
TCallbackMenu m_callback
void * m_callback_param

Friends

class CWindowDialogPlots

Detailed Description

Create a GUI window and display plots with MATLAB-like interfaces and commands.

See CDisplayWindowPlots::plot

Definition at line 53 of file CDisplayWindowPlots.h.

Member Typedef Documentation

typedef void(* mrpt::gui::CDisplayWindowPlots::TCallbackMenu)(int menuID, float cursor_x, float cursor_y, void *userParam)

Type for the callback function used in setMenuCallback.

Definition at line 59 of file CDisplayWindowPlots.h.

Constructor & Destructor Documentation

mrpt::gui::CDisplayWindowPlots::CDisplayWindowPlots ( const std::string &  windowCaption = std::string(),
unsigned int  initialWidth = 350,
unsigned int  initialHeight = 300 
)

Constructor.

virtual mrpt::gui::CDisplayWindowPlots::~CDisplayWindowPlots (  )  [virtual]

Destructor.

Member Function Documentation

void mrpt::gui::CDisplayWindowPlots::addPopupMenuEntry ( const std::string &  label,
int  menuID 
)

Disables keeping all the graphs (this is the default behavior).

Parameters:
label The text that appears in the new popup menu item.
menuID Any positive number (0,1,..). Used to tell which menu was selected in the user callback.
See also:
setMenuCallback

void mrpt::gui::CDisplayWindowPlots::axis ( float  x_min,
float  x_max,
float  y_min,
float  y_max,
bool  aspectRatioFix = false 
)

Set the view area according to the passed coordinated.

void mrpt::gui::CDisplayWindowPlots::axis_equal ( bool  enable = true  ) 

Enable/disable the fixed X/Y aspect ratio fix feature (default=disabled).

void mrpt::gui::CDisplayWindowPlots::axis_fit ( bool  aspectRatioFix = false  ) 

Fix automatically the view area according to existing graphs.

void mrpt::gui::CDisplayWindowPlots::clear (  ) 

Remove all plot objects in the display.

See also:
plot

void mrpt::gui::CDisplayWindowPlots::clf (  )  [inline]

Remove all plot objects in the display (clear and clf do exactly the same).

See also:
plot, hold_on, hold_off

Definition at line 242 of file CDisplayWindowPlots.h.

void mrpt::gui::CDisplayWindowPlots::enableMousePanZoom ( bool  enabled  ) 

Enable/disable the feature of pan/zoom with the mouse (default=enabled).

void mrpt::gui::CDisplayWindowPlots::hold_off (  ) 

Disables keeping all the graphs (this is the default behavior).

See also:
hold_on, plot

void mrpt::gui::CDisplayWindowPlots::hold_on (  ) 

Enables keeping all the graphs, instead of overwritting them.

See also:
hold_off, plot

void mrpt::gui::CDisplayWindowPlots::image ( const utils::CImage &  img,
const float &  x_left,
const float &  y_bottom,
const float &  x_width,
const float &  y_height,
const std::string &  plotName = std::string("image") 
)

Adds a bitmap image layer.

Each call to this function creates a new layer, unless the plot name coincides with an already existing plot: in this case the new values are used to update this existing layer (this also applies to using the default plot name).

See also:
axis, axis_equal, axis_fit, hold_on, hold_off

template<typename T >
void MRPTDLLIMPEXP mrpt::gui::CDisplayWindowPlots::plot ( const std::vector< T > &  y,
const std::string &  lineFormat = std::string("b-"),
const std::string &  plotName = std::string("plotXY") 
) [inline]

Adds a new layer with a 2D plot based on the vector Y, using a MATLAB-like syntax.

Each call to this function creates a new plot, unless the plot name coincides with an already existing plot: in this case the X & Y points are used to update this existing layer (this also applies to using the default plot name). If "hold_on" is enabled, then every call will always create a new plot, even if no "plotName" is provided.

The lineFormat string is a combination of the following characters:

  • Line styles:
    • '.': One point for each data point
    • '-': A continuous line
    • ':': A dashed line
  • Colors:
    • k: black
    • r: red
    • g: green
    • b: blue
    • m: magenta
    • c: cyan
  • Line width:
    • '1' to '9': The line width (default=1)

Examples:

  • 'r.' -> red points.
  • 'k3' or 'k-3' -> A black line with a line width of 3 pixels.
    Note:
    The method can be called with vectors of types: float, double.
    See also:
    axis, axis_equal, axis_fit, clear, hold_on, hold_off

template<typename T >
void MRPTDLLIMPEXP mrpt::gui::CDisplayWindowPlots::plot ( const std::vector< T > &  x,
const std::vector< T > &  y,
const std::string &  lineFormat = std::string("b-"),
const std::string &  plotName = std::string("plotXY") 
) [inline]

Adds a new layer with a 2D plot based on two vectors of X and Y points, using a MATLAB-like syntax.

Each call to this function creates a new plot, unless the plot name coincides with an already existing plot: in this case the X & Y points are used to update this existing layer (this also applies to using the default plot name). If "hold_on" is enabled, then every call will always create a new plot, even if no "plotName" is provided.

The lineFormat string is a combination of the following characters:

  • Line styles:
    • '.': One point for each data point
    • '-': A continuous line
    • ':': A dashed line
  • Colors:
    • k: black
    • r: red
    • g: green
    • b: blue
    • m: magenta
    • c: cyan
  • Line width:
    • '1' to '9': The line width (default=1)

Examples:

template<typename T >
void MRPTDLLIMPEXP mrpt::gui::CDisplayWindowPlots::plotEllipse ( const T  mean_x,
const T  mean_y,
const CMatrixFixedNumeric< T, 2, 2 > &  cov22,
const float  quantiles,
const std::string &  lineFormat = std::string("b-"),
const std::string &  plotName = std::string("plotEllipse"),
bool  showName = false 
) [inline]

Plots a 2D ellipse given its mean, covariance matrix, and Each call to this function creates a new plot, unless the plot name coincides with an already existing plot: in this case the new values are used to update this existing layer (this also applies to using the default plot name).

If "hold_on" is enabled, then every call will always create a new plot, even if no "plotName" is provided.

For a description of lineFormat see CDisplayWindowPlots::plot. The "quantiles" value determines the confidence interval for the ellipse:

  • 1 : 68.27% confidence interval
  • 2 : 95.45%
  • 3 : 99.73%
  • 4 : 99.994%
    Note:
    This method can be called with 2x2 fixed-sized or dynamic-size matrices of types: float or double.
    See also:
    axis, axis_equal, axis_fit, hold_on, hold_off

template<typename T >
void MRPTDLLIMPEXP mrpt::gui::CDisplayWindowPlots::plotEllipse ( const T  mean_x,
const T  mean_y,
const CMatrixTemplateNumeric< T > &  cov22,
const float  quantiles,
const std::string &  lineFormat = std::string("b-"),
const std::string &  plotName = std::string("plotEllipse"),
bool  showName = false 
) [inline]

Plots a 2D ellipse given its mean, covariance matrix, and Each call to this function creates a new plot, unless the plot name coincides with an already existing plot: in this case the new values are used to update this existing layer (this also applies to using the default plot name).

If "hold_on" is enabled, then every call will always create a new plot, even if no "plotName" is provided.

For a description of lineFormat see CDisplayWindowPlots::plot. The "quantiles" value determines the confidence interval for the ellipse:

  • 1 : 68.27% confidence interval
  • 2 : 95.45%
  • 3 : 99.73%
  • 4 : 99.994%
    Note:
    This method can be called with 2x2 fixed-sized or dynamic-size matrices of types: float or double.
    See also:
    axis, axis_equal, axis_fit, hold_on, hold_off

void mrpt::gui::CDisplayWindowPlots::resize ( unsigned int  width,
unsigned int  height 
) [virtual]

Resizes the window, stretching the image to fit into the display area.

Implements mrpt::gui::CBaseGUIWindow.

void mrpt::gui::CDisplayWindowPlots::setMenuCallback ( TCallbackMenu  userFunction,
void *  userParam = NULL 
)

Must be called to have a callback when the user selects one of the user-defined entries in the popup menu.

See also:
addPopupMenuEntry

void mrpt::gui::CDisplayWindowPlots::setPos ( int  x,
int  y 
) [virtual]

Changes the position of the window on the screen.

Implements mrpt::gui::CBaseGUIWindow.

void mrpt::gui::CDisplayWindowPlots::setWindowTitle ( const std::string &  str  )  [virtual]

Changes the window title text.

Implements mrpt::gui::CBaseGUIWindow.

Friends And Related Function Documentation

friend class CWindowDialogPlots [friend]

Reimplemented from mrpt::gui::CBaseGUIWindow.

Definition at line 62 of file CDisplayWindowPlots.h.

Member Data Documentation

TCallbackMenu mrpt::gui::CDisplayWindowPlots::m_callback [protected]

Definition at line 67 of file CDisplayWindowPlots.h.

void* mrpt::gui::CDisplayWindowPlots::m_callback_param [protected]

Definition at line 68 of file CDisplayWindowPlots.h.

bool mrpt::gui::CDisplayWindowPlots::m_holdon [protected]

Whether hold_on is enabled.

Definition at line 64 of file CDisplayWindowPlots.h.

uint32_t mrpt::gui::CDisplayWindowPlots::m_holdon_cnt [protected]

Counter for hold_on.

Definition at line 66 of file CDisplayWindowPlots.h.

bool mrpt::gui::CDisplayWindowPlots::m_holdon_just_disabled [protected]

Definition at line 65 of file CDisplayWindowPlots.h.



Page generated by Doxygen 1.5.9 for MRPT 0.7.1 SVN: at Mon Aug 17 22:20:53 EDT 2009