vtkPlotBag Class Reference

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
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 }
	Enum containing various marker styles that can be used in a plot. More...
typedef vtkPlot	Superclass
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 Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkPlotBag *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
bool	Paint (vtkContext2D *painter) override
	Paint event for the XY plot, called whenever the chart needs to be drawn.
bool	PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex) override
	Paint legend event for the XY plot, called whenever the legend needs the plot items symbol/mark/line drawn.
vtkStringArray *	GetLabels () override
	Get the plot labels.
vtkStdString	GetTooltipLabel (const vtkVector2d &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex) override
	Generate and return the tooltip label string for this plot The segmentIndex parameter is ignored, except for vtkPlotBar.
virtual void	SetInputData (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn, vtkIdType densityColumn)
void	SetPointPen (vtkPen *pen)
	Set/get the vtkPen object that controls how this plot draws points.
vtkPen *	GetPointPen ()
bool	UpdateCache () override
	Update the internal cache.
void	SetInputData (vtkTable *table) override
	Set the input, we are expecting a vtkTable with three columns.
void	SetInputData (vtkTable *table, const vtkStdString &yColumn, const vtkStdString &densityColumn) override
	Set the input, we are expecting a vtkTable with three columns.
virtual void	SetInputData (vtkTable *table, const vtkStdString &xColumn, const vtkStdString &yColumn, const vtkStdString &densityColumn)
	Set the input, we are expecting a vtkTable with three columns.
virtual void	SetBagVisible (bool)
	Set/get the visibility of the bags.
virtual bool	GetBagVisible ()
	Set/get the visibility of the bags.
void	SetLinePen (vtkPen *pen)
	Set/get the vtkPen object that controls how this plot draws boundary lines.
virtual vtkPen *	GetLinePen ()
	Set/get the vtkPen object that controls how this plot draws boundary lines.
Public Member Functions inherited from vtkPlotPoints
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkPlotPoints *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
bool	Paint (vtkContext2D *painter) override
	Paint event for the XY plot, called whenever the chart needs to be drawn.
bool	PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex) override
	Paint legend event for the XY plot, called whenever the legend needs the plot items symbol/mark/line drawn.
void	GetBounds (double bounds[4]) override
	Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax).
void	GetUnscaledInputBounds (double bounds[4]) override
	Get the non-log-scaled bounds on chart inputs for this plot as (Xmin, Xmax, Ymin, Ymax).
virtual void	CreateDefaultLookupTable ()
	Create default lookup table.
vtkStdString	GetColorArrayName ()
	Get the array name to color by.
vtkIdType	GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location, vtkIdType *segmentId) override
	Function to query a plot for the nearest point to the specified coordinate.
bool	SelectPoints (const vtkVector2f &min, const vtkVector2f &max) override
	Select all points in the specified rectangle.
bool	SelectPointsInPolygon (const vtkContextPolygon &polygon) override
	Select all points in the specified polygon.
bool	UpdateCache () override
	Update the internal cache.
void	ReleaseGraphicsCache () override
	Release cache entries created by this context item.
virtual vtkIdType	GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location, vtkIdType *segmentId)
	Function to query a plot for the nearest point to the specified coordinate.
void	SetLookupTable (vtkScalarsToColors *lut)
	Specify a lookup table for the mapper to use.
vtkScalarsToColors *	GetLookupTable ()
	Specify a lookup table for the mapper to use.
virtual void	SetScalarVisibility (vtkTypeBool)
	Turn on/off flag to control whether scalar data is used to color objects.
virtual vtkTypeBool	GetScalarVisibility ()
	Turn on/off flag to control whether scalar data is used to color objects.
virtual void	ScalarVisibilityOn ()
	Turn on/off flag to control whether scalar data is used to color objects.
virtual void	ScalarVisibilityOff ()
	Turn on/off flag to control whether scalar data is used to color objects.
void	SelectColorArray (vtkIdType arrayNum)
	When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods.
void	SelectColorArray (const vtkStdString &arrayName)
	When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods.
virtual int	GetMarkerStyle ()
	Get/set the marker style that should be used.
virtual void	SetMarkerStyle (int)
	Get/set the marker style that should be used.
virtual float	GetMarkerSize ()
	Get/set the marker size that should be used.
virtual void	SetMarkerSize (float)
	Get/set the marker size that should be used.
virtual vtkStdString	GetValidPointMaskName ()
	Get/set the valid point mask array name.
virtual void	SetValidPointMaskName (vtkStdString)
	Get/set the valid point mask array name.
Public Member Functions inherited from vtkPlot
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkPlot *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Update () override
	Perform any updates to the item that may be necessary before rendering.
virtual bool	PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)
	Paint legend event for the plot, called whenever the legend needs the plot items symbol/mark/line drawn.
virtual vtkStdString	GetTooltipLabel (const vtkVector2d &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)
	Generate and return the tooltip label string for this plot The segmentIndex parameter is ignored, except for vtkPlotBar.
virtual vtkIdType	GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location, vtkIdType *segmentId)
	Function to query a plot for the nearest point to the specified coordinate.
virtual bool	SelectPoints (const vtkVector2f &min, const vtkVector2f &max)
	Select all points in the specified rectangle.
virtual bool	SelectPointsInPolygon (const vtkContextPolygon &polygon)
	Select all points in the specified polygon.
virtual void	SetLabel (const vtkStdString &label)
	Set the label of this plot.
virtual vtkStdString	GetLabel ()
	Get the label of this plot.
virtual void	SetLabels (vtkStringArray *labels)
	Set the plot labels, these are used for stacked chart variants, with the index referring to the stacking index.
virtual vtkStringArray *	GetLabels ()
	Get the plot labels.
virtual int	GetNumberOfLabels ()
	Get the number of labels associated with this plot.
vtkStdString	GetLabel (vtkIdType index)
	Get the label at the specified index.
void	SetIndexedLabels (vtkStringArray *labels)
	Set indexed labels for the plot.
virtual vtkStringArray *	GetIndexedLabels ()
	Get the indexed labels array.
vtkContextMapper2D *	GetData ()
	Get the data object that the plot will draw.
virtual vtkTable *	GetInput ()
	Get the input table used by the plot.
vtkAlgorithmOutput *	GetInputConnection ()
	Get the input connection used by the plot.
virtual void	SetInputArray (int index, const vtkStdString &name)
	Convenience function to set the input arrays.
virtual void	GetBounds (double bounds[4])
	Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax).
virtual void	GetUnscaledInputBounds (double bounds[4])
	Provide un-log-scaled bounds for the plot inputs.
bool	Hit (const vtkContextMouseEvent &mouse) override
	Returns true if the supplied x, y coordinate is inside the item.
virtual bool	UpdateCache ()
	Update the internal cache.
virtual void	SetLegendVisibility (bool)
	Set whether the plot renders an entry in the legend.
virtual bool	GetLegendVisibility ()
	Set whether the plot renders an entry in the legend.
virtual void	LegendVisibilityOn ()
	Set whether the plot renders an entry in the legend.
virtual void	LegendVisibilityOff ()
	Set whether the plot renders an entry in the legend.
virtual void	SetTooltipLabelFormat (const vtkStdString &label)
	Sets/gets a printf-style string to build custom tooltip labels from.
virtual vtkStdString	GetTooltipLabelFormat ()
	Sets/gets a printf-style string to build custom tooltip labels from.
virtual void	SetTooltipNotation (int notation)
	Sets/gets the tooltip notation style.
virtual int	GetTooltipNotation ()
	Sets/gets the tooltip notation style.
virtual void	SetTooltipPrecision (int precision)
	Sets/gets the tooltip precision.
virtual int	GetTooltipPrecision ()
	Sets/gets the tooltip precision.
virtual void	SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
	Set the plot color with integer values (comprised between 0 and 255)
virtual void	SetColor (unsigned char r, unsigned char g, unsigned char b)
	Set the plot color with integer values (comprised between 0 and 255)
virtual void	SetColorF (double r, double g, double b, double a)
	Set the plot color with floating values (comprised between 0.0 and 1.0)
virtual void	SetColorF (double r, double g, double b)
	Set the plot color with floating values (comprised between 0.0 and 1.0)
virtual void	GetColor (unsigned char rgb[3])
	Get the plot color as integer rgb values (comprised between 0 and 255)
void	GetColorRGBA (unsigned char rgba[4])
	Get the plot color as integer rgb values (comprised between 0 and 255)
virtual void	GetColorF (double rgb[3])
	Get the plot color as floating rgb values (comprised between 0.0 and 1.0)
virtual void	SetWidth (float width)
	@
virtual float	GetWidth ()
	Get the width of the line.
void	SetPen (vtkPen *pen)
	Set/get the vtkPen object that controls how this plot draws (out)lines.
vtkPen *	GetPen ()
	Get the plot color as floating rgb values (comprised between 0.0 and 1.0)
void	SetBrush (vtkBrush *brush)
	Set/get the vtkBrush object that controls how this plot fills shapes.
vtkBrush *	GetBrush ()
	Set/get the vtkBrush object that controls how this plot fills shapes.
void	SetSelectionPen (vtkPen *pen)
	Set/get the vtkBrush object that controls how this plot fills selected shapes.
vtkPen *	GetSelectionPen ()
	Set/get the vtkBrush object that controls how this plot fills selected shapes.
void	SetSelectionBrush (vtkBrush *brush)
	Set/get the vtkBrush object that controls how this plot fills selected shapes.
vtkBrush *	GetSelectionBrush ()
	Set/get the vtkBrush object that controls how this plot fills selected shapes.
virtual bool	GetUseIndexForXSeries ()
	Use the Y array index for the X value.
virtual void	SetUseIndexForXSeries (bool)
	Use the Y array index for the X value.
void	SetInputData (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)
	This is a convenience function to set the input table and the x, y column for the plot.
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	This is a convenience function to set the input connection for the plot.
void	SetXAxisInputArrayToProcess (const std::string &name)
	Convenient function to directly set/get the names of columns used for X and Y axis respectively.
std::string	GetXAxisInputArrayToProcess ()
	Convenient function to directly set/get the names of columns used for X and Y axis respectively.
void	SetYAxisInputArrayToProcess (const std::string &name)
	Convenient function to directly set/get the names of columns used for X and Y axis respectively.
std::string	GetYAxisInputArrayToProcess ()
	Convenient function to directly set/get the names of columns used for X and Y axis respectively.
virtual void	SetSelectable (bool)
	Set whether the plot can be selected.
virtual bool	GetSelectable ()
	Set whether the plot can be selected.
virtual void	SelectableOn ()
	Set whether the plot can be selected.
virtual void	SelectableOff ()
	Set whether the plot can be selected.
virtual void	SetSelection (vtkIdTypeArray *id)
	Sets the list of points that must be selected.
virtual vtkIdTypeArray *	GetSelection ()
	Sets the list of points that must be selected.
virtual vtkAxis *	GetXAxis ()
	Get/set the X axis associated with this plot.
virtual void	SetXAxis (vtkAxis *axis)
	Get/set the X axis associated with this plot.
virtual vtkAxis *	GetYAxis ()
	Get/set the Y axis associated with this plot.
virtual void	SetYAxis (vtkAxis *axis)
	Get/set the Y axis associated with this plot.
void	SetShiftScale (const vtkRectd &shiftScale)
	Get/set the origin shift and scaling factor used by the plot, this is normally 0.0 offset and 1.0 scaling, but can be used to render data outside of the single precision range.
vtkRectd	GetShiftScale ()
	Get/set the origin shift and scaling factor used by the plot, this is normally 0.0 offset and 1.0 scaling, but can be used to render data outside of the single precision range.
virtual void	SetProperty (const vtkStdString &property, const vtkVariant &var)
	A General setter/getter that should be overridden.
virtual vtkVariant	GetProperty (const vtkStdString &property)
	A General setter/getter that should be overridden.
virtual bool	ClampPos (double pos[2])
	Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped, false otherwise.
Public Member Functions inherited from vtkContextItem
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkContextItem *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	SetTransform (vtkContextTransform *)
	Set the transform of the item.
virtual double	GetOpacity ()
	Get the opacity of the item.
virtual void	SetOpacity (double)
	Set the opacity of the item.
Public Member Functions inherited from vtkAbstractContextItem
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAbstractContextItem *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	Update ()
	Perform any updates to the item that may be necessary before rendering.
virtual bool	Paint (vtkContext2D *painter)
	Paint event for the item, called whenever the item needs to be drawn.
virtual bool	PaintChildren (vtkContext2D *painter)
	Paint the children of the item, should be called whenever the children need to be rendered.
virtual void	ReleaseGraphicsResources ()
	Release graphics resources hold by the item.
vtkIdType	AddItem (vtkAbstractContextItem *item)
	Add child items to this item.
bool	RemoveItem (vtkAbstractContextItem *item)
	Remove child item from this item.
bool	RemoveItem (vtkIdType index)
	Remove child item from this item.
vtkAbstractContextItem *	GetItem (vtkIdType index)
	Get the item at the specified index.
vtkIdType	GetItemIndex (vtkAbstractContextItem *item)
	Get the index of the specified item in itemIndex.
vtkIdType	GetNumberOfItems ()
	Get the number of child items.
void	ClearItems ()
	Remove all child items from this item.
vtkIdType	Raise (vtkIdType index)
	Raises the child to the top of the item's stack.
virtual vtkIdType	StackAbove (vtkIdType index, vtkIdType under)
	Raises the child above the under sibling.
vtkIdType	Lower (vtkIdType index)
	Lowers the child to the bottom of the item's stack.
virtual vtkIdType	StackUnder (vtkIdType child, vtkIdType above)
	Lowers the child under the above sibling.
virtual bool	Hit (const vtkContextMouseEvent &mouse)
	Return true if the supplied x, y coordinate is inside the item.
virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)
	Return the item under the mouse.
virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)
	Mouse enter event.
virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)
	Mouse move event.
virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)
	Mouse leave event.
virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
	Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items.
virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
	Mouse button release event.
virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
	Mouse button double click event.
virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
	Mouse wheel event, positive delta indicates forward movement of the wheel.
virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)
	Key press event.
virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)
	Key release event.
virtual void	SetScene (vtkContextScene *scene)
	Set the vtkContextScene for the item, always set for an item in a scene.
vtkContextScene *	GetScene ()
	Get the vtkContextScene for the item, always set for an item in a scene.
virtual void	SetParent (vtkAbstractContextItem *parent)
	Set the parent item.
vtkAbstractContextItem *	GetParent ()
	Get the parent item.
virtual vtkVector2f	MapToParent (const vtkVector2f &point)
	Maps the point to the parent coordinate system.
virtual vtkVector2f	MapFromParent (const vtkVector2f &point)
	Maps the point from the parent coordinate system.
virtual vtkVector2f	MapToScene (const vtkVector2f &point)
	Maps the point to the scene coordinate system.
virtual vtkVector2f	MapFromScene (const vtkVector2f &point)
	Maps the point from the scene coordinate system.
virtual bool	GetVisible ()
	Get the visibility of the item (should it be drawn).
virtual void	SetVisible (bool)
	Set the visibility of the item (should it be drawn).
virtual bool	GetInteractive ()
	Get if the item is interactive (should respond to mouse events).
virtual void	SetInteractive (bool)
	Set if the item is interactive (should respond to mouse events).
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPlotBag *	SafeDownCast (vtkObjectBase *o)
static vtkPlotBag *	New ()
	Creates a new Bag Plot object.
Static Public Member Functions inherited from vtkPlotPoints
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPlotPoints *	SafeDownCast (vtkObjectBase *o)
static vtkPlotPoints *	New ()
	Creates a 2D Chart object.
Static Public Member Functions inherited from vtkPlot
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPlot *	SafeDownCast (vtkObjectBase *o)
static void	FilterSelectedPoints (vtkDataArray *points, vtkDataArray *selectedPoints, vtkIdTypeArray *selectedIds)
	Utility function that fills up selectedPoints with tuples from points.
static bool	ClampPos (double pos[2], double bounds[4])
	Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped, false otherwise.
Static Public Member Functions inherited from vtkContextItem
static vtkTypeBool	IsTypeOf (const char *type)
static vtkContextItem *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAbstractContextItem *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPlotBag ()
	~vtkPlotBag () override
Protected Member Functions inherited from vtkPlotPoints
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPlotPoints ()
	~vtkPlotPoints () override
bool	GetDataArrays (vtkTable *table, vtkDataArray *array[2])
	Populate the data arrays ready to operate on input data.
bool	CacheRequiresUpdate () override
	Test if the internal cache requires an update.
void	CalculateUnscaledInputBounds ()
	Calculate the unscaled input bounds from the input arrays.
void	CalculateLogSeries ()
	Handle calculating the log of the x or y series if necessary.
void	FindBadPoints ()
	Find all of the "bad points" in the series.
void	CalculateBounds (double bounds[4])
	Calculate the bounds of the plot, ignoring the bad points.
void	CreateSortedPoints ()
	Create the sorted point list if necessary.
Protected Member Functions inherited from vtkPlot
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPlot ()
	~vtkPlot () override
vtkStdString	GetNumber (double position, vtkAxis *axis)
	Get the properly formatted number for the supplied position and axis.
virtual bool	CacheRequiresUpdate ()
	Test if the internal cache requires an update.
virtual void	TransformScreenToData (const vtkVector2f &in, vtkVector2f &out)
	Transform the mouse event in the control-points space.
virtual void	TransformDataToScreen (const vtkVector2f &in, vtkVector2f &out)
	Transform the mouse event in the control-points space.
virtual void	TransformScreenToData (double inX, double inY, double &outX, double &outY)
	Transform the mouse event in the control-points space.
virtual void	TransformDataToScreen (double inX, double inY, double &outX, double &outY)
	Transform the mouse event in the control-points space.
Protected Member Functions inherited from vtkContextItem
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkContextItem ()=default
	~vtkContextItem () override
Protected Member Functions inherited from vtkAbstractContextItem
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAbstractContextItem ()
	~vtkAbstractContextItem () override
virtual void	ReleaseGraphicsCache ()
	Release cache entries created by this context item.
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
bool	BagVisible
vtkPoints2D *	MedianPoints
vtkPoints2D *	Q3Points
vtkPen *	LinePen
Protected Attributes inherited from vtkPlotPoints
vtkIdTypeArray *	BadPoints
	An array containing the indices of all the "bad points", meaning any x, y pair that has an infinity, -infinity or not a number value.
vtkCharArray *	ValidPointMask
	Array which marks valid points in the array.
vtkStdString	ValidPointMaskName
	Name of the valid point mask array.
bool	LogX
bool	LogY
double	UnscaledInputBounds [4]
	Cached bounds on the plot input axes.
vtkPoints2D *	Points
	Store a well packed set of XY coordinates for this data series.
vtkNew< vtkFloatArray >	SelectedPoints
	Store a well packed set of XY coordinates for this data series.
VectorPIMPL *	Sorted
int	MarkerStyle
	The marker style that should be used.
float	MarkerSize
	The marker style that should be used.
vtkScalarsToColors *	LookupTable
	Lookup Table for coloring points by scalar value.
vtkUnsignedCharArray *	Colors
	Lookup Table for coloring points by scalar value.
vtkTypeBool	ScalarVisibility
	Lookup Table for coloring points by scalar value.
vtkStdString	ColorArrayName
	Lookup Table for coloring points by scalar value.
Protected Attributes inherited from vtkPlot
vtkTimeStamp	BuildTime
	The point cache is marked dirty until it has been initialized.
vtkSmartPointer< vtkPen >	Pen
	This object stores the vtkPen that controls how the plot is drawn.
vtkSmartPointer< vtkBrush >	Brush
	This object stores the vtkBrush that controls how the plot is drawn.
vtkSmartPointer< vtkPen >	SelectionPen
	This object stores the vtkPen that controls how the selected elements of the plot are drawn.
vtkSmartPointer< vtkBrush >	SelectionBrush
	This object stores the vtkBrush that controls how the selected elements of the plot are drawn.
vtkSmartPointer< vtkStringArray >	Labels
	Plot labels, used by legend.
vtkSmartPointer< vtkStringArray >	AutoLabels
	Holds Labels when they're auto-created.
vtkSmartPointer< vtkStringArray >	IndexedLabels
	Holds Labels when they're auto-created.
bool	UseIndexForXSeries
	Use the Y array index for the X value.
vtkSmartPointer< vtkContextMapper2D >	Data
	This data member contains the data that will be plotted, it inherits from vtkAlgorithm.
bool	Selectable
	Whether plot points can be selected or not.
vtkIdTypeArray *	Selection
	Selected indices for the table the plot is rendering.
vtkAxis *	XAxis
	The X axis associated with this plot.
vtkAxis *	YAxis
	The X axis associated with this plot.
vtkStdString	TooltipLabelFormat
	A printf-style string to build custom tooltip labels from.
vtkStdString	TooltipDefaultLabelFormat
	The default printf-style string to build custom tooltip labels from.
int	TooltipNotation
int	TooltipPrecision
vtkRectd	ShiftScale
	The current shift in origin and scaling factor applied to the plot.
bool	LegendVisibility
Protected Attributes inherited from vtkContextItem
double	Opacity = 1.0
vtkContextTransform *	Transform = nullptr
Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene
	Point to the scene the item is on - can be null.
vtkAbstractContextItem *	Parent
	Point to the parent item - can be null.
vtkContextScenePrivate *	Children
	This structure provides a list of children, along with convenience functions to paint the children etc.
bool	Visible
	Store the visibility of the item (default is true).
bool	Interactive
	Store whether the item should respond to interactions (default is true).
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

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

Member Typedef Documentation

Superclass

typedef vtkPlotPoints vtkPlotBag::Superclass

Definition at line 37 of file vtkPlotBag.h.

Constructor & Destructor Documentation

vtkPlotBag()

vtkPlotBag::vtkPlotBag ( )

protected

~vtkPlotBag()

vtkPlotBag::~vtkPlotBag ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool 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.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkPlotBag::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPlotPoints.

NewInstance()

vtkPlotBag * vtkPlotBag::NewInstance

(

)

const

PrintSelf()

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

overridevirtual

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 vtkPlot.

New()

static vtkPlotBag * vtkPlotBag::New ( )

static

Creates a new Bag Plot object.

Paint()

bool vtkPlotBag::Paint ( vtkContext2D *  painter )

overridevirtual

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

Reimplemented from vtkAbstractContextItem.

PaintLegend()

bool vtkPlotBag::PaintLegend ( vtkContext2D *  painter, const vtkRectf &  rect, int  legendIndex  )

overridevirtual

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 vtkPlot.

GetLabels()

vtkStringArray * vtkPlotBag::GetLabels ( )

overridevirtual

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.

GetTooltipLabel()

vtkStdString vtkPlotBag::GetTooltipLabel ( const vtkVector2d &  plotPos, vtkIdType  seriesIndex, vtkIdType  segmentIndex  )

overridevirtual

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

Reimplemented from vtkPlot.

SetInputData() [1/4]

void vtkPlotBag::SetInputData ( vtkTable *  table )

overridevirtual

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 parameters.

Reimplemented from vtkPlot.

SetInputData() [2/4]

void vtkPlotBag::SetInputData ( vtkTable *  table, const vtkStdString &  yColumn, const vtkStdString &  densityColumn  )

overridevirtual

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 parameters.

Reimplemented from vtkPlot.

SetInputData() [3/4]

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 parameters.

SetInputData() [4/4]

virtual void vtkPlotBag::SetInputData ( vtkTable *  table, vtkIdType  xColumn, vtkIdType  yColumn, vtkIdType  densityColumn  )

virtual

SetBagVisible()

virtual void vtkPlotBag::SetBagVisible ( bool  )

virtual

Set/get the visibility of the bags.

True by default.

GetBagVisible()

virtual bool vtkPlotBag::GetBagVisible ( )

virtual

Set/get the visibility of the bags.

True by default.

SetLinePen()

void vtkPlotBag::SetLinePen

(

vtkPen *

pen

)

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

GetLinePen()

virtual vtkPen * vtkPlotBag::GetLinePen ( )

virtual

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

SetPointPen()

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

GetPointPen()

vtkPen * vtkPlotBag::GetPointPen ( )

inline

Definition at line 112 of file vtkPlotBag.h.

UpdateCache()

bool vtkPlotBag::UpdateCache ( )

overridevirtual

Update the internal cache.

Returns true if cache was successfully updated. Default does nothing. This method is called by Update() when either the plot's data has changed or CacheRequiresUpdate() returns true. It is not necessary to call this method explicitly.

Reimplemented from vtkPlot.

Member Data Documentation

BagVisible

bool vtkPlotBag::BagVisible

protected

Definition at line 126 of file vtkPlotBag.h.

MedianPoints

vtkPoints2D* vtkPlotBag::MedianPoints

protected

Definition at line 127 of file vtkPlotBag.h.

Q3Points

vtkPoints2D* vtkPlotBag::Q3Points

protected

Definition at line 128 of file vtkPlotBag.h.

LinePen

vtkPen* vtkPlotBag::LinePen

protected

Definition at line 129 of file vtkPlotBag.h.

---

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

• Charts/Core/vtkPlotBag.h