#include <vtkPlotHistogram2D.h>

Inheritance diagram for vtkPlotHistogram2D:

Collaboration diagram for vtkPlotHistogram2D:

Public Types
typedef vtkPlot	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 vtkVector2f &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)

virtual vtkIdType	GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkPlotHistogram2D *	SafeDownCast (vtkObjectBase *o)
static vtkPlotHistogram2D *	New ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPlotHistogram2D ()
	~vtkPlotHistogram2D ()
void	GenerateHistogram ()
Protected Attributes
vtkSmartPointer< vtkImageData >	Input
vtkSmartPointer< vtkImageData >	Output
vtkSmartPointer < vtkScalarsToColors >	TransferFunction
vtkRectf	Position

Detailed Description

Definition at line 34 of file vtkPlotHistogram2D.h.

Member Typedef Documentation

typedef vtkPlot vtkPlotHistogram2D::Superclass

Reimplemented from vtkPlot.

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

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]

Reimplemented from vtkPlot.

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

Reimplemented from vtkPlot.

vtkPlotHistogram2D* vtkPlotHistogram2D::NewInstance ( ) const

Reimplemented from vtkPlot.

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.

Reimplemented from vtkObject.

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 * ) [inline, 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.

Reimplemented from vtkPlot.

Definition at line 56 of file vtkPlotHistogram2D.h.

virtual void vtkPlotHistogram2D::SetInputData	(	vtkTable *	,
		const vtkStdString &	,
		const vtkStdString &
	)		`[inline, 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.

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 vtkVector2f &	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...