Extract histogram data (binned values) from any dataset. More...

#include <vtkExtractHistogram.h>

Inheritance diagram for vtkExtractHistogram:

Public Types
typedef vtkTableAlgorithm	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent)


virtual void	SetComponent (int)
	Controls which input data component should be binned, for input arrays with more-than-one component. More...

virtual int	GetComponent ()
	Controls which input data component should be binned, for input arrays with more-than-one component. More...


virtual void	SetBinCount (int)
	Controls the number of bins N in the output histogram data. More...

virtual int	GetBinCount ()
	Controls the number of bins N in the output histogram data. More...


virtual void	SetCustomBinRanges (double, double)
	Get/Set custom bin ranges to use. More...

void	SetCustomBinRanges (double [2])
	Get/Set custom bin ranges to use. More...

virtual double *	GetCustomBinRanges ()
	Get/Set custom bin ranges to use. More...

virtual void	GetCustomBinRanges (double &, double &)
	Get/Set custom bin ranges to use. More...

virtual void	GetCustomBinRanges (double [2])
	Get/Set custom bin ranges to use. More...


virtual void	SetUseCustomBinRanges (bool)
	When set to true, CustomBinRanges will be used instead of using the full range for the selected array. More...

virtual bool	GetUseCustomBinRanges ()
	When set to true, CustomBinRanges will be used instead of using the full range for the selected array. More...

virtual void	UseCustomBinRangesOn ()
	When set to true, CustomBinRanges will be used instead of using the full range for the selected array. More...

virtual void	UseCustomBinRangesOff ()
	When set to true, CustomBinRanges will be used instead of using the full range for the selected array. More...


virtual void	SetCalculateAverages (int)
	This option controls whether the algorithm calculates averages of variables other than the primary variable that fall into each bin. More...

virtual int	GetCalculateAverages ()
	This option controls whether the algorithm calculates averages of variables other than the primary variable that fall into each bin. More...

virtual void	CalculateAveragesOn ()
	This option controls whether the algorithm calculates averages of variables other than the primary variable that fall into each bin. More...

virtual void	CalculateAveragesOff ()
	This option controls whether the algorithm calculates averages of variables other than the primary variable that fall into each bin. More...

Static Public Member Functions
static vtkExtractHistogram *	New ()

static int	IsTypeOf (const char *type)

static vtkExtractHistogram *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkExtractHistogram ()

	~vtkExtractHistogram ()

virtual bool	GetInputArrayRange (vtkInformationVector **inputVector, double range[2])
	Returns the data range for the input array to process. More...

virtual int	FillInputPortInformation (int port, vtkInformation *info)

virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual bool	InitializeBinExtents (vtkInformationVector *inputVector, vtkDoubleArray bin_extents, double &min, double &max)

void	BinAnArray (vtkDataArray src, vtkIntArray vals, double min, double max, vtkFieldData *field)

void	FillBinExtents (vtkDoubleArray *bin_extents, double min, double max)

Protected Attributes
double	CustomBinRanges [2]

bool	UseCustomBinRanges

int	Component

int	BinCount

int	CalculateAverages

vtkEHInternals *	Internal

Detailed Description

Extract histogram data (binned values) from any dataset.

vtkExtractHistogram accepts any vtkDataSet as input and produces a vtkPolyData containing histogram data as output. The output vtkPolyData will have contain a vtkDoubleArray named "bin_extents" which contains the boundaries between each histogram bin, and a vtkUnsignedLongArray named "bin_values" which will contain the value for each bin.

Definition at line 38 of file vtkExtractHistogram.h.

Member Typedef Documentation

§ Superclass

typedef vtkTableAlgorithm vtkExtractHistogram::Superclass

Definition at line 42 of file vtkExtractHistogram.h.

Constructor & Destructor Documentation

§ vtkExtractHistogram()

vtkExtractHistogram::vtkExtractHistogram ( )

protected

§ ~vtkExtractHistogram()

vtkExtractHistogram::~vtkExtractHistogram ( )

protected

Member Function Documentation

§ New()

static vtkExtractHistogram* vtkExtractHistogram::New ( )

static

§ GetClassName()

virtual const char* vtkExtractHistogram::GetClassName ( )

virtual

Reimplemented in vtkPExtractHistogram.

§ IsTypeOf()

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

static

§ IsA()

virtual int vtkExtractHistogram::IsA ( const char * type )

virtual

Reimplemented in vtkPExtractHistogram.

§ SafeDownCast()

static vtkExtractHistogram* vtkExtractHistogram::SafeDownCast ( vtkObject * o )

static

§ PrintSelf()

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

§ SetComponent()

virtual void vtkExtractHistogram::SetComponent ( int )

virtual

Controls which input data component should be binned, for input arrays with more-than-one component.

§ GetComponent()

virtual int vtkExtractHistogram::GetComponent ( )

virtual

Controls which input data component should be binned, for input arrays with more-than-one component.

§ SetBinCount()

virtual void vtkExtractHistogram::SetBinCount ( int )

virtual

Controls the number of bins N in the output histogram data.

§ GetBinCount()

virtual int vtkExtractHistogram::GetBinCount ( )

virtual

Controls the number of bins N in the output histogram data.