Class for drawing an a bagplot. More...

#include <vtkPlotBag.h>

Inheritance diagram for vtkPlotBag:

Collaboration diagram for vtkPlotBag:

Public Types
typedef vtkPlotPoints	Superclass

Public Types inherited from vtkPlotPoints
typedef vtkPlot	Superclass

enum	{ NONE = VTK_MARKER_NONE, CROSS = VTK_MARKER_CROSS, PLUS = VTK_MARKER_PLUS, SQUARE = VTK_MARKER_SQUARE, CIRCLE = VTK_MARKER_CIRCLE, DIAMOND = VTK_MARKER_DIAMOND }

Public Types inherited from vtkPlot
typedef vtkContextItem	Superclass

Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem	Superclass

Public Types inherited from vtkAbstractContextItem
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkPlotBag *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Update ()

virtual bool	Paint (vtkContext2D *painter)

virtual vtkStringArray *	GetLabels ()

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)


virtual void	SetBagVisible (bool)

virtual bool	GetBagVisible ()


void	SetLinePen (vtkPen *pen)

virtual vtkPen *	GetLinePen ()


void	SetPointPen (vtkPen *pen)

vtkPen *	GetPointPen ()

Public Member Functions inherited from vtkPlotPoints
vtkPlotPoints *	NewInstance () const

virtual void	GetBounds (double bounds[4])

virtual void	GetUnscaledInputBounds (double bounds[4])

virtual void	CreateDefaultLookupTable ()

vtkStdString	GetColorArrayName ()

virtual bool	SelectPoints (const vtkVector2f &min, const vtkVector2f &max)

virtual bool	SelectPointsInPolygon (const vtkContextPolygon &polygon)

void	SetLookupTable (vtkScalarsToColors *lut)

vtkScalarsToColors *	GetLookupTable ()

virtual void	SetScalarVisibility (int)

virtual int	GetScalarVisibility ()

virtual void	ScalarVisibilityOn ()

virtual void	ScalarVisibilityOff ()

void	SelectColorArray (vtkIdType arrayNum)

void	SelectColorArray (const vtkStdString &arrayName)

virtual vtkIdType	GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)

virtual int	GetMarkerStyle ()

virtual void	SetMarkerStyle (int)

virtual float	GetMarkerSize ()

virtual void	SetMarkerSize (float)

virtual vtkStdString	GetValidPointMaskName ()

virtual void	SetValidPointMaskName (vtkStdString)

Public Member Functions inherited from vtkPlot
vtkPlot *	NewInstance () const

virtual void	SetWidth (float width)

virtual float	GetWidth ()

virtual void	SetLabel (const vtkStdString &label)

virtual vtkStdString	GetLabel ()

virtual void	SetLabels (vtkStringArray *labels)

virtual int	GetNumberOfLabels ()

vtkStdString	GetLabel (vtkIdType index)

void	SetIndexedLabels (vtkStringArray *labels)

virtual vtkStringArray *	GetIndexedLabels ()

vtkContextMapper2D *	GetData ()

virtual vtkTable *	GetInput ()

virtual void	SetInputArray (int index, const vtkStdString &name)

virtual void	UpdateCache ()

virtual void	SetLegendVisibility (bool)

virtual bool	GetLegendVisibility ()

virtual void	LegendVisibilityOn ()

virtual void	LegendVisibilityOff ()

virtual void	SetTooltipLabelFormat (const vtkStdString &label)

virtual vtkStdString	GetTooltipLabelFormat ()

virtual void	SetTooltipNotation (int notation)

virtual int	GetTooltipNotation ()

virtual void	SetTooltipPrecision (int precision)

virtual int	GetTooltipPrecision ()

virtual void	SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)

virtual void	SetColor (double r, double g, double b)

virtual void	GetColor (double rgb[3])

void	GetColor (unsigned char rgb[3])

void	SetPen (vtkPen *pen)

vtkPen *	GetPen ()

void	SetBrush (vtkBrush *brush)

vtkBrush *	GetBrush ()

void	SetSelectionPen (vtkPen *pen)

vtkPen *	GetSelectionPen ()

void	SetSelectionBrush (vtkBrush *brush)

vtkBrush *	GetSelectionBrush ()

virtual bool	GetUseIndexForXSeries ()

virtual void	SetUseIndexForXSeries (bool)

void	SetInputData (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)

virtual void	SetSelectable (bool)

virtual bool	GetSelectable ()

virtual void	SelectableOn ()

virtual void	SelectableOff ()

virtual void	SetSelection (vtkIdTypeArray *id)

virtual vtkIdTypeArray *	GetSelection ()

virtual vtkAxis *	GetXAxis ()

virtual void	SetXAxis (vtkAxis *axis)

virtual vtkAxis *	GetYAxis ()

virtual void	SetYAxis (vtkAxis *axis)

void	SetShiftScale (const vtkRectd &scaling)

vtkRectd	GetShiftScale ()

virtual void	SetProperty (const vtkStdString &property, const vtkVariant &var)

virtual vtkVariant	GetProperty (const vtkStdString &property)

Public Member Functions inherited from vtkContextItem
vtkContextItem *	NewInstance () const

virtual double	GetOpacity ()

virtual void	SetOpacity (double)

Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItem *	NewInstance () const

virtual bool	PaintChildren (vtkContext2D *painter)

virtual void	ReleaseGraphicsResources ()

unsigned int	AddItem (vtkAbstractContextItem *item)

bool	RemoveItem (vtkAbstractContextItem *item)

bool	RemoveItem (unsigned int index)

vtkAbstractContextItem *	GetItem (unsigned int index)

unsigned int	GetItemIndex (vtkAbstractContextItem *item)

unsigned int	GetNumberOfItems ()

void	ClearItems ()

unsigned int	Raise (unsigned int index)

unsigned int	Lower (unsigned int index)

virtual bool	Hit (const vtkContextMouseEvent &mouse)

virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)

virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)

virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)

virtual void	SetScene (vtkContextScene *scene)

virtual void	SetParent (vtkAbstractContextItem *parent)

virtual vtkVector2f	MapToParent (const vtkVector2f &point)

virtual vtkVector2f	MapFromParent (const vtkVector2f &point)

virtual vtkVector2f	MapToScene (const vtkVector2f &point)

virtual vtkVector2f	MapFromScene (const vtkVector2f &point)

virtual unsigned int	StackAbove (unsigned int index, unsigned int under)

virtual unsigned int	StackUnder (unsigned int child, unsigned int above)

virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)

vtkContextScene *	GetScene ()

vtkAbstractContextItem *	GetParent ()

virtual bool	GetVisible ()

virtual void	SetVisible (bool)

virtual bool	GetInteractive ()

virtual void	SetInteractive (bool)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkPlotBag *	SafeDownCast (vtkObjectBase *o)

static vtkPlotBag *	New ()

Static Public Member Functions inherited from vtkPlotPoints
static int	IsTypeOf (const char *type)

static vtkPlotPoints *	SafeDownCast (vtkObjectBase *o)

static vtkPlotPoints *	New ()

Static Public Member Functions inherited from vtkPlot
static int	IsTypeOf (const char *type)

static vtkPlot *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkContextItem
static int	IsTypeOf (const char *type)

static vtkContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractContextItem
static int	IsTypeOf (const char *type)

static vtkAbstractContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPlotBag ()

	~vtkPlotBag ()

void	UpdateTableCache (vtkDataArray *)

Protected Member Functions inherited from vtkPlotPoints
	vtkPlotPoints ()

	~vtkPlotPoints ()

bool	GetDataArrays (vtkTable table, vtkDataArray array[2])

bool	UpdateTableCache (vtkTable *table)

void	CalculateUnscaledInputBounds ()

void	CalculateLogSeries ()

void	FindBadPoints ()

void	CalculateBounds (double bounds[4])

void	CreateSortedPoints ()

Protected Member Functions inherited from vtkPlot
	vtkPlot ()

	~vtkPlot ()

vtkStdString	GetNumber (double position, vtkAxis *axis)

Protected Member Functions inherited from vtkContextItem
	vtkContextItem ()

	~vtkContextItem ()

Protected Member Functions inherited from vtkAbstractContextItem
	vtkAbstractContextItem ()

	~vtkAbstractContextItem ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
bool	BagVisible

vtkPoints2D *	MedianPoints

vtkPoints2D *	Q3Points

vtkPen *	LinePen

Protected Attributes inherited from vtkPlotPoints
vtkIdTypeArray *	BadPoints

vtkCharArray *	ValidPointMask

vtkStdString	ValidPointMaskName

vtkTimeStamp	BuildTime

bool	LogX

bool	LogY

double	UnscaledInputBounds [4]

vtkPoints2D *	Points

vtkNew< vtkFloatArray >	SelectedPoints

VectorPIMPL *	Sorted

int	MarkerStyle

float	MarkerSize

vtkScalarsToColors *	LookupTable

vtkUnsignedCharArray *	Colors

int	ScalarVisibility

vtkStdString	ColorArrayName

Protected Attributes inherited from vtkPlot
vtkSmartPointer< vtkPen >	Pen

vtkSmartPointer< vtkBrush >	Brush

vtkSmartPointer< vtkPen >	SelectionPen

vtkSmartPointer< vtkBrush >	SelectionBrush

vtkSmartPointer< vtkStringArray >	Labels

vtkSmartPointer< vtkStringArray >	AutoLabels

vtkSmartPointer< vtkStringArray >	IndexedLabels

bool	UseIndexForXSeries

vtkSmartPointer< vtkContextMapper2D >	Data

bool	Selectable

vtkIdTypeArray *	Selection

vtkAxis *	XAxis

vtkAxis *	YAxis

vtkStdString	TooltipLabelFormat

vtkStdString	TooltipDefaultLabelFormat

int	TooltipNotation

int	TooltipPrecision

vtkRectd	ShiftScale

bool	LegendVisibility

Protected Attributes inherited from vtkContextItem
double	Opacity

Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene

vtkAbstractContextItem *	Parent

vtkContextScenePrivate *	Children

bool	Visible

bool	Interactive

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 43 of file vtkPlotBag.h.

Member Typedef Documentation

typedef vtkPlotPoints vtkPlotBag::Superclass

Definition at line 46 of file vtkPlotBag.h.

Constructor & Destructor Documentation

vtkPlotBag::vtkPlotBag ( )

protected

vtkPlotBag::~vtkPlotBag ( )

protected

Member Function Documentation

static int vtkPlotBag::IsTypeOf ( const char * type )

static

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.

static vtkPlotBag* vtkPlotBag::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkPlotBag::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPlotPoints.

vtkPlotBag* vtkPlotBag::NewInstance ( ) const

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.

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

virtual void vtkPlotBag::SetBagVisible ( bool )

virtual

Set/get the visibility of the bags. True by default.

virtual bool vtkPlotBag::GetBagVisible ( )

virtual

Set/get the visibility of the bags. True by default.

void vtkPlotBag::SetLinePen ( vtkPen * pen )

Set/get the vtkPen object that controls how this plot draws boundary lines.

virtual vtkPen* vtkPlotBag::GetLinePen ( )

virtual

Set/get the vtkPen object that controls how this plot draws boundary lines.

void vtkPlotBag::SetPointPen ( vtkPen * pen )

inline

Set/get the vtkPen object that controls how this plot draws points. Those are just helpers functions: this pen is actually the default Plot pen.

Definition at line 119 of file vtkPlotBag.h.

vtkPen* vtkPlotBag::GetPointPen ( )

inline

Set/get the vtkPen object that controls how this plot draws points. Those are just helpers functions: this pen is actually the default Plot pen.

Definition at line 120 of file vtkPlotBag.h.

void vtkPlotBag::UpdateTableCache ( vtkDataArray * )

protected

Member Data Documentation

bool vtkPlotBag::BagVisible

protected

Definition at line 129 of file vtkPlotBag.h.

vtkPoints2D* vtkPlotBag::MedianPoints

protected

Definition at line 130 of file vtkPlotBag.h.

vtkPoints2D* vtkPlotBag::Q3Points

protected

Definition at line 131 of file vtkPlotBag.h.

vtkPen* vtkPlotBag::LinePen

protected

Definition at line 132 of file vtkPlotBag.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Charts/Core/vtkPlotBag.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation