#include <vtkPlotHistogram2D.h>

Inheritance diagram for vtkPlotHistogram2D:

Collaboration diagram for vtkPlotHistogram2D:

Public Types
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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

vtkPlotHistogram2D *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Update ()

virtual bool	Paint (vtkContext2D *painter)

vtkImageData *	GetInputImageData ()

void	SetTransferFunction (vtkScalarsToColors *transfer)

vtkScalarsToColors *	GetTransferFunction ()

virtual void	GetBounds (double bounds[4])

virtual void	SetPosition (const vtkRectf &pos)

virtual vtkRectf	GetPosition ()


virtual void	SetInputData (vtkImageData *data, vtkIdType z=0)

virtual void	SetInputData (vtkTable *)

virtual void	SetInputData (vtkTable *, const vtkStdString &, const vtkStdString &)


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


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

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

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

virtual void	SetWidth (float width)

virtual float	GetWidth ()

virtual void	SetLabel (const vtkStdString &label)

virtual vtkStdString	GetLabel ()

virtual void	SetLabels (vtkStringArray *labels)

virtual vtkStringArray *	GetLabels ()

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 bool	PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)

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 bool	SelectPointsInPolygon (const vtkContextPolygon &polygon)

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	GetUnscaledInputBounds (double bounds[4])

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 vtkPlotHistogram2D *	SafeDownCast (vtkObjectBase *o)

static vtkPlotHistogram2D *	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

	vtkPlotHistogram2D ()

	~vtkPlotHistogram2D ()

void	GenerateHistogram ()

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
vtkSmartPointer< vtkImageData >	Input

vtkSmartPointer< vtkImageData >	Output

vtkSmartPointer< vtkScalarsToColors >	TransferFunction

vtkRectf	Position

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

Definition at line 34 of file vtkPlotHistogram2D.h.

Member Typedef Documentation

typedef vtkPlot vtkPlotHistogram2D::Superclass

Definition at line 37 of file vtkPlotHistogram2D.h.

Constructor & Destructor Documentation

vtkPlotHistogram2D::vtkPlotHistogram2D ( )

protected

vtkPlotHistogram2D::~vtkPlotHistogram2D ( )

protected

Member Function Documentation

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

static

virtual int vtkPlotHistogram2D::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 vtkPlot.

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

static

virtual vtkObjectBase* vtkPlotHistogram2D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPlot.

vtkPlotHistogram2D* vtkPlotHistogram2D::NewInstance ( ) const

virtual void vtkPlotHistogram2D::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 vtkPlot.

static vtkPlotHistogram2D* vtkPlotHistogram2D::New ( )

static

Creates a new object.

virtual void vtkPlotHistogram2D::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 vtkAbstractContextItem.

virtual bool vtkPlotHistogram2D::Paint ( vtkContext2D * painter )

virtual

Paint event for the item, called whenever it needs to be drawn.

Reimplemented from vtkAbstractContextItem.

virtual void vtkPlotHistogram2D::SetInputData	(	vtkImageData *	data,
		vtkIdType	z = `0`
	)

virtual

Set the input, we are expecting a vtkImageData with just one component, this would normally be a float or a double. It will be passed to the other functions as a double to generate a color.

virtual void vtkPlotHistogram2D::SetInputData ( vtkTable * )

inlinevirtual

Set the input, we are expecting a vtkImageData with just one component, this would normally be a float or a double. It will be passed to the other functions as a double to generate a color.

Reimplemented from vtkPlot.

Definition at line 56 of file vtkPlotHistogram2D.h.

virtual void vtkPlotHistogram2D::SetInputData	(	vtkTable *	,
		const vtkStdString &	,
		const vtkStdString &
	)

inlinevirtual

Set the input, we are expecting a vtkImageData with just one component, this would normally be a float or a double. It will be passed to the other functions as a double to generate a color.

Reimplemented from vtkPlot.

Definition at line 57 of file vtkPlotHistogram2D.h.

vtkImageData* vtkPlotHistogram2D::GetInputImageData ( )

Get the input table used by the plot.

void vtkPlotHistogram2D::SetTransferFunction ( vtkScalarsToColors * transfer )

Set the color transfer function that will be used to generate the 2D histogram.

vtkScalarsToColors* vtkPlotHistogram2D::GetTransferFunction ( )

Get the color transfer function that is used to generate the histogram.

virtual void vtkPlotHistogram2D::GetBounds ( double bounds[4] )

virtual

Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax). See GetUnscaledInputBounds for more information.

Reimplemented from vtkPlot.

virtual void vtkPlotHistogram2D::SetPosition ( const vtkRectf & pos )

virtual

virtual vtkRectf vtkPlotHistogram2D::GetPosition ( )

virtual

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

virtual

Generate and return the tooltip label string for this plot The segmentIndex parameter is ignored. The member variable TooltipLabelFormat can be set as a printf-style string to build custom tooltip labels from, and may contain: An empty string generates the default tooltip labels. The following case-sensitive format tags (without quotes) are recognized: 'x' The X position of the histogram cell 'y' The Y position of the histogram cell 'v' The scalar value of the histogram cell Note: the i and j tags are valid only if there is a 1:1 correspondence between individual histogram cells and axis tick marks 'i' The X axis tick label for the histogram cell 'j' The Y axis tick label for the histogram cell Any other characters or unrecognized format tags are printed in the tooltip label verbatim.

Reimplemented from vtkPlot.

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

virtual

Function to query a plot for the nearest point to the specified coordinate. Returns an index between 0 and (number of histogram cells

1), or -1. The index 0 is at cell x=0, y=0 of the histogram, and the index increases in a minor fashon with x and in a major fashon with y. The referent of "location" is set to the x and y integer indices of the histogram cell.

Reimplemented from vtkPlot.

void vtkPlotHistogram2D::GenerateHistogram ( )

protected

Where all the magic happens...

Member Data Documentation

vtkSmartPointer<vtkImageData> vtkPlotHistogram2D::Input

protected

Definition at line 115 of file vtkPlotHistogram2D.h.

vtkSmartPointer<vtkImageData> vtkPlotHistogram2D::Output

protected

Definition at line 116 of file vtkPlotHistogram2D.h.

vtkSmartPointer<vtkScalarsToColors> vtkPlotHistogram2D::TransferFunction

protected

Definition at line 117 of file vtkPlotHistogram2D.h.

vtkRectf vtkPlotHistogram2D::Position

protected

Definition at line 118 of file vtkPlotHistogram2D.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/vtkPlotHistogram2D.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