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 1834 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpCovarianceEllipse()

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 1841 of file mathplot.h.

1846  :
1847  m_cov_00( cov_00 ),
1848  m_cov_11( cov_11 ),
1849  m_cov_01( cov_01 ),
1850  m_quantiles( quantiles ),
1851  m_segments( segments )
1852  {
1853  m_continuous = true;
1854  m_name = layerName;
1855  RecalculateShape();
1856  m_type = mpLAYER_PLOT;
1857  }
bool m_continuous
Definition: mathplot.h:319
void RecalculateShape()
Called to update the m_shape_xs, m_shape_ys vectors, whenever a parameter changes.
Definition: mathplot.cpp:3741
int m_segments
The number of line segments that build up the ellipse.
Definition: mathplot.h:1901
mpLayerType m_type
Definition: mathplot.h:322
wxString m_name
Definition: mathplot.h:318
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:1896

References mpLAYER_PLOT.

◆ ~mpCovarianceEllipse()

virtual mpCovarianceEllipse::~mpCovarianceEllipse ( )
inlinevirtual

Definition at line 1859 of file mathplot.h.

1859 {}

Member Function Documentation

◆ GetBrush()

const wxBrush& mpLayer::GetBrush ( ) const
inlineinherited

Get brush set for this layer.

Returns
brush.

Definition at line 307 of file mathplot.h.

307 { return m_brush; };
wxBrush m_brush
Definition: mathplot.h:317

◆ GetColourSquare()

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 83 of file mathplot.cpp.

84 {
85  wxBitmap square( side, side, -1 );
86  wxColour filler = m_pen.GetColour();
87  wxBrush brush( filler, wxBRUSHSTYLE_SOLID );
88  wxMemoryDC dc;
89 
90  dc.SelectObject( square );
91  dc.SetBackground( brush );
92  dc.Clear();
93  dc.SelectObject( wxNullBitmap );
94  return square;
95 }
double square(double x)
wxPen m_pen
Definition: mathplot.h:316

References mpLayer::m_pen, and square().

◆ GetContinuity()

bool mpLayer::GetContinuity ( ) const
inlineinherited

Gets the 'continuity' property of the layer.

See also
SetContinuity

Definition at line 259 of file mathplot.h.

259 { return m_continuous; }
bool m_continuous
Definition: mathplot.h:319

◆ GetCoordinateBase()

void mpMovableObject::GetCoordinateBase ( double &  x,
double &  y,
double &  phi 
) const
inlineinherited

Get the current coordinate transformation.

Definition at line 1743 of file mathplot.h.

1744  {
1745  x = m_reference_x;
1746  y = m_reference_y;
1747  phi = m_reference_phi;
1748  }
double m_reference_x
The coordinates of the object (orientation "phi" is in radians).
Definition: mathplot.h:1791
double m_reference_y
Definition: mathplot.h:1791
double m_reference_phi
Definition: mathplot.h:1791

◆ GetCovarianceMatrix()

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 1876 of file mathplot.h.

1877  {
1878  cov_00 = m_cov_00;
1879  cov_01 = m_cov_01;
1880  cov_11 = m_cov_11;
1881  }
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:1896

◆ GetDrawOutsideMargins()

bool mpLayer::GetDrawOutsideMargins ( )
inlineinherited

Get Draw mode: inside or outside margins.

Returns
The draw mode

Definition at line 286 of file mathplot.h.

286 { return m_drawOutsideMargins; };
bool m_drawOutsideMargins
Definition: mathplot.h:321

◆ GetFont()

const wxFont& mpLayer::GetFont ( ) const
inlineinherited

Get font set for this layer.

Returns
Font

Definition at line 244 of file mathplot.h.

244 { return m_font; }
wxFont m_font
Definition: mathplot.h:311

◆ GetLayerType()

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 295 of file mathplot.h.

295 { return m_type; };
mpLayerType m_type
Definition: mathplot.h:322

Referenced by mpInfoLegend::Plot().

◆ GetMaxX()

virtual double mpMovableObject::GetMaxX ( )
inlineoverridevirtualinherited

Get inclusive right border of bounding box.

Reimplemented from mpLayer.

Definition at line 1769 of file mathplot.h.

1769 { return m_bbox_max_x; }
double m_bbox_max_x
Definition: mathplot.h:1811

◆ GetMaxY()

virtual double mpMovableObject::GetMaxY ( )
inlineoverridevirtualinherited

Get inclusive top border of bounding box.

Reimplemented from mpLayer.

Definition at line 1777 of file mathplot.h.

1777 { return m_bbox_max_y; }
double m_bbox_max_y
Definition: mathplot.h:1811

◆ GetMinX()

virtual double mpMovableObject::GetMinX ( )
inlineoverridevirtualinherited

Get inclusive left border of bounding box.

Reimplemented from mpLayer.

Definition at line 1765 of file mathplot.h.

1765 { return m_bbox_min_x; }
double m_bbox_min_x
The precomputed bounding box:
Definition: mathplot.h:1811

◆ GetMinY()

virtual double mpMovableObject::GetMinY ( )
inlineoverridevirtualinherited

Get inclusive bottom border of bounding box.

Reimplemented from mpLayer.

Definition at line 1773 of file mathplot.h.

1773 { return m_bbox_min_y; }
double m_bbox_min_y
Definition: mathplot.h:1811

◆ GetName()

const wxString& mpLayer::GetName ( void  ) const
inlineinherited

Get layer name.

Returns
Name

Definition at line 239 of file mathplot.h.

239 { return m_name; }
wxString m_name
Definition: mathplot.h:318

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

◆ GetPen()

const wxPen& mpLayer::GetPen ( ) const
inlineinherited

Get pen set for this layer.

Returns
Pen

Definition at line 249 of file mathplot.h.

249 { return m_pen; }
wxPen m_pen
Definition: mathplot.h:316

Referenced by mpInfoLegend::Plot().

◆ GetQuantiles()

double mpCovarianceEllipse::GetQuantiles ( ) const
inline

Definition at line 1861 of file mathplot.h.

1861 { return m_quantiles; }

◆ GetSegments()

int mpCovarianceEllipse::GetSegments ( ) const
inline

Definition at line 1872 of file mathplot.h.

1872 { return m_segments; }
int m_segments
The number of line segments that build up the ellipse.
Definition: mathplot.h:1901

◆ HasBBox()

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 1761 of file mathplot.h.

1761 { 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:1806

Referenced by mpMovableObject::Plot().

◆ IsInfo()

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 171 of file mathplot.h.

171 { return false; };

◆ IsVisible()

bool mpLayer::IsVisible ( )
inlineinherited

Checks whether the layer is visible or not.

Returns
true if visible

Definition at line 299 of file mathplot.h.

299 { return m_visible; };
bool m_visible
Definition: mathplot.h:323

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

◆ Plot()

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 3636 of file mathplot.cpp.

3637 {
3638  if( m_visible )
3639  {
3640  dc.SetPen( m_pen );
3641 
3642 
3643  std::vector<double>::iterator itX = m_trans_shape_xs.begin();
3644  std::vector<double>::iterator itY = m_trans_shape_ys.begin();
3645 
3646  if( !m_continuous )
3647  {
3648  // for some reason DrawPoint does not use the current pen,
3649  // so we use DrawLine for fat pens
3650  if( m_pen.GetWidth() <= 1 )
3651  {
3652  while( itX!=m_trans_shape_xs.end() )
3653  {
3654  dc.DrawPoint( w.x2p( *(itX++) ), w.y2p( *(itY++) ) );
3655  }
3656  }
3657  else
3658  {
3659  while( itX!=m_trans_shape_xs.end() )
3660  {
3661  wxCoord cx = w.x2p( *(itX++) );
3662  wxCoord cy = w.y2p( *(itY++) );
3663  dc.DrawLine( cx, cy, cx, cy );
3664  }
3665  }
3666  }
3667  else
3668  {
3669  wxCoord cx0 = 0, cy0 = 0;
3670  bool first = true;
3671 
3672  while( itX!=m_trans_shape_xs.end() )
3673  {
3674  wxCoord cx = w.x2p( *(itX++) );
3675  wxCoord cy = w.y2p( *(itY++) );
3676 
3677  if( first )
3678  {
3679  first = false;
3680  cx0 = cx; cy0 = cy;
3681  }
3682 
3683  dc.DrawLine( cx0, cy0, cx, cy );
3684  cx0 = cx; cy0 = cy;
3685  }
3686  }
3687 
3688  if( !m_name.IsEmpty() && m_showName )
3689  {
3690  dc.SetFont( m_font );
3691 
3692  wxCoord tx, ty;
3693  dc.GetTextExtent( m_name, &tx, &ty );
3694 
3695  if( HasBBox() )
3696  {
3697  wxCoord sx = (wxCoord) ( ( m_bbox_max_x - w.GetPosX() ) * w.GetScaleX() );
3698  wxCoord sy = (wxCoord) ( (w.GetPosY() - m_bbox_max_y ) * w.GetScaleY() );
3699 
3700  tx = sx - tx - 8;
3701  ty = sy - 8 - ty;
3702  }
3703  else
3704  {
3705  const int sx = w.GetScrX() >> 1;
3706  const int sy = w.GetScrY() >> 1;
3707 
3708  if( (m_flags & mpALIGNMASK) == mpALIGN_NE )
3709  {
3710  tx = sx - tx - 8;
3711  ty = -sy + 8;
3712  }
3713  else if( (m_flags & mpALIGNMASK) == mpALIGN_NW )
3714  {
3715  tx = -sx + 8;
3716  ty = -sy + 8;
3717  }
3718  else if( (m_flags & mpALIGNMASK) == mpALIGN_SW )
3719  {
3720  tx = -sx + 8;
3721  ty = sy - 8 - ty;
3722  }
3723  else
3724  {
3725  tx = sx - tx - 8;
3726  ty = sy - 8 - ty;
3727  }
3728  }
3729 
3730  dc.DrawText( m_name, tx, ty );
3731  }
3732  }
3733 }
bool m_continuous
Definition: mathplot.h:319
#define mpALIGN_NW
Aligns label to north-west.
Definition: mathplot.h:508
double GetPosY(void) const
Definition: mathplot.h:1127
double GetScaleX(void) const
Definition: mathplot.h:1106
std::vector< double > m_trans_shape_ys
Definition: mathplot.h:1806
double GetScaleY(void) const
Definition: mathplot.h:1113
double GetPosX(void) const
Definition: mathplot.h:1120
bool m_visible
Definition: mathplot.h:323
double m_bbox_max_y
Definition: mathplot.h:1811
wxCoord y2p(double y)
Converts graph (floating point) coordinates into mpWindow (screen) pixel coordinates,...
Definition: mathplot.h:1204
virtual bool HasBBox() override
Check whether this layer has a bounding box.
Definition: mathplot.h:1761
int GetScrX(void) const
Get current view's X dimension in device context units.
Definition: mathplot.h:1135
wxFont m_font
Definition: mathplot.h:311
#define mpALIGN_NE
Aligns label to north-east.
Definition: mathplot.h:506
#define mpALIGNMASK
Definition: mathplot.h:476
bool m_showName
Definition: mathplot.h:320
wxCoord x2p(double x)
Converts graph (floating point) coordinates into mpWindow (screen) pixel coordinates,...
Definition: mathplot.h:1199
wxPen m_pen
Definition: mathplot.h:316
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:1806
wxString m_name
Definition: mathplot.h:318
double m_bbox_max_x
Definition: mathplot.h:1811
int GetScrY(void) const
Get current view's Y dimension in device context units.
Definition: mathplot.h:1144
#define mpALIGN_SW
Aligns label to south-west.
Definition: mathplot.h:510

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().

◆ RecalculateShape()

void mpCovarianceEllipse::RecalculateShape ( )
protected

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

Definition at line 3741 of file mathplot.cpp.

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

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

◆ SetAlign()

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 1784 of file mathplot.h.

1784 { m_flags = align; };

◆ SetBrush()

void mpLayer::SetBrush ( wxBrush  brush)
inlineinherited

Set layer brush.

Parameters
brushbrush, will be copied to internal class member

Definition at line 311 of file mathplot.h.

311 { m_brush = brush; };
wxBrush m_brush
Definition: mathplot.h:317

◆ SetContinuity()

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 254 of file mathplot.h.

254 { m_continuous = continuity; }
bool m_continuous
Definition: mathplot.h:319

Referenced by TRACE::TRACE().

◆ SetCoordinateBase()

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 1752 of file mathplot.h.

1753  {
1754  m_reference_x = x;
1755  m_reference_y = y;
1756  m_reference_phi = phi;
1757  m_flags = mpALIGN_NE;
1758  ShapeUpdated();
1759  }
double m_reference_x
The coordinates of the object (orientation "phi" is in radians).
Definition: mathplot.h:1791
void ShapeUpdated()
Must be called by the descendent class after updating the shape (m_shape_xs/ys), or when the transfor...
Definition: mathplot.cpp:3588
double m_reference_y
Definition: mathplot.h:1791
#define mpALIGN_NE
Aligns label to north-east.
Definition: mathplot.h:506
double m_reference_phi
Definition: mathplot.h:1791

References mpALIGN_NE.

◆ SetCovarianceMatrix()

void mpCovarianceEllipse::SetCovarianceMatrix ( double  cov_00,
double  cov_01,
double  cov_11 
)
inline

Changes the covariance matrix:

Definition at line 1885 of file mathplot.h.

1886  {
1887  m_cov_00 = cov_00;
1888  m_cov_01 = cov_01;
1889  m_cov_11 = cov_11;
1890  RecalculateShape();
1891  }
void RecalculateShape()
Called to update the m_shape_xs, m_shape_ys vectors, whenever a parameter changes.
Definition: mathplot.cpp:3741
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:1896

◆ SetDrawOutsideMargins()

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 282 of file mathplot.h.

282 { m_drawOutsideMargins = drawModeOutside; };
bool m_drawOutsideMargins
Definition: mathplot.h:321

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

◆ SetFont()

void mpLayer::SetFont ( wxFont &  font)
inlineinherited

Set layer font.

Parameters
fontFont, will be copied to internal class member

Definition at line 273 of file mathplot.h.

273 { m_font = font; }
wxFont m_font
Definition: mathplot.h:311

◆ SetName()

void mpLayer::SetName ( wxString  name)
inlineinherited

Set layer name.

Parameters
nameName, will be copied to internal class member

Definition at line 268 of file mathplot.h.

268 { m_name = name; }
const char * name
Definition: DXF_plotter.cpp:60
wxString m_name
Definition: mathplot.h:318

References name.

◆ SetPen()

void mpLayer::SetPen ( wxPen  pen)
inlineinherited

Set layer pen.

Parameters
penPen, will be copied to internal class member

Definition at line 278 of file mathplot.h.

278 { m_pen = pen; }
wxPen m_pen
Definition: mathplot.h:316

Referenced by SIM_PLOT_PANEL::UpdateTraceStyle().

◆ SetQuantiles()

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 1865 of file mathplot.h.

1866  {
1867  m_quantiles = q;
1868  RecalculateShape();
1869  }
void RecalculateShape()
Called to update the m_shape_xs, m_shape_ys vectors, whenever a parameter changes.
Definition: mathplot.cpp:3741

◆ SetSegments()

void mpCovarianceEllipse::SetSegments ( int  segments)
inline

Definition at line 1871 of file mathplot.h.

1871 { m_segments = segments; }
int m_segments
The number of line segments that build up the ellipse.
Definition: mathplot.h:1901

◆ SetVisible()

void mpLayer::SetVisible ( bool  show)
inlineinherited

Sets layer visibility.

Parameters
showvisibility bool.

Definition at line 303 of file mathplot.h.

303 { m_visible = show; };
bool m_visible
Definition: mathplot.h:323

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

◆ ShapeUpdated()

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 3588 of file mathplot.cpp.

3589 {
3590  // Just in case...
3591  if( m_shape_xs.size()!=m_shape_ys.size() )
3592  {
3593  wxLogError( wxT(
3594  "[mpMovableObject::ShapeUpdated] Error, m_shape_xs and m_shape_ys have different lengths!" ) );
3595  }
3596  else
3597  {
3598  double ccos = cos( m_reference_phi ); // Avoid computing cos/sin twice.
3599  double csin = sin( m_reference_phi );
3600 
3601  m_trans_shape_xs.resize( m_shape_xs.size() );
3602  m_trans_shape_ys.resize( m_shape_xs.size() );
3603 
3604  std::vector<double>::iterator itXi, itXo;
3605  std::vector<double>::iterator itYi, itYo;
3606 
3607  m_bbox_min_x = 1e300;
3608  m_bbox_max_x = -1e300;
3609  m_bbox_min_y = 1e300;
3610  m_bbox_max_y = -1e300;
3611 
3612  for( itXo = m_trans_shape_xs.begin(),
3613  itYo = m_trans_shape_ys.begin(), itXi = m_shape_xs.begin(), itYi = m_shape_ys.begin();
3614  itXo!=m_trans_shape_xs.end(); itXo++, itYo++, itXi++, itYi++ )
3615  {
3616  *itXo = m_reference_x + ccos * (*itXi) - csin * (*itYi);
3617  *itYo = m_reference_y + csin * (*itXi) + ccos * (*itYi);
3618 
3619  // Keep BBox:
3620  if( *itXo < m_bbox_min_x )
3621  m_bbox_min_x = *itXo;
3622 
3623  if( *itXo > m_bbox_max_x )
3624  m_bbox_max_x = *itXo;
3625 
3626  if( *itYo < m_bbox_min_y )
3627  m_bbox_min_y = *itYo;
3628 
3629  if( *itYo > m_bbox_max_y )
3630  m_bbox_max_y = *itYo;
3631  }
3632  }
3633 }
std::vector< double > m_trans_shape_ys
Definition: mathplot.h:1806
double m_reference_x
The coordinates of the object (orientation "phi" is in radians).
Definition: mathplot.h:1791
double m_bbox_max_y
Definition: mathplot.h:1811
double m_bbox_min_x
The precomputed bounding box:
Definition: mathplot.h:1811
double m_reference_y
Definition: mathplot.h:1791
std::vector< double > m_shape_ys
Definition: mathplot.h:1801
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:1806
double m_reference_phi
Definition: mathplot.h:1791
double m_bbox_max_x
Definition: mathplot.h:1811
std::vector< double > m_shape_xs
This contains the object points, in local coordinates (to be transformed by the current transformatio...
Definition: mathplot.h:1801
double m_bbox_min_y
Definition: mathplot.h:1811

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().

◆ ShowName()

void mpLayer::ShowName ( bool  show)
inlineinherited

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

Definition at line 263 of file mathplot.h.

263 { m_showName = show; };
bool m_showName
Definition: mathplot.h:320

Referenced by TRACE::TRACE().

◆ TranslatePoint()

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 3577 of file mathplot.cpp.

3578 {
3579  double ccos = cos( m_reference_phi ); // Avoid computing cos/sin twice.
3580  double csin = sin( m_reference_phi );
3581 
3582  out_x = m_reference_x + ccos * x - csin * y;
3583  out_y = m_reference_y + csin * x + ccos * y;
3584 }
double m_reference_x
The coordinates of the object (orientation "phi" is in radians).
Definition: mathplot.h:1791
double m_reference_y
Definition: mathplot.h:1791
double m_reference_phi
Definition: mathplot.h:1791

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

Member Data Documentation

◆ m_bbox_max_x

double mpMovableObject::m_bbox_max_x
protectedinherited

Definition at line 1811 of file mathplot.h.

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

◆ m_bbox_max_y

double mpMovableObject::m_bbox_max_y
protectedinherited

Definition at line 1811 of file mathplot.h.

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

◆ m_bbox_min_x

double mpMovableObject::m_bbox_min_x
protectedinherited

The precomputed bounding box:

See also
ShapeUpdated

Definition at line 1811 of file mathplot.h.

Referenced by mpMovableObject::ShapeUpdated().

◆ m_bbox_min_y

double mpMovableObject::m_bbox_min_y
protectedinherited

Definition at line 1811 of file mathplot.h.

Referenced by mpMovableObject::ShapeUpdated().

◆ m_brush

wxBrush mpLayer::m_brush
protectedinherited

Definition at line 317 of file mathplot.h.

◆ m_continuous

bool mpLayer::m_continuous
protectedinherited

Definition at line 319 of file mathplot.h.

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

◆ m_cov_00

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 1896 of file mathplot.h.

Referenced by RecalculateShape().

◆ m_cov_01

double mpCovarianceEllipse::m_cov_01
protected

Definition at line 1896 of file mathplot.h.

Referenced by RecalculateShape().

◆ m_cov_11

double mpCovarianceEllipse::m_cov_11
protected

Definition at line 1896 of file mathplot.h.

Referenced by RecalculateShape().

◆ m_drawOutsideMargins

◆ m_flags

int mpMovableObject::m_flags
protectedinherited

Definition at line 1784 of file mathplot.h.

Referenced by mpMovableObject::Plot().

◆ m_font

◆ m_name

wxString mpLayer::m_name
protectedinherited

◆ m_pen

◆ m_quantiles

double mpCovarianceEllipse::m_quantiles
protected

Definition at line 1897 of file mathplot.h.

Referenced by RecalculateShape().

◆ m_reference_phi

double mpMovableObject::m_reference_phi
protectedinherited

Definition at line 1791 of file mathplot.h.

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

◆ m_reference_x

double mpMovableObject::m_reference_x
protectedinherited

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

Definition at line 1791 of file mathplot.h.

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

◆ m_reference_y

double mpMovableObject::m_reference_y
protectedinherited

Definition at line 1791 of file mathplot.h.

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

◆ m_segments

int mpCovarianceEllipse::m_segments
protected

The number of line segments that build up the ellipse.

Definition at line 1901 of file mathplot.h.

Referenced by RecalculateShape().

◆ m_shape_xs

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 1801 of file mathplot.h.

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

◆ m_shape_ys

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

◆ m_showName

bool mpLayer::m_showName
protectedinherited

◆ m_trans_shape_xs

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 1806 of file mathplot.h.

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

◆ m_trans_shape_ys

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

Definition at line 1806 of file mathplot.h.

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

◆ m_type

mpLayerType mpLayer::m_type
protectedinherited

Definition at line 322 of file mathplot.h.

Referenced by mpInfoLayer::mpInfoLayer().

◆ m_visible


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