KiCad PCB EDA Suite
|
A 2D ellipse, described by a 2x2 covariance matrix. More...
#include <mathplot.h>
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 |
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 1842 of file mathplot.h.
|
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.
References mpLAYER_PLOT.
|
inlinevirtual |
Definition at line 1867 of file mathplot.h.
|
inlineinherited |
|
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.
side | side length in pixels |
Definition at line 75 of file mathplot.cpp.
References mpLayer::m_pen, and square().
|
inlineinherited |
Gets the 'continuity' property of the layer.
Definition at line 258 of file mathplot.h.
|
inlineinherited |
Get the current coordinate transformation.
Definition at line 1751 of file mathplot.h.
|
inline |
Returns the elements of the current covariance matrix:
Definition at line 1884 of file mathplot.h.
|
inlineinherited |
Get Draw mode: inside or outside margins.
Definition at line 285 of file mathplot.h.
|
inlineinherited |
|
inlineinherited |
Get layer type: a Layer can be of different types: plot lines, axis, info boxes, etc, this method returns the right value.
Definition at line 294 of file mathplot.h.
Referenced by mpInfoLegend::Plot().
|
inlineoverridevirtualinherited |
Get inclusive right border of bounding box.
Reimplemented from mpLayer.
Definition at line 1777 of file mathplot.h.
|
inlineoverridevirtualinherited |
Get inclusive top border of bounding box.
Reimplemented from mpLayer.
Definition at line 1785 of file mathplot.h.
|
inlineoverridevirtualinherited |
Get inclusive left border of bounding box.
Reimplemented from mpLayer.
Definition at line 1773 of file mathplot.h.
|
inlineoverridevirtualinherited |
Get inclusive bottom border of bounding box.
Reimplemented from mpLayer.
Definition at line 1781 of file mathplot.h.
|
inlineinherited |
Get layer name.
Definition at line 238 of file mathplot.h.
Referenced by SIM_PLOT_PANEL::GetLabelX(), SIM_PLOT_PANEL::GetLabelY1(), SIM_PLOT_PANEL::GetLabelY2(), mpInfoLegend::Plot(), and mpText::Plot().
|
inlineinherited |
Get pen set for this layer.
Definition at line 248 of file mathplot.h.
Referenced by CURSOR::Plot(), and mpInfoLegend::Plot().
|
inline |
Definition at line 1869 of file mathplot.h.
|
inline |
Definition at line 1880 of file mathplot.h.
|
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.
true | Has bounding box |
false | Has not bounding box |
Reimplemented from mpLayer.
Definition at line 1769 of file mathplot.h.
Referenced by mpMovableObject::Plot().
|
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.
Reimplemented in mpInfoLayer.
Definition at line 170 of file mathplot.h.
|
inlineinherited |
Checks whether the layer is visible or not.
Definition at line 298 of file mathplot.h.
Referenced by mpWindow::IsLayerVisible(), SIM_PLOT_PANEL::IsLegendShown(), and mpInfoLegend::Plot().
|
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 | Device context to plot to. |
w | View to plot. The visible area can be retrieved from this object. |
Implements mpLayer.
Definition at line 3157 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().
|
protected |
Called to update the m_shape_xs, m_shape_ys vectors, whenever a parameter changes.
Definition at line 3262 of file mathplot.cpp.
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().
|
inlineinherited |
Set label axis alignment.
align | alignment (choose between mpALIGN_NE, mpALIGN_NW, mpALIGN_SW, mpALIGN_SE |
Definition at line 1792 of file mathplot.h.
|
inlineinherited |
Set layer brush.
brush | brush, will be copied to internal class member |
Definition at line 310 of file mathplot.h.
|
inlineinherited |
Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).
Definition at line 253 of file mathplot.h.
Referenced by TRACE::TRACE().
|
inlineinherited |
Set the coordinate transformation (phi in radians, 0 means no rotation).
Definition at line 1760 of file mathplot.h.
References mpALIGN_NE.
|
inline |
Changes the covariance matrix:
Definition at line 1893 of file mathplot.h.
|
inlineinherited |
Set Draw mode: inside or outside margins.
Default is outside, which allows the layer to draw up to the mpWindow border.
drawModeOutside | The draw mode to be set |
Definition at line 281 of file mathplot.h.
Referenced by CURSOR::CURSOR(), and TRACE::TRACE().
|
inlineinherited |
Set layer font.
font | Font, will be copied to internal class member |
Definition at line 272 of file mathplot.h.
|
inlineinherited |
Set layer name.
name | Name, will be copied to internal class member |
Definition at line 267 of file mathplot.h.
References name.
|
inlineinherited |
Set layer pen.
pen | Pen, will be copied to internal class member |
Definition at line 277 of file mathplot.h.
Referenced by SIM_PLOT_PANEL::EnableCursor(), and SIM_PLOT_PANEL::UpdateTraceStyle().
|
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.
|
inline |
Definition at line 1879 of file mathplot.h.
|
inlineinherited |
Sets layer visibility.
show | visibility bool. |
Definition at line 302 of file mathplot.h.
Referenced by mpWindow::SetLayerVisible(), SIM_PLOT_PANEL::ShowLegend(), and SIM_PLOT_PANEL::SIM_PLOT_PANEL().
|
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.
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().
|
inlineinherited |
Shows or hides the text label with the name of the layer (default is visible).
Definition at line 262 of file mathplot.h.
Referenced by TRACE::TRACE().
|
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.
References mpMovableObject::m_reference_phi, mpMovableObject::m_reference_x, and mpMovableObject::m_reference_y.
|
protectedinherited |
Definition at line 1819 of file mathplot.h.
Referenced by mpMovableObject::Plot(), and mpMovableObject::ShapeUpdated().
|
protectedinherited |
Definition at line 1819 of file mathplot.h.
Referenced by mpMovableObject::Plot(), and mpMovableObject::ShapeUpdated().
|
protectedinherited |
The precomputed bounding box:
Definition at line 1819 of file mathplot.h.
Referenced by mpMovableObject::ShapeUpdated().
|
protectedinherited |
Definition at line 1819 of file mathplot.h.
Referenced by mpMovableObject::ShapeUpdated().
|
protectedinherited |
Definition at line 316 of file mathplot.h.
|
protectedinherited |
Definition at line 318 of file mathplot.h.
Referenced by CURSOR::Plot(), mpFXY::Plot(), and mpMovableObject::Plot().
|
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().
|
protected |
Definition at line 1904 of file mathplot.h.
Referenced by RecalculateShape().
|
protected |
Definition at line 1904 of file mathplot.h.
Referenced by RecalculateShape().
|
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().
|
protectedinherited |
Definition at line 1795 of file mathplot.h.
Referenced by mpMovableObject::Plot().
|
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().
|
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().
|
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().
|
protected |
Definition at line 1905 of file mathplot.h.
Referenced by RecalculateShape().
|
protectedinherited |
Definition at line 1799 of file mathplot.h.
Referenced by mpMovableObject::ShapeUpdated(), and mpMovableObject::TranslatePoint().
|
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().
|
protectedinherited |
Definition at line 1799 of file mathplot.h.
Referenced by mpMovableObject::ShapeUpdated(), and mpMovableObject::TranslatePoint().
|
protected |
The number of line segments that build up the ellipse.
Definition at line 1909 of file mathplot.h.
Referenced by RecalculateShape().
|
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().
|
protectedinherited |
Definition at line 1809 of file mathplot.h.
Referenced by RecalculateShape(), mpPolygon::setPoints(), and mpMovableObject::ShapeUpdated().
|
protectedinherited |
Definition at line 319 of file mathplot.h.
Referenced by mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().
|
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().
|
protectedinherited |
Definition at line 1814 of file mathplot.h.
Referenced by mpMovableObject::Plot(), and mpMovableObject::ShapeUpdated().
|
protectedinherited |
Definition at line 321 of file mathplot.h.
Referenced by mpInfoLayer::mpInfoLayer().
|
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().