KiCad PCB EDA Suite
mpCovarianceEllipse Class Reference

A 2D ellipse, described by a 2x2 covariance matrix. More...

#include <mathplot.h>

Inheritance diagram for mpCovarianceEllipse:
mpMovableObject mpLayer

Public Member Functions

 mpCovarianceEllipse (double cov_00=1, double cov_11=1, double cov_01=0, double quantiles=2, int segments=32, const wxString &layerName=wxT(""))
 Default constructor. More...
 
virtual ~mpCovarianceEllipse ()
 
double GetQuantiles () const
 
void SetQuantiles (double q)
 Set how many "quantiles" to draw, that is, the confidence interval of the ellipse (see above). More...
 
void SetSegments (int segments)
 
int GetSegments () const
 
void GetCovarianceMatrix (double &cov_00, double &cov_01, double &cov_11) const
 Returns the elements of the current covariance matrix: More...
 
void SetCovarianceMatrix (double cov_00, double cov_01, double cov_11)
 Changes the covariance matrix: More...
 
void GetCoordinateBase (double &x, double &y, double &phi) const
 Get the current coordinate transformation. More...
 
void SetCoordinateBase (double x, double y, double phi=0)
 Set the coordinate transformation (phi in radians, 0 means no rotation). More...
 
virtual bool HasBBox () override
 Check whether this layer has a bounding box. More...
 
virtual double GetMinX () override
 Get inclusive left border of bounding box. More...
 
virtual double GetMaxX () override
 Get inclusive right border of bounding box. More...
 
virtual double GetMinY () override
 Get inclusive bottom border of bounding box. More...
 
virtual double GetMaxY () override
 Get inclusive top border of bounding box. More...
 
virtual void Plot (wxDC &dc, mpWindow &w) override
 Plot given view of layer to the given device context. More...
 
void SetAlign (int align)
 Set label axis alignment. More...
 
virtual bool IsInfo ()
 Check whether the layer is an info box. More...
 
const wxString & GetName () const
 Get layer name. More...
 
const wxFont & GetFont () const
 Get font set for this layer. More...
 
const wxPen & GetPen () const
 Get pen set for this layer. More...
 
void SetContinuity (bool continuity)
 Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points). More...
 
bool GetContinuity () const
 Gets the 'continuity' property of the layer. More...
 
void ShowName (bool show)
 Shows or hides the text label with the name of the layer (default is visible). More...
 
void SetName (wxString name)
 Set layer name. More...
 
void SetFont (wxFont &font)
 Set layer font. More...
 
void SetPen (wxPen pen)
 Set layer pen. More...
 
void SetDrawOutsideMargins (bool drawModeOutside)
 Set Draw mode: inside or outside margins. More...
 
bool GetDrawOutsideMargins ()
 Get Draw mode: inside or outside margins. More...
 
wxBitmap GetColourSquare (int side=16)
 Get a small square bitmap filled with the colour of the pen used in the layer. More...
 
mpLayerType GetLayerType ()
 Get layer type: a Layer can be of different types: plot lines, axis, info boxes, etc, this method returns the right value. More...
 
bool IsVisible ()
 Checks whether the layer is visible or not. More...
 
void SetVisible (bool show)
 Sets layer visibility. More...
 
const wxBrush & GetBrush () const
 Get brush set for this layer. More...
 
void SetBrush (wxBrush brush)
 Set layer brush. More...
 

Protected Member Functions

void RecalculateShape ()
 Called to update the m_shape_xs, m_shape_ys vectors, whenever a parameter changes. More...
 
void TranslatePoint (double x, double y, double &out_x, double &out_y)
 A method for 2D translation and rotation, using the current transformation stored in m_reference_x,m_reference_y,m_reference_phi. More...
 
void ShapeUpdated ()
 Must be called by the descendent class after updating the shape (m_shape_xs/ys), or when the transformation changes. More...
 

Protected Attributes

double m_cov_00
 The elements of the matrix (only 3 since cov(0,1)=cov(1,0) in any positive definite matrix). More...
 
double m_cov_11
 
double m_cov_01
 
double m_quantiles
 
int m_segments
 The number of line segments that build up the ellipse. More...
 
int m_flags
 
double m_reference_x
 The coordinates of the object (orientation "phi" is in radians). More...
 
double m_reference_y
 
double m_reference_phi
 
std::vector< double > m_shape_xs
 This contains the object points, in local coordinates (to be transformed by the current transformation). More...
 
std::vector< double > m_shape_ys
 
std::vector< double > m_trans_shape_xs
 The buffer for the translated & rotated points (to avoid recomputing them with each mpWindow refresh). More...
 
std::vector< double > m_trans_shape_ys
 
double m_bbox_min_x
 The precomputed bounding box: More...
 
double m_bbox_max_x
 
double m_bbox_min_y
 
double m_bbox_max_y
 
wxFont m_font
 
wxPen m_pen
 
wxBrush m_brush
 
wxString m_name
 
bool m_continuous
 
bool m_showName
 
bool m_drawOutsideMargins
 
mpLayerType m_type
 
bool m_visible
 

Detailed Description

A 2D ellipse, described by a 2x2 covariance matrix.

The relation between the multivariate Gaussian confidence interval and the "quantiles" in this class is:

The ellipse will be always centered at the origin. Use mpMovableObject::SetCoordinateBase to move it.

Definition at line 1794 of file mathplot.h.

Constructor & Destructor Documentation

mpCovarianceEllipse::mpCovarianceEllipse ( double  cov_00 = 1,
double  cov_11 = 1,
double  cov_01 = 0,
double  quantiles = 2,
int  segments = 32,
const wxString &  layerName = wxT("") 
)
inline

Default constructor.

Initializes to a unity diagonal covariance matrix, a 95% confidence interval (2 sigmas), 32 segments, and a continuous plot (m_continuous=true).

Definition at line 1800 of file mathplot.h.

References mpLAYER_PLOT.

1805  :
1806  m_cov_00( cov_00 ),
1807  m_cov_11( cov_11 ),
1808  m_cov_01( cov_01 ),
1809  m_quantiles( quantiles ),
1810  m_segments( segments )
1811  {
1812  m_continuous = true;
1813  m_name = layerName;
1814  RecalculateShape();
1815  m_type = mpLAYER_PLOT;
1816  }
bool m_continuous
Definition: mathplot.h:317
void RecalculateShape()
Called to update the m_shape_xs, m_shape_ys vectors, whenever a parameter changes.
Definition: mathplot.cpp:3727
int m_segments
The number of line segments that build up the ellipse.
Definition: mathplot.h:1860
mpLayerType m_type
Definition: mathplot.h:320
wxString m_name
Definition: mathplot.h:316
double m_cov_00
The elements of the matrix (only 3 since cov(0,1)=cov(1,0) in any positive definite matrix)...
Definition: mathplot.h:1855
virtual mpCovarianceEllipse::~mpCovarianceEllipse ( )
inlinevirtual

Definition at line 1818 of file mathplot.h.

1818 {}

Member Function Documentation

const wxBrush& mpLayer::GetBrush ( ) const
inlineinherited

Get brush set for this layer.

Returns
brush.

Definition at line 305 of file mathplot.h.

305 { return m_brush; };
wxBrush m_brush
Definition: mathplot.h:315
wxBitmap mpLayer::GetColourSquare ( int  side = 16)
inherited

Get a small square bitmap filled with the colour of the pen used in the layer.

Useful to create legends or similar reference to the layers.

Parameters
sideside length in pixels
Returns
a wxBitmap filled with layer's colour

Definition at line 82 of file mathplot.cpp.

References mpLayer::m_pen, and square().

83 {
84  wxBitmap square( side, side, -1 );
85  wxColour filler = m_pen.GetColour();
86  wxBrush brush( filler, wxBRUSHSTYLE_SOLID );
87  wxMemoryDC dc;
88 
89  dc.SelectObject( square );
90  dc.SetBackground( brush );
91  dc.Clear();
92  dc.SelectObject( wxNullBitmap );
93  return square;
94 }
static double square(int x)
Definition: trigo.cpp:138
wxPen m_pen
Definition: mathplot.h:314
bool mpLayer::GetContinuity ( ) const
inlineinherited

Gets the 'continuity' property of the layer.

See also
SetContinuity

Definition at line 257 of file mathplot.h.

257 { return m_continuous; }
bool m_continuous
Definition: mathplot.h:317
void mpMovableObject::GetCoordinateBase ( double &  x,
double &  y,
double &  phi 
) const
inlineinherited

Get the current coordinate transformation.

Definition at line 1703 of file mathplot.h.

1704  {
1705  x = m_reference_x;
1706  y = m_reference_y;
1707  phi = m_reference_phi;
1708  }
double m_reference_x
The coordinates of the object (orientation "phi" is in radians).
Definition: mathplot.h:1751
double m_reference_y
Definition: mathplot.h:1751
double m_reference_phi
Definition: mathplot.h:1751
void mpCovarianceEllipse::GetCovarianceMatrix ( double &  cov_00,
double &  cov_01,
double &  cov_11 
) const
inline

Returns the elements of the current covariance matrix:

Definition at line 1835 of file mathplot.h.

1836  {
1837  cov_00 = m_cov_00;
1838  cov_01 = m_cov_01;
1839  cov_11 = m_cov_11;
1840  }
double m_cov_00
The elements of the matrix (only 3 since cov(0,1)=cov(1,0) in any positive definite matrix)...
Definition: mathplot.h:1855
bool mpLayer::GetDrawOutsideMargins ( )
inlineinherited

Get Draw mode: inside or outside margins.

Returns
The draw mode

Definition at line 284 of file mathplot.h.

284 { return m_drawOutsideMargins; };
bool m_drawOutsideMargins
Definition: mathplot.h:319
const wxFont& mpLayer::GetFont ( ) const
inlineinherited

Get font set for this layer.

Returns
Font

Definition at line 242 of file mathplot.h.

242 { return m_font; }
wxFont m_font
Definition: mathplot.h:309
mpLayerType mpLayer::GetLayerType ( )
inlineinherited

Get layer type: a Layer can be of different types: plot lines, axis, info boxes, etc, this method returns the right value.

Returns
An integer indicating layer type

Definition at line 293 of file mathplot.h.

Referenced by mpInfoLegend::Plot().

293 { return m_type; };
mpLayerType m_type
Definition: mathplot.h:320
virtual double mpMovableObject::GetMaxX ( )
inlineoverridevirtualinherited

Get inclusive right border of bounding box.

Reimplemented from mpLayer.

Definition at line 1729 of file mathplot.h.

1729 { return m_bbox_max_x; }
double m_bbox_max_x
Definition: mathplot.h:1771
virtual double mpMovableObject::GetMaxY ( )
inlineoverridevirtualinherited

Get inclusive top border of bounding box.

Reimplemented from mpLayer.

Definition at line 1737 of file mathplot.h.

1737 { return m_bbox_max_y; }
double m_bbox_max_y
Definition: mathplot.h:1771
virtual double mpMovableObject::GetMinX ( )
inlineoverridevirtualinherited

Get inclusive left border of bounding box.

Reimplemented from mpLayer.

Definition at line 1725 of file mathplot.h.

1725 { return m_bbox_min_x; }
double m_bbox_min_x
The precomputed bounding box:
Definition: mathplot.h:1771
virtual double mpMovableObject::GetMinY ( )
inlineoverridevirtualinherited

Get inclusive bottom border of bounding box.

Reimplemented from mpLayer.

Definition at line 1733 of file mathplot.h.

1733 { return m_bbox_min_y; }
double m_bbox_min_y
Definition: mathplot.h:1771
const wxString& mpLayer::GetName ( void  ) const
inlineinherited

Get layer name.

Returns
Name

Definition at line 237 of file mathplot.h.

Referenced by SIM_PLOT_PANEL::GetLabelX(), SIM_PLOT_PANEL::GetLabelY1(), SIM_PLOT_PANEL::GetLabelY2(), mpInfoLegend::Plot(), and mpText::Plot().

237 { return m_name; }
wxString m_name
Definition: mathplot.h:316
const wxPen& mpLayer::GetPen ( ) const
inlineinherited

Get pen set for this layer.

Returns
Pen

Definition at line 247 of file mathplot.h.

Referenced by mpInfoLegend::Plot().

247 { return m_pen; }
wxPen m_pen
Definition: mathplot.h:314
double mpCovarianceEllipse::GetQuantiles ( ) const
inline

Definition at line 1820 of file mathplot.h.

1820 { return m_quantiles; }
int mpCovarianceEllipse::GetSegments ( ) const
inline

Definition at line 1831 of file mathplot.h.

1831 { return m_segments; }
int m_segments
The number of line segments that build up the ellipse.
Definition: mathplot.h:1860
virtual bool mpMovableObject::HasBBox ( )
inlineoverridevirtualinherited

Check whether this layer has a bounding box.

The default implementation returns TRUE. Override and return FALSE if your mpLayer implementation should be ignored by the calculation of the global bounding box for all layers in a mpWindow.

Return values
TRUEHas bounding box
FALSEHas not bounding box

Reimplemented from mpLayer.

Definition at line 1721 of file mathplot.h.

Referenced by mpMovableObject::Plot().

1721 { return m_trans_shape_xs.size()!=0; }
std::vector< double > m_trans_shape_xs
The buffer for the translated & rotated points (to avoid recomputing them with each mpWindow refresh)...
Definition: mathplot.h:1766
virtual bool mpLayer::IsInfo ( )
inlinevirtualinherited

Check whether the layer is an info box.

The default implementation returns FALSE. It is overrided to TRUE for mpInfoLayer class and its derivative. It is necessary to define mouse actions behaviour over info boxes.

Returns
whether the layer is an info boxes
See also
mpInfoLayer::IsInfo

Reimplemented in mpInfoLayer.

Definition at line 169 of file mathplot.h.

169 { return false; };
bool mpLayer::IsVisible ( )
inlineinherited

Checks whether the layer is visible or not.

Returns
true if visible

Definition at line 297 of file mathplot.h.

Referenced by mpWindow::IsLayerVisible(), SIM_PLOT_PANEL::IsLegendShown(), and mpInfoLegend::Plot().

297 { return m_visible; };
bool m_visible
Definition: mathplot.h:321
void mpMovableObject::Plot ( wxDC &  dc,
mpWindow w 
)
overridevirtualinherited

Plot given view of layer to the given device context.

An implementation of this function has to transform layer coordinates to wxDC coordinates based on the view parameters retrievable from the mpWindow passed in w. Note that the public methods of mpWindow: x2p,y2p and p2x,p2y are already provided which transform layer coordinates to DC pixel coordinates, and user code should rely on them for portability and future changes to be applied transparently, instead of implementing the following formulas manually.

The passed device context dc has its coordinate origin set to the top-left corner of the visible area (the default). The coordinate orientation is as shown in the following picture:

(wxDC origin 0,0)
x-------------> ascending X ----------------+
|                                           |
|                                           |
|  V ascending Y                            |
|                                           |
|                                           |
|                                           |
|+------------------------------------------+  <-- right-bottom corner of the mpWindow visible area.

Note that Y ascends in downward direction, whereas the usual vertical orientation for mathematical plots is vice versa. Thus Y-orientation will be swapped usually, when transforming between wxDC and mpLayer coordinates. This change of coordinates is taken into account in the methods p2x,p2y,x2p,y2p.

Rules for transformation between mpLayer and wxDC coordinates

dc_X = (layer_X - mpWindow::GetPosX()) * mpWindow::GetScaleX()
dc_Y = (mpWindow::GetPosY() - layer_Y) * mpWindow::GetScaleY() // swapping Y-orientation
layer_X = (dc_X / mpWindow::GetScaleX()) + mpWindow::GetPosX() // scale guaranteed to be not 0
layer_Y = mpWindow::GetPosY() - (dc_Y / mpWindow::GetScaleY()) // swapping Y-orientation
Parameters
dcDevice context to plot to.
wView to plot. The visible area can be retrieved from this object.
See also
mpWindow::p2x,mpWindow::p2y,mpWindow::x2p,mpWindow::y2p

Implements mpLayer.

Definition at line 3622 of file mathplot.cpp.

References mpWindow::GetPosX(), mpWindow::GetPosY(), mpWindow::GetScaleX(), mpWindow::GetScaleY(), mpWindow::GetScrX(), mpWindow::GetScrY(), mpMovableObject::HasBBox(), mpMovableObject::m_bbox_max_x, mpMovableObject::m_bbox_max_y, mpLayer::m_continuous, mpMovableObject::m_flags, mpLayer::m_font, mpLayer::m_name, mpLayer::m_pen, mpLayer::m_showName, mpMovableObject::m_trans_shape_xs, mpMovableObject::m_trans_shape_ys, mpLayer::m_visible, mpALIGN_NE, mpALIGN_NW, mpALIGN_SW, mpALIGNMASK, mpWindow::x2p(), and mpWindow::y2p().

3623 {
3624  if( m_visible )
3625  {
3626  dc.SetPen( m_pen );
3627 
3628 
3629  std::vector<double>::iterator itX = m_trans_shape_xs.begin();
3630  std::vector<double>::iterator itY = m_trans_shape_ys.begin();
3631 
3632  if( !m_continuous )
3633  {
3634  // for some reason DrawPoint does not use the current pen,
3635  // so we use DrawLine for fat pens
3636  if( m_pen.GetWidth() <= 1 )
3637  {
3638  while( itX!=m_trans_shape_xs.end() )
3639  {
3640  dc.DrawPoint( w.x2p( *(itX++) ), w.y2p( *(itY++) ) );
3641  }
3642  }
3643  else
3644  {
3645  while( itX!=m_trans_shape_xs.end() )
3646  {
3647  wxCoord cx = w.x2p( *(itX++) );
3648  wxCoord cy = w.y2p( *(itY++) );
3649  dc.DrawLine( cx, cy, cx, cy );
3650  }
3651  }
3652  }
3653  else
3654  {
3655  wxCoord cx0 = 0, cy0 = 0;
3656  bool first = true;
3657 
3658  while( itX!=m_trans_shape_xs.end() )
3659  {
3660  wxCoord cx = w.x2p( *(itX++) );
3661  wxCoord cy = w.y2p( *(itY++) );
3662 
3663  if( first )
3664  {
3665  first = false;
3666  cx0 = cx; cy0 = cy;
3667  }
3668 
3669  dc.DrawLine( cx0, cy0, cx, cy );
3670  cx0 = cx; cy0 = cy;
3671  }
3672  }
3673 
3674  if( !m_name.IsEmpty() && m_showName )
3675  {
3676  dc.SetFont( m_font );
3677 
3678  wxCoord tx, ty;
3679  dc.GetTextExtent( m_name, &tx, &ty );
3680 
3681  if( HasBBox() )
3682  {
3683  wxCoord sx = (wxCoord) ( ( m_bbox_max_x - w.GetPosX() ) * w.GetScaleX() );
3684  wxCoord sy = (wxCoord) ( (w.GetPosY() - m_bbox_max_y ) * w.GetScaleY() );
3685 
3686  tx = sx - tx - 8;
3687  ty = sy - 8 - ty;
3688  }
3689  else
3690  {
3691  const int sx = w.GetScrX() >> 1;
3692  const int sy = w.GetScrY() >> 1;
3693 
3694  if( (m_flags & mpALIGNMASK) == mpALIGN_NE )
3695  {
3696  tx = sx - tx - 8;
3697  ty = -sy + 8;
3698  }
3699  else if( (m_flags & mpALIGNMASK) == mpALIGN_NW )
3700  {
3701  tx = -sx + 8;
3702  ty = -sy + 8;
3703  }
3704  else if( (m_flags & mpALIGNMASK) == mpALIGN_SW )
3705  {
3706  tx = -sx + 8;
3707  ty = sy - 8 - ty;
3708  }
3709  else
3710  {
3711  tx = sx - tx - 8;
3712  ty = sy - 8 - ty;
3713  }
3714  }
3715 
3716  dc.DrawText( m_name, tx, ty );
3717  }
3718  }
3719 }
bool m_continuous
Definition: mathplot.h:317
#define mpALIGN_NW
Aligns label to north-west.
Definition: mathplot.h:506
std::vector< double > m_trans_shape_ys
Definition: mathplot.h:1766
int GetScrY(void) const
Get current view's Y dimension in device context units.
Definition: mathplot.h:1136
double GetPosY(void) const
Definition: mathplot.h:1119
bool m_visible
Definition: mathplot.h:321
double m_bbox_max_y
Definition: mathplot.h:1771
wxCoord y2p(double y)
Converts graph (floating point) coordinates into mpWindow (screen) pixel coordinates, using current mpWindow position and scale.
Definition: mathplot.h:1196
virtual bool HasBBox() override
Check whether this layer has a bounding box.
Definition: mathplot.h:1721
double GetPosX(void) const
Definition: mathplot.h:1112
wxFont m_font
Definition: mathplot.h:309
#define mpALIGN_NE
Aligns label to north-east.
Definition: mathplot.h:504
int GetScrX(void) const
Get current view's X dimension in device context units.
Definition: mathplot.h:1127
double GetScaleY(void) const
Definition: mathplot.h:1105
double GetScaleX(void) const
Definition: mathplot.h:1098
#define mpALIGNMASK
Definition: mathplot.h:474
bool m_showName
Definition: mathplot.h:318
wxCoord x2p(double x)
Converts graph (floating point) coordinates into mpWindow (screen) pixel coordinates, using current mpWindow position and scale.
Definition: mathplot.h:1191
wxPen m_pen
Definition: mathplot.h:314
std::vector< double > m_trans_shape_xs
The buffer for the translated & rotated points (to avoid recomputing them with each mpWindow refresh)...
Definition: mathplot.h:1766
wxString m_name
Definition: mathplot.h:316
double m_bbox_max_x
Definition: mathplot.h:1771
#define mpALIGN_SW
Aligns label to south-west.
Definition: mathplot.h:508
void mpCovarianceEllipse::RecalculateShape ( )
protected

Called to update the m_shape_xs, m_shape_ys vectors, whenever a parameter changes.

Definition at line 3727 of file mathplot.cpp.

References D, m_cov_00, m_cov_01, m_cov_11, m_quantiles, m_segments, mpMovableObject::m_shape_xs, mpMovableObject::m_shape_ys, and mpMovableObject::ShapeUpdated().

3728 {
3729  m_shape_xs.clear();
3730  m_shape_ys.clear();
3731 
3732  // Preliminar checks:
3733  if( m_quantiles<0 )
3734  {
3735  wxLogError( wxT( "[mpCovarianceEllipse] Error: quantiles must be non-negative" ) ); return;
3736  }
3737 
3738  if( m_cov_00<0 )
3739  {
3740  wxLogError( wxT( "[mpCovarianceEllipse] Error: cov(0,0) must be non-negative" ) ); return;
3741  }
3742 
3743  if( m_cov_11<0 )
3744  {
3745  wxLogError( wxT( "[mpCovarianceEllipse] Error: cov(1,1) must be non-negative" ) ); return;
3746  }
3747 
3748  m_shape_xs.resize( m_segments, 0 );
3749  m_shape_ys.resize( m_segments, 0 );
3750 
3751  // Compute the two eigenvalues of the covariance:
3752  // -------------------------------------------------
3753  double b = -m_cov_00 - m_cov_11;
3754  double c = m_cov_00 * m_cov_11 - m_cov_01 * m_cov_01;
3755 
3756  double D = b * b - 4 * c;
3757 
3758  if( D<0 )
3759  {
3760  wxLogError( wxT( "[mpCovarianceEllipse] Error: cov is not positive definite" ) ); return;
3761  }
3762 
3763  double eigenVal0 = 0.5 * ( -b + sqrt( D ) );
3764  double eigenVal1 = 0.5 * ( -b - sqrt( D ) );
3765 
3766  // Compute the two corresponding eigenvectors:
3767  // -------------------------------------------------
3768  double eigenVec0_x, eigenVec0_y;
3769  double eigenVec1_x, eigenVec1_y;
3770 
3771  if( fabs( eigenVal0 - m_cov_00 )>1e-6 )
3772  {
3773  double k1x = m_cov_01 / ( eigenVal0 - m_cov_00 );
3774  eigenVec0_y = 1;
3775  eigenVec0_x = eigenVec0_y * k1x;
3776  }
3777  else
3778  {
3779  double k1y = m_cov_01 / ( eigenVal0 - m_cov_11 );
3780  eigenVec0_x = 1;
3781  eigenVec0_y = eigenVec0_x * k1y;
3782  }
3783 
3784  if( fabs( eigenVal1 - m_cov_00 )>1e-6 )
3785  {
3786  double k2x = m_cov_01 / ( eigenVal1 - m_cov_00 );
3787  eigenVec1_y = 1;
3788  eigenVec1_x = eigenVec1_y * k2x;
3789  }
3790  else
3791  {
3792  double k2y = m_cov_01 / ( eigenVal1 - m_cov_11 );
3793  eigenVec1_x = 1;
3794  eigenVec1_y = eigenVec1_x * k2y;
3795  }
3796 
3797  // Normalize the eigenvectors:
3798  double len = sqrt( eigenVec0_x * eigenVec0_x + eigenVec0_y * eigenVec0_y );
3799  eigenVec0_x /= len; // It *CANNOT* be zero
3800  eigenVec0_y /= len;
3801 
3802  len = sqrt( eigenVec1_x * eigenVec1_x + eigenVec1_y * eigenVec1_y );
3803  eigenVec1_x /= len; // It *CANNOT* be zero
3804  eigenVec1_y /= len;
3805 
3806 
3807  // Take the sqrt of the eigenvalues (required for the ellipse scale):
3808  eigenVal0 = sqrt( eigenVal0 );
3809  eigenVal1 = sqrt( eigenVal1 );
3810 
3811  // Compute the 2x2 matrix M = diag(eigVal) * (~eigVec) (each eigen vector is a row):
3812  double M_00 = eigenVec0_x * eigenVal0;
3813  double M_01 = eigenVec0_y * eigenVal0;
3814 
3815  double M_10 = eigenVec1_x * eigenVal1;
3816  double M_11 = eigenVec1_y * eigenVal1;
3817 
3818  // The points of the 2D ellipse:
3819  double ang;
3820  double Aang = 6.283185308 / (m_segments - 1);
3821  int i;
3822 
3823  for( i = 0, ang = 0; i<m_segments; i++, ang += Aang )
3824  {
3825  double ccos = cos( ang );
3826  double csin = sin( ang );
3827 
3828  m_shape_xs[i] = m_quantiles * (ccos * M_00 + csin * M_10 );
3829  m_shape_ys[i] = m_quantiles * (ccos * M_01 + csin * M_11 );
3830  } // end for points on ellipse
3831 
3832  ShapeUpdated();
3833 }
int m_segments
The number of line segments that build up the ellipse.
Definition: mathplot.h:1860
void ShapeUpdated()
Must be called by the descendent class after updating the shape (m_shape_xs/ys), or when the transfor...
Definition: mathplot.cpp:3574
#define D(x)
Definition: ptree.cpp:41
std::vector< double > m_shape_ys
Definition: mathplot.h:1761
double m_cov_00
The elements of the matrix (only 3 since cov(0,1)=cov(1,0) in any positive definite matrix)...
Definition: mathplot.h:1855
std::vector< double > m_shape_xs
This contains the object points, in local coordinates (to be transformed by the current transformatio...
Definition: mathplot.h:1761
void mpMovableObject::SetAlign ( int  align)
inlineinherited

Set label axis alignment.

Parameters
alignalignment (choose between mpALIGN_NE, mpALIGN_NW, mpALIGN_SW, mpALIGN_SE

Definition at line 1744 of file mathplot.h.

1744 { m_flags = align; };
void mpLayer::SetBrush ( wxBrush  brush)
inlineinherited

Set layer brush.

Parameters
brushbrush, will be copied to internal class member

Definition at line 309 of file mathplot.h.

309 { m_brush = brush; };
wxBrush m_brush
Definition: mathplot.h:315
void mpLayer::SetContinuity ( bool  continuity)
inlineinherited

Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).

See also
GetContinuity

Definition at line 252 of file mathplot.h.

Referenced by TRACE::TRACE().

252 { m_continuous = continuity; }
bool m_continuous
Definition: mathplot.h:317
void mpMovableObject::SetCoordinateBase ( double  x,
double  y,
double  phi = 0 
)
inlineinherited

Set the coordinate transformation (phi in radians, 0 means no rotation).

Definition at line 1712 of file mathplot.h.

References mpALIGN_NE.

1713  {
1714  m_reference_x = x;
1715  m_reference_y = y;
1716  m_reference_phi = phi;
1717  m_flags = mpALIGN_NE;
1718  ShapeUpdated();
1719  }
double m_reference_x
The coordinates of the object (orientation "phi" is in radians).
Definition: mathplot.h:1751
void ShapeUpdated()
Must be called by the descendent class after updating the shape (m_shape_xs/ys), or when the transfor...
Definition: mathplot.cpp:3574
double m_reference_y
Definition: mathplot.h:1751
#define mpALIGN_NE
Aligns label to north-east.
Definition: mathplot.h:504
double m_reference_phi
Definition: mathplot.h:1751
void mpCovarianceEllipse::SetCovarianceMatrix ( double  cov_00,
double  cov_01,
double  cov_11 
)
inline

Changes the covariance matrix:

Definition at line 1844 of file mathplot.h.

1845  {
1846  m_cov_00 = cov_00;
1847  m_cov_01 = cov_01;
1848  m_cov_11 = cov_11;
1849  RecalculateShape();
1850  }
void RecalculateShape()
Called to update the m_shape_xs, m_shape_ys vectors, whenever a parameter changes.
Definition: mathplot.cpp:3727
double m_cov_00
The elements of the matrix (only 3 since cov(0,1)=cov(1,0) in any positive definite matrix)...
Definition: mathplot.h:1855
void mpLayer::SetDrawOutsideMargins ( bool  drawModeOutside)
inlineinherited

Set Draw mode: inside or outside margins.

Default is outside, which allows the layer to draw up to the mpWindow border.

Parameters
drawModeOutsideThe draw mode to be set

Definition at line 280 of file mathplot.h.

Referenced by CURSOR::CURSOR(), and TRACE::TRACE().

280 { m_drawOutsideMargins = drawModeOutside; };
bool m_drawOutsideMargins
Definition: mathplot.h:319
void mpLayer::SetFont ( wxFont &  font)
inlineinherited

Set layer font.

Parameters
fontFont, will be copied to internal class member

Definition at line 271 of file mathplot.h.

271 { m_font = font; }
wxFont m_font
Definition: mathplot.h:309
void mpLayer::SetName ( wxString  name)
inlineinherited

Set layer name.

Parameters
nameName, will be copied to internal class member

Definition at line 266 of file mathplot.h.

References name.

266 { m_name = name; }
const char * name
wxString m_name
Definition: mathplot.h:316
void mpLayer::SetPen ( wxPen  pen)
inlineinherited

Set layer pen.

Parameters
penPen, will be copied to internal class member

Definition at line 276 of file mathplot.h.

Referenced by SIM_PLOT_PANEL::AddTrace().

276 { m_pen = pen; }
wxPen m_pen
Definition: mathplot.h:314
void mpCovarianceEllipse::SetQuantiles ( double  q)
inline

Set how many "quantiles" to draw, that is, the confidence interval of the ellipse (see above).

Definition at line 1824 of file mathplot.h.

1825  {
1826  m_quantiles = q;
1827  RecalculateShape();
1828  }
void RecalculateShape()
Called to update the m_shape_xs, m_shape_ys vectors, whenever a parameter changes.
Definition: mathplot.cpp:3727
void mpCovarianceEllipse::SetSegments ( int  segments)
inline

Definition at line 1830 of file mathplot.h.

1830 { m_segments = segments; }
int m_segments
The number of line segments that build up the ellipse.
Definition: mathplot.h:1860
void mpLayer::SetVisible ( bool  show)
inlineinherited

Sets layer visibility.

Parameters
showvisibility bool.

Definition at line 301 of file mathplot.h.

Referenced by mpWindow::SetLayerVisible(), SIM_PLOT_PANEL::ShowLegend(), and SIM_PLOT_PANEL::SIM_PLOT_PANEL().

301 { m_visible = show; };
bool m_visible
Definition: mathplot.h:321
void mpMovableObject::ShapeUpdated ( )
protectedinherited

Must be called by the descendent class after updating the shape (m_shape_xs/ys), or when the transformation changes.

This method updates the buffers m_trans_shape_xs/ys, and the precomputed bounding box.

Definition at line 3574 of file mathplot.cpp.

References mpMovableObject::m_bbox_max_x, mpMovableObject::m_bbox_max_y, mpMovableObject::m_bbox_min_x, mpMovableObject::m_bbox_min_y, mpMovableObject::m_reference_phi, mpMovableObject::m_reference_x, mpMovableObject::m_reference_y, mpMovableObject::m_shape_xs, mpMovableObject::m_shape_ys, mpMovableObject::m_trans_shape_xs, and mpMovableObject::m_trans_shape_ys.

Referenced by RecalculateShape(), and mpPolygon::setPoints().

3575 {
3576  // Just in case...
3577  if( m_shape_xs.size()!=m_shape_ys.size() )
3578  {
3579  wxLogError( wxT(
3580  "[mpMovableObject::ShapeUpdated] Error, m_shape_xs and m_shape_ys have different lengths!" ) );
3581  }
3582  else
3583  {
3584  double ccos = cos( m_reference_phi ); // Avoid computing cos/sin twice.
3585  double csin = sin( m_reference_phi );
3586 
3587  m_trans_shape_xs.resize( m_shape_xs.size() );
3588  m_trans_shape_ys.resize( m_shape_xs.size() );
3589 
3590  std::vector<double>::iterator itXi, itXo;
3591  std::vector<double>::iterator itYi, itYo;
3592 
3593  m_bbox_min_x = 1e300;
3594  m_bbox_max_x = -1e300;
3595  m_bbox_min_y = 1e300;
3596  m_bbox_max_y = -1e300;
3597 
3598  for( itXo = m_trans_shape_xs.begin(),
3599  itYo = m_trans_shape_ys.begin(), itXi = m_shape_xs.begin(), itYi = m_shape_ys.begin();
3600  itXo!=m_trans_shape_xs.end(); itXo++, itYo++, itXi++, itYi++ )
3601  {
3602  *itXo = m_reference_x + ccos * (*itXi) - csin * (*itYi);
3603  *itYo = m_reference_y + csin * (*itXi) + ccos * (*itYi);
3604 
3605  // Keep BBox:
3606  if( *itXo < m_bbox_min_x )
3607  m_bbox_min_x = *itXo;
3608 
3609  if( *itXo > m_bbox_max_x )
3610  m_bbox_max_x = *itXo;
3611 
3612  if( *itYo < m_bbox_min_y )
3613  m_bbox_min_y = *itYo;
3614 
3615  if( *itYo > m_bbox_max_y )
3616  m_bbox_max_y = *itYo;
3617  }
3618  }
3619 }
std::vector< double > m_trans_shape_ys
Definition: mathplot.h:1766
double m_reference_x
The coordinates of the object (orientation "phi" is in radians).
Definition: mathplot.h:1751
double m_bbox_max_y
Definition: mathplot.h:1771
double m_bbox_min_x
The precomputed bounding box:
Definition: mathplot.h:1771
double m_reference_y
Definition: mathplot.h:1751
std::vector< double > m_shape_ys
Definition: mathplot.h:1761
std::vector< double > m_trans_shape_xs
The buffer for the translated & rotated points (to avoid recomputing them with each mpWindow refresh)...
Definition: mathplot.h:1766
double m_reference_phi
Definition: mathplot.h:1751
double m_bbox_max_x
Definition: mathplot.h:1771
std::vector< double > m_shape_xs
This contains the object points, in local coordinates (to be transformed by the current transformatio...
Definition: mathplot.h:1761
double m_bbox_min_y
Definition: mathplot.h:1771
void mpLayer::ShowName ( bool  show)
inlineinherited

Shows or hides the text label with the name of the layer (default is visible).

Definition at line 261 of file mathplot.h.

Referenced by TRACE::TRACE().

261 { m_showName = show; };
bool m_showName
Definition: mathplot.h:318
void mpMovableObject::TranslatePoint ( double  x,
double  y,
double &  out_x,
double &  out_y 
)
protectedinherited

A method for 2D translation and rotation, using the current transformation stored in m_reference_x,m_reference_y,m_reference_phi.

Definition at line 3563 of file mathplot.cpp.

References mpMovableObject::m_reference_phi, mpMovableObject::m_reference_x, and mpMovableObject::m_reference_y.

3564 {
3565  double ccos = cos( m_reference_phi ); // Avoid computing cos/sin twice.
3566  double csin = sin( m_reference_phi );
3567 
3568  out_x = m_reference_x + ccos * x - csin * y;
3569  out_y = m_reference_y + csin * x + ccos * y;
3570 }
double m_reference_x
The coordinates of the object (orientation "phi" is in radians).
Definition: mathplot.h:1751
double m_reference_y
Definition: mathplot.h:1751
double m_reference_phi
Definition: mathplot.h:1751

Member Data Documentation

double mpMovableObject::m_bbox_max_x
protectedinherited

Definition at line 1771 of file mathplot.h.

Referenced by mpMovableObject::Plot(), and mpMovableObject::ShapeUpdated().

double mpMovableObject::m_bbox_max_y
protectedinherited

Definition at line 1771 of file mathplot.h.

Referenced by mpMovableObject::Plot(), and mpMovableObject::ShapeUpdated().

double mpMovableObject::m_bbox_min_x
protectedinherited

The precomputed bounding box:

See also
ShapeUpdated

Definition at line 1771 of file mathplot.h.

Referenced by mpMovableObject::ShapeUpdated().

double mpMovableObject::m_bbox_min_y
protectedinherited

Definition at line 1771 of file mathplot.h.

Referenced by mpMovableObject::ShapeUpdated().

wxBrush mpLayer::m_brush
protectedinherited

Definition at line 315 of file mathplot.h.

bool mpLayer::m_continuous
protectedinherited

Definition at line 317 of file mathplot.h.

Referenced by CURSOR::Plot(), mpFXY::Plot(), and mpMovableObject::Plot().

double mpCovarianceEllipse::m_cov_00
protected

The elements of the matrix (only 3 since cov(0,1)=cov(1,0) in any positive definite matrix).

Definition at line 1855 of file mathplot.h.

Referenced by RecalculateShape().

double mpCovarianceEllipse::m_cov_01
protected

Definition at line 1855 of file mathplot.h.

Referenced by RecalculateShape().

double mpCovarianceEllipse::m_cov_11
protected

Definition at line 1855 of file mathplot.h.

Referenced by RecalculateShape().

int mpMovableObject::m_flags
protectedinherited

Definition at line 1744 of file mathplot.h.

Referenced by mpMovableObject::Plot().

wxString mpLayer::m_name
protectedinherited
double mpCovarianceEllipse::m_quantiles
protected

Definition at line 1856 of file mathplot.h.

Referenced by RecalculateShape().

double mpMovableObject::m_reference_phi
protectedinherited

Definition at line 1751 of file mathplot.h.

Referenced by mpMovableObject::ShapeUpdated(), and mpMovableObject::TranslatePoint().

double mpMovableObject::m_reference_x
protectedinherited

The coordinates of the object (orientation "phi" is in radians).

Definition at line 1751 of file mathplot.h.

Referenced by mpMovableObject::ShapeUpdated(), and mpMovableObject::TranslatePoint().

double mpMovableObject::m_reference_y
protectedinherited

Definition at line 1751 of file mathplot.h.

Referenced by mpMovableObject::ShapeUpdated(), and mpMovableObject::TranslatePoint().

int mpCovarianceEllipse::m_segments
protected

The number of line segments that build up the ellipse.

Definition at line 1860 of file mathplot.h.

Referenced by RecalculateShape().

std::vector<double> mpMovableObject::m_shape_xs
protectedinherited

This contains the object points, in local coordinates (to be transformed by the current transformation).

Definition at line 1761 of file mathplot.h.

Referenced by RecalculateShape(), mpPolygon::setPoints(), and mpMovableObject::ShapeUpdated().

std::vector<double> mpMovableObject::m_shape_ys
protectedinherited
bool mpLayer::m_showName
protectedinherited
std::vector<double> mpMovableObject::m_trans_shape_xs
protectedinherited

The buffer for the translated & rotated points (to avoid recomputing them with each mpWindow refresh).

Definition at line 1766 of file mathplot.h.

Referenced by mpMovableObject::Plot(), and mpMovableObject::ShapeUpdated().

std::vector<double> mpMovableObject::m_trans_shape_ys
protectedinherited

Definition at line 1766 of file mathplot.h.

Referenced by mpMovableObject::Plot(), and mpMovableObject::ShapeUpdated().

mpLayerType mpLayer::m_type
protectedinherited

Definition at line 320 of file mathplot.h.

Referenced by mpInfoLayer::mpInfoLayer().


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