VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkPlotBag Class Reference

Class for drawing an a bagplot. More...

#include <vtkPlotBag.h>

Inheritance diagram for vtkPlotBag:
Inheritance graph
[legend]
Collaboration diagram for vtkPlotBag:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkPlotPoints Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkPlotBagNewInstance () const
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual void Update ()
virtual bool Paint (vtkContext2D *painter)
virtual vtkStringArrayGetLabels ()
virtual void SetInputData (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn, vtkIdType densityColumn)
virtual bool PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)
virtual vtkStdString GetTooltipLabel (const vtkVector2d &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)
virtual void SetInputData (vtkTable *table)
virtual void SetInputData (vtkTable *table, const vtkStdString &yColumn, const vtkStdString &densityColumn)
virtual void SetInputData (vtkTable *table, const vtkStdString &xColumn, const vtkStdString &yColumn, const vtkStdString &densityColumn)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkPlotBagSafeDownCast (vtkObjectBase *o)
static vtkPlotBagNew ()

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkPlotBag ()
 ~vtkPlotBag ()
void UpdateTableCache (vtkDataArray *)

Protected Attributes

vtkPoints2DMedianPoints
vtkPoints2DQ3Points

Detailed Description

Class for drawing an a bagplot.

This class allows to draw a bagplot given three columns from a vtkTable. The first two columns will represent X,Y as it is for vtkPlotPoints. The third one will have to specify if the density assigned to each point (generally obtained by the vtkHighestDensityRegionsStatistics filter). Points are drawn in a plot points fashion and 2 convex hull polygons are drawn around the median and the 3 quartile of the density field.

See also:
vtkHighestDensityRegionsStatistics
Tests:
vtkPlotBag (Tests)

Definition at line 41 of file vtkPlotBag.h.


Member Typedef Documentation

Reimplemented from vtkPlotPoints.

Definition at line 44 of file vtkPlotBag.h.


Constructor & Destructor Documentation

vtkPlotBag::vtkPlotBag ( ) [protected]
vtkPlotBag::~vtkPlotBag ( ) [protected]

Member Function Documentation

static int vtkPlotBag::IsTypeOf ( const char *  name) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPlotPoints.

virtual int vtkPlotBag::IsA ( const char *  name) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPlotPoints.

Reimplemented from vtkPlotPoints.

virtual vtkObjectBase* vtkPlotBag::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkPlotPoints.

Reimplemented from vtkPlotPoints.

virtual void vtkPlotBag::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPlotPoints.

static vtkPlotBag* vtkPlotBag::New ( ) [static]

Creates a new Bag Plot object.

Reimplemented from vtkPlotPoints.

virtual void vtkPlotBag::Update ( ) [virtual]

Perform any updates to the item that may be necessary before rendering. The scene should take care of calling this on all items before their Paint function is invoked.

Reimplemented from vtkPlotPoints.

virtual bool vtkPlotBag::Paint ( vtkContext2D painter) [virtual]

Paint event for the XY plot, called whenever the chart needs to be drawn.

Reimplemented from vtkPlotPoints.

virtual bool vtkPlotBag::PaintLegend ( vtkContext2D painter,
const vtkRectf rect,
int  legendIndex 
) [virtual]

Paint legend event for the XY plot, called whenever the legend needs the plot items symbol/mark/line drawn. A rect is supplied with the lower left corner of the rect (elements 0 and 1) and with width x height (elements 2 and 3). The plot can choose how to fill the space supplied.

Reimplemented from vtkPlotPoints.

virtual vtkStringArray* vtkPlotBag::GetLabels ( ) [virtual]

Get the plot labels. If this array has a length greater than 1 the index refers to the stacked objects in the plot. See vtkPlotBar for example.

Reimplemented from vtkPlot.

virtual vtkStdString vtkPlotBag::GetTooltipLabel ( const vtkVector2d plotPos,
vtkIdType  seriesIndex,
vtkIdType  segmentIndex 
) [virtual]

Generate and return the tooltip label string for this plot The segmentIndex parameter is ignored, except for vtkPlotBar

Reimplemented from vtkPlot.

virtual void vtkPlotBag::SetInputData ( vtkTable table) [virtual]

Set the input, we are expecting a vtkTable with three columns. The first column and the second represent the x,y position . The five others columns represent the quartiles used to display the box. Inherited method will call the last SetInputData method with default paramaters.

Reimplemented from vtkPlot.

virtual void vtkPlotBag::SetInputData ( vtkTable table,
const vtkStdString yColumn,
const vtkStdString densityColumn 
) [virtual]

Set the input, we are expecting a vtkTable with three columns. The first column and the second represent the x,y position . The five others columns represent the quartiles used to display the box. Inherited method will call the last SetInputData method with default paramaters.

Reimplemented from vtkPlot.

virtual void vtkPlotBag::SetInputData ( vtkTable table,
const vtkStdString xColumn,
const vtkStdString yColumn,
const vtkStdString densityColumn 
) [virtual]

Set the input, we are expecting a vtkTable with three columns. The first column and the second represent the x,y position . The five others columns represent the quartiles used to display the box. Inherited method will call the last SetInputData method with default paramaters.

virtual void vtkPlotBag::SetInputData ( vtkTable table,
vtkIdType  xColumn,
vtkIdType  yColumn,
vtkIdType  densityColumn 
) [virtual]
void vtkPlotBag::UpdateTableCache ( vtkDataArray ) [protected]

Member Data Documentation

Definition at line 106 of file vtkPlotBag.h.

Definition at line 107 of file vtkPlotBag.h.


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