mpCovarianceEllipse Class Reference

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

#include <mathplot.h>

Inheritance diagram for mpCovarianceEllipse:

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 () const override
	Check whether this layer has a bounding box. More...
virtual double	GetMinX () const override
	Get inclusive left border of bounding box. More...
virtual double	GetMaxX () const override
	Get inclusive right border of bounding box. More...
virtual double	GetMinY () const override
	Get inclusive bottom border of bounding box. More...
virtual double	GetMaxY () const 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 () const
	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) const
	Get a small square bitmap filled with the colour of the pen used in the layer. More...
mpLayerType	GetLayerType () const
	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 () const
	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:

• 1 : 68.27% confidence interval
• 2 : 95.45%
• 3 : 99.73%
• 4 : 99.994% For example, see http://en.wikipedia.org/wiki/Normal_distribution#Standard_deviation_and_confidence_intervals

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

Definition at line 1842 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 1849 of file mathplot.h.

 :
 m_cov_00( cov_00 ),
 m_cov_11( cov_11 ),
 m_cov_01( cov_01 ),
 m_quantiles( quantiles ),
 m_segments( segments )
 {
 m_continuous = true;
 m_name = layerName;
 RecalculateShape();
 m_type = mpLAYER_PLOT;
 }

References mpLAYER_PLOT.

~mpCovarianceEllipse()

virtual mpCovarianceEllipse::~mpCovarianceEllipse ( )

inlinevirtual

Definition at line 1867 of file mathplot.h.

{}

Member Function Documentation

GetBrush()

const wxBrush & mpLayer::GetBrush ( ) const

inlineinherited

Get brush set for this layer.

Returns

brush.

Definition at line 306 of file mathplot.h.

{ return m_brush; };

GetColourSquare()

wxBitmap mpLayer::GetColourSquare ( int  side = 16 ) const

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

side	side length in pixels

Returns

a wxBitmap filled with layer's colour

Definition at line 75 of file mathplot.cpp.

{
 wxBitmap square( side, side, -1 );
 wxColour filler = m_pen.GetColour();
 wxBrush brush( filler, wxBRUSHSTYLE_SOLID );
 wxMemoryDC dc;
 
 dc.SelectObject( square );
 dc.SetBackground( brush );
 dc.Clear();
 dc.SelectObject( wxNullBitmap );
 return square;
}

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

{ return m_continuous; }

GetCoordinateBase()

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

inlineinherited

Get the current coordinate transformation.

Definition at line 1751 of file mathplot.h.

 {
 x = m_reference_x;
 y = m_reference_y;
 phi = m_reference_phi;
 }

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

 {
 cov_00 = m_cov_00;
 cov_01 = m_cov_01;
 cov_11 = m_cov_11;
 }

GetDrawOutsideMargins()

bool mpLayer::GetDrawOutsideMargins ( )

inlineinherited

Get Draw mode: inside or outside margins.

Returns

The draw mode

Definition at line 285 of file mathplot.h.

{ return m_drawOutsideMargins; };

GetFont()

const wxFont & mpLayer::GetFont ( ) const

inlineinherited

Get font set for this layer.

Returns

Font

Definition at line 243 of file mathplot.h.

{ return m_font; }

GetLayerType()

mpLayerType mpLayer::GetLayerType ( ) const

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

{ return m_type; };

Referenced by mpInfoLegend::Plot().

GetMaxX()

virtual double mpMovableObject::GetMaxX ( ) const

inlineoverridevirtualinherited

Get inclusive right border of bounding box.

Reimplemented from mpLayer.

Definition at line 1777 of file mathplot.h.

{ return m_bbox_max_x; }

GetMaxY()

virtual double mpMovableObject::GetMaxY ( ) const

inlineoverridevirtualinherited

Get inclusive top border of bounding box.

Reimplemented from mpLayer.

Definition at line 1785 of file mathplot.h.

{ return m_bbox_max_y; }

GetMinX()

virtual double mpMovableObject::GetMinX ( ) const

inlineoverridevirtualinherited

Get inclusive left border of bounding box.

Reimplemented from mpLayer.

Definition at line 1773 of file mathplot.h.

{ return m_bbox_min_x; }

GetMinY()

virtual double mpMovableObject::GetMinY ( ) const

inlineoverridevirtualinherited

Get inclusive bottom border of bounding box.

Reimplemented from mpLayer.

Definition at line 1781 of file mathplot.h.

{ return m_bbox_min_y; }

GetName()

const wxString & mpLayer::GetName ( void  ) const

inlineinherited

Get layer name.

Returns

Name

Definition at line 238 of file mathplot.h.

{ return m_name; }

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

{ return m_pen; }

Referenced by CURSOR::Plot(), and mpInfoLegend::Plot().

GetQuantiles()

double mpCovarianceEllipse::GetQuantiles ( ) const

inline

Definition at line 1869 of file mathplot.h.

{ return m_quantiles; }

GetSegments()

int mpCovarianceEllipse::GetSegments ( ) const

inline

Definition at line 1880 of file mathplot.h.

{ return m_segments; }

HasBBox()

virtual bool mpMovableObject::HasBBox ( ) const

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

true	Has bounding box
false	Has not bounding box

Reimplemented from mpLayer.

Definition at line 1769 of file mathplot.h.

{ return m_trans_shape_xs.size()!=0; }

Referenced by mpMovableObject::Plot().

IsInfo()

virtual bool mpLayer::IsInfo ( ) const

inlinevirtualinherited

Check whether the layer is an info box.

The default implementation returns false. It is overridden 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 170 of file mathplot.h.

{ return false; };

IsVisible()

bool mpLayer::IsVisible ( ) const

inlineinherited

Checks whether the layer is visible or not.

Returns

true if visible

Definition at line 298 of file mathplot.h.

{ return m_visible; };

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

dc	Device context to plot to.
w	View 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 3157 of file mathplot.cpp.

{
 if( m_visible )
 {
 dc.SetPen( m_pen );
 
 
 std::vector<double>::iterator itX = m_trans_shape_xs.begin();
 std::vector<double>::iterator itY = m_trans_shape_ys.begin();
 
 if( !m_continuous )
 {
 // for some reason DrawPoint does not use the current pen,
 // so we use DrawLine for fat pens
 if( m_pen.GetWidth() <= 1 )
 {
 while( itX!=m_trans_shape_xs.end() )
 {
 dc.DrawPoint( w.x2p( *(itX++) ), w.y2p( *(itY++) ) );
 }
 }
 else
 {
 while( itX!=m_trans_shape_xs.end() )
 {
 wxCoord cx = w.x2p( *(itX++) );
 wxCoord cy = w.y2p( *(itY++) );
 dc.DrawLine( cx, cy, cx, cy );
 }
 }
 }
 else
 {
 wxCoord cx0 = 0, cy0 = 0;
 bool first = true;
 
 while( itX != m_trans_shape_xs.end() )
 {
 wxCoord cx = w.x2p( *(itX++) );
 wxCoord cy = w.y2p( *(itY++) );
 
 if( first )
 {
 first = false;
 cx0 = cx; cy0 = cy;
 }
 
 dc.DrawLine( cx0, cy0, cx, cy );
 cx0 = cx; cy0 = cy;
 }
 }
 
 if( !m_name.IsEmpty() && m_showName )
 {
 dc.SetFont( m_font );
 
 wxCoord tx, ty;
 dc.GetTextExtent( m_name, &tx, &ty );
 
 if( HasBBox() )
 {
 wxCoord sx = (wxCoord) ( ( m_bbox_max_x - w.GetPosX() ) * w.GetScaleX() );
 wxCoord sy = (wxCoord) ( (w.GetPosY() - m_bbox_max_y ) * w.GetScaleY() );
 
 tx = sx - tx - 8;
 ty = sy - 8 - ty;
 }
 else
 {
 const int sx = w.GetScrX() >> 1;
 const int sy = w.GetScrY() >> 1;
 
 if( (m_flags & mpALIGNMASK) == mpALIGN_NE )
 {
 tx = sx - tx - 8;
 ty = -sy + 8;
 }
 else if( (m_flags & mpALIGNMASK) == mpALIGN_NW )
 {
 tx = -sx + 8;
 ty = -sy + 8;
 }
 else if( (m_flags & mpALIGNMASK) == mpALIGN_SW )
 {
 tx = -sx + 8;
 ty = sy - 8 - ty;
 }
 else
 {
 tx = sx - tx - 8;
 ty = sy - 8 - ty;
 }
 }
 
 dc.DrawText( m_name, tx, ty );
 }
 }
}

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

{
 m_shape_xs.clear();
 m_shape_ys.clear();
 
 // Preliminary checks:
 if( m_quantiles < 0 )
 return;
 
 if( m_cov_00 < 0 )
 return;
 
 if( m_cov_11 < 0 )
 return;
 
 m_shape_xs.resize( m_segments, 0 );
 m_shape_ys.resize( m_segments, 0 );
 
 // Compute the two eigenvalues of the covariance:
 // -------------------------------------------------
 double b = -m_cov_00 - m_cov_11;
 double c = m_cov_00 * m_cov_11 - m_cov_01 * m_cov_01;
 
 double D = b * b - 4 * c;
 
 if( D < 0 )
 return;
 
 double eigenVal0 = 0.5 * ( -b + sqrt( D ) );
 double eigenVal1 = 0.5 * ( -b - sqrt( D ) );
 
 // Compute the two corresponding eigenvectors:
 // -------------------------------------------------
 double eigenVec0_x, eigenVec0_y;
 double eigenVec1_x, eigenVec1_y;
 
 if( fabs( eigenVal0 - m_cov_00 ) > 1e-6 )
 {
 double k1x = m_cov_01 / ( eigenVal0 - m_cov_00 );
 eigenVec0_y = 1;
 eigenVec0_x = eigenVec0_y * k1x;
 }
 else
 {
 double k1y = m_cov_01 / ( eigenVal0 - m_cov_11 );
 eigenVec0_x = 1;
 eigenVec0_y = eigenVec0_x * k1y;
 }
 
 if( fabs( eigenVal1 - m_cov_00 ) > 1e-6 )
 {
 double k2x = m_cov_01 / ( eigenVal1 - m_cov_00 );
 eigenVec1_y = 1;
 eigenVec1_x = eigenVec1_y * k2x;
 }
 else
 {
 double k2y = m_cov_01 / ( eigenVal1 - m_cov_11 );
 eigenVec1_x = 1;
 eigenVec1_y = eigenVec1_x * k2y;
 }
 
 // Normalize the eigenvectors:
 double len = sqrt( eigenVec0_x * eigenVec0_x + eigenVec0_y * eigenVec0_y );
 eigenVec0_x /= len; // It *CANNOT* be zero
 eigenVec0_y /= len;
 
 len = sqrt( eigenVec1_x * eigenVec1_x + eigenVec1_y * eigenVec1_y );
 eigenVec1_x /= len; // It *CANNOT* be zero
 eigenVec1_y /= len;
 
 
 // Take the sqrt of the eigenvalues (required for the ellipse scale):
 eigenVal0 = sqrt( eigenVal0 );
 eigenVal1 = sqrt( eigenVal1 );
 
 // Compute the 2x2 matrix M = diag(eigVal) * (~eigVec) (each eigen vector is a row):
 double M_00 = eigenVec0_x * eigenVal0;
 double M_01 = eigenVec0_y * eigenVal0;
 
 double M_10 = eigenVec1_x * eigenVal1;
 double M_11 = eigenVec1_y * eigenVal1;
 
 // The points of the 2D ellipse:
 double ang;
 double Aang = 6.283185308 / (m_segments - 1);
 int i;
 
 for( i = 0, ang = 0; i < m_segments; i++, ang += Aang )
 {
 double ccos = cos( ang );
 double csin = sin( ang );
 
 m_shape_xs[i] = m_quantiles * (ccos * M_00 + csin * M_10 );
 m_shape_ys[i] = m_quantiles * (ccos * M_01 + csin * M_11 );
 } // end for points on ellipse
 
 ShapeUpdated();
}

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

align

alignment (choose between mpALIGN_NE, mpALIGN_NW, mpALIGN_SW, mpALIGN_SE

Definition at line 1792 of file mathplot.h.

{ m_flags = align; };

SetBrush()

void mpLayer::SetBrush ( wxBrush  brush )

inlineinherited

Set layer brush.

Parameters

brush

brush, will be copied to internal class member

Definition at line 310 of file mathplot.h.

{ m_brush = brush; };

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

{ m_continuous = continuity; }

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

 {
 m_reference_x = x;
 m_reference_y = y;
 m_reference_phi = phi;
 m_flags = mpALIGN_NE;
 ShapeUpdated();
 }

References mpALIGN_NE.

SetCovarianceMatrix()

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

inline

Changes the covariance matrix:

Definition at line 1893 of file mathplot.h.

 {
 m_cov_00 = cov_00;
 m_cov_01 = cov_01;
 m_cov_11 = cov_11;
 RecalculateShape();
 }

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

drawModeOutside

The draw mode to be set

Definition at line 281 of file mathplot.h.

{ m_drawOutsideMargins = drawModeOutside; };

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

SetFont()

void mpLayer::SetFont ( wxFont &  font )

inlineinherited

Set layer font.

Parameters

font	Font, will be copied to internal class member

Definition at line 272 of file mathplot.h.

{ m_font = font; }

SetName()

void mpLayer::SetName ( wxString  name )

inlineinherited

Set layer name.

Parameters

name	Name, will be copied to internal class member

Definition at line 267 of file mathplot.h.

{ m_name = name; }

References name.

SetPen()

void mpLayer::SetPen ( wxPen  pen )

inlineinherited

Set layer pen.

Parameters

pen	Pen, will be copied to internal class member

Definition at line 277 of file mathplot.h.

{ m_pen = pen; }

Referenced by SIM_PLOT_PANEL::EnableCursor(), and 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 1873 of file mathplot.h.

 {
 m_quantiles = q;
 RecalculateShape();
 }

SetSegments()

void mpCovarianceEllipse::SetSegments ( int  segments )

inline

Definition at line 1879 of file mathplot.h.

{ m_segments = segments; }

SetVisible()

void mpLayer::SetVisible ( bool  show )

inlineinherited

Sets layer visibility.

Parameters

show	visibility bool.

Definition at line 302 of file mathplot.h.

{ m_visible = show; };

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

{
 // Just in case...
 if( m_shape_xs.size() != m_shape_ys.size() )
 {
 }
 else
 {
 double ccos = cos( m_reference_phi ); // Avoid computing cos/sin twice.
 double csin = sin( m_reference_phi );
 
 m_trans_shape_xs.resize( m_shape_xs.size() );
 m_trans_shape_ys.resize( m_shape_xs.size() );
 
 std::vector<double>::iterator itXi, itXo;
 std::vector<double>::iterator itYi, itYo;
 
 m_bbox_min_x = 1e300;
 m_bbox_max_x = -1e300;
 m_bbox_min_y = 1e300;
 m_bbox_max_y = -1e300;
 
 for( itXo = m_trans_shape_xs.begin(),
 itYo = m_trans_shape_ys.begin(), itXi = m_shape_xs.begin(), itYi = m_shape_ys.begin();
 itXo!=m_trans_shape_xs.end(); itXo++, itYo++, itXi++, itYi++ )
 {
 *itXo = m_reference_x + ccos * (*itXi) - csin * (*itYi);
 *itYo = m_reference_y + csin * (*itXi) + ccos * (*itYi);
 
 // Keep BBox:
 if( *itXo < m_bbox_min_x )
 m_bbox_min_x = *itXo;
 
 if( *itXo > m_bbox_max_x )
 m_bbox_max_x = *itXo;
 
 if( *itYo < m_bbox_min_y )
 m_bbox_min_y = *itYo;
 
 if( *itYo > m_bbox_max_y )
 m_bbox_max_y = *itYo;
 }
 }
}

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

{ m_showName = show; };

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

{
 double ccos = cos( m_reference_phi ); // Avoid computing cos/sin twice.
 double csin = sin( m_reference_phi );
 
 out_x = m_reference_x + ccos * x - csin * y;
 out_y = m_reference_y + csin * x + ccos * y;
}

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

Referenced by mpMovableObject::ShapeUpdated().

m_bbox_min_y

double mpMovableObject::m_bbox_min_y

protectedinherited

Definition at line 1819 of file mathplot.h.

Referenced by mpMovableObject::ShapeUpdated().

m_brush

wxBrush mpLayer::m_brush

protectedinherited

Definition at line 316 of file mathplot.h.

m_continuous

bool mpLayer::m_continuous

protectedinherited

Definition at line 318 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 1904 of file mathplot.h.

Referenced by RecalculateShape().

m_cov_01

double mpCovarianceEllipse::m_cov_01

protected

Definition at line 1904 of file mathplot.h.

Referenced by RecalculateShape().

m_cov_11

double mpCovarianceEllipse::m_cov_11

protected

Definition at line 1904 of file mathplot.h.

Referenced by RecalculateShape().

m_drawOutsideMargins

bool mpLayer::m_drawOutsideMargins

protectedinherited

Definition at line 320 of file mathplot.h.

Referenced by mpScaleXBase::getVisibleDataRange(), mpScaleY::getVisibleDataRange(), CURSOR::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().

m_flags

int mpMovableObject::m_flags

protectedinherited

Definition at line 1795 of file mathplot.h.

Referenced by mpMovableObject::Plot().

m_font

wxFont mpLayer::m_font

protectedinherited

Definition at line 314 of file mathplot.h.

Referenced by mpInfoCoords::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

m_name

wxString mpLayer::m_name

protectedinherited

Definition at line 317 of file mathplot.h.

Referenced by mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

m_pen

wxPen mpLayer::m_pen

protectedinherited

Definition at line 315 of file mathplot.h.

Referenced by mpLayer::GetColourSquare(), mpInfoLayer::Plot(), mpInfoCoords::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), and mpMovableObject::Plot().

m_quantiles

double mpCovarianceEllipse::m_quantiles

protected

Definition at line 1905 of file mathplot.h.

Referenced by RecalculateShape().

m_reference_phi

double mpMovableObject::m_reference_phi

protectedinherited

Definition at line 1799 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 1799 of file mathplot.h.

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

m_reference_y

double mpMovableObject::m_reference_y

protectedinherited

Definition at line 1799 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 1909 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 1809 of file mathplot.h.

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

m_shape_ys

std::vector<double> mpMovableObject::m_shape_ys

protectedinherited

Definition at line 1809 of file mathplot.h.

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

m_showName

bool mpLayer::m_showName

protectedinherited

Definition at line 319 of file mathplot.h.

Referenced by mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

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

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

m_type

mpLayerType mpLayer::m_type

protectedinherited

Definition at line 321 of file mathplot.h.

Referenced by mpInfoLayer::mpInfoLayer().

m_visible

bool mpLayer::m_visible

protectedinherited

Definition at line 322 of file mathplot.h.

Referenced by CURSOR::Plot(), mpInfoLayer::Plot(), mpInfoCoords::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

---

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

• mathplot.h
• mathplot.cpp