vtkExtractHistogram2D Class Reference

#include <vtkExtractHistogram2D.h>

Inheritance diagram for vtkExtractHistogram2D:

[legend]

Collaboration diagram for vtkExtractHistogram2D:

[legend]

List of all members.

Detailed Description

compute a 2D histogram between two columns of an input vtkTable.

This class computes a 2D histogram between two columns of an input vtkTable. Just as with a 1D histogram, a 2D histogram breaks up the input domain into bins, and each pair of values (row in the table) fits into a single bin and increments a row counter for that bin.

To use this class, set the input with a table and call AddColumnPair(nameX,nameY), where nameX and nameY are the names of the two columns to be used.

In addition to the number of bins (in X and Y), the domain of the histogram can be customized by toggling the UseCustomHistogramExtents flag and setting the CustomHistogramExtents variable to the desired value.

See also:: vtkPExtractHistogram2D

Thanks:: Developed by David Feng and Philippe Pebay at Sandia National Laboratories ------------------------------------------------------------------------------

Definition at line 56 of file vtkExtractHistogram2D.h.


int	GetInputArrays (vtkDataArray &col1, vtkDataArray &col2)
Public Types
enum	OutputIndices { HISTOGRAM_IMAGE = 3 }
typedef vtkBivariateStatisticsAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	GetBinRange (vtkIdType binX, vtkIdType binY, double range[4])
int	GetBinRange (vtkIdType bin, double range[4])
void	GetBinWidth (double bw[2])
vtkImageData *	GetOutputHistogramImage ()
double *	GetHistogramExtents ()
virtual void	SetSwapColumns (int)
virtual int	GetSwapColumns ()
virtual void	SwapColumnsOn ()
virtual void	SwapColumnsOff ()
virtual void	Aggregate (vtkDataObjectCollection , vtkMultiBlockDataSet )

virtual void	SetNumberOfBins (int, int)
void	SetNumberOfBins (int[2])
virtual int *	GetNumberOfBins ()
virtual void	GetNumberOfBins (int &, int &)
virtual void	GetNumberOfBins (int[2])

virtual void	SetComponentsToProcess (int, int)
void	SetComponentsToProcess (int[2])
virtual int *	GetComponentsToProcess ()
virtual void	GetComponentsToProcess (int &, int &)
virtual void	GetComponentsToProcess (int[2])

virtual void	SetCustomHistogramExtents (double, double, double, double)
virtual void	SetCustomHistogramExtents (double[4])
virtual double *	GetCustomHistogramExtents ()
virtual void	GetCustomHistogramExtents (double &, double &, double &, double &)
virtual void	GetCustomHistogramExtents (double[4])

virtual void	SetUseCustomHistogramExtents (int)
virtual int	GetUseCustomHistogramExtents ()
virtual void	UseCustomHistogramExtentsOn ()
virtual void	UseCustomHistogramExtentsOff ()

virtual void	SetScalarType (int)
void	SetScalarTypeToUnsignedInt ()
void	SetScalarTypeToUnsignedLong ()
void	SetScalarTypeToUnsignedShort ()
void	SetScalarTypeToUnsignedChar ()
void	SetScalarTypeToFloat ()
void	SetScalarTypeToDouble ()
virtual int	GetScalarType ()

virtual double	GetMaximumBinCount ()

virtual void	SetRowMask (vtkDataArray *)
virtual vtkDataArray *	GetRowMask ()
Static Public Member Functions
static vtkExtractHistogram2D *	New ()
static int	IsTypeOf (const char *type)
static vtkExtractHistogram2D *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkExtractHistogram2D ()
	~vtkExtractHistogram2D ()
virtual int	ComputeBinExtents (vtkDataArray col1, vtkDataArray col2)
virtual void	Derive (vtkMultiBlockDataSet *)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)

virtual void	Learn (vtkTable inData, vtkTable inParameters, vtkMultiBlockDataSet *inMeta)

virtual void	Test (vtkTable , vtkMultiBlockDataSet , vtkTable *)

virtual void	SelectAssessFunctor (vtkTable vtkNotUsed(outData), vtkDataObject vtkNotUsed(inMeta), vtkStringArray vtkNotUsed(rowNames), AssessFunctor &vtkNotUsed(dfunc))

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
Protected Attributes
int	SwapColumns
int	NumberOfBins [2]
double	HistogramExtents [4]
double	CustomHistogramExtents [4]
int	UseCustomHistogramExtents
int	ComponentsToProcess [2]
double	MaximumBinCount
int	ScalarType
vtkDataArray *	RowMask

Member Typedef Documentation

typedef vtkBivariateStatisticsAlgorithm vtkExtractHistogram2D::Superclass

Reimplemented from vtkBivariateStatisticsAlgorithm.

Reimplemented in vtkPExtractHistogram2D.

Definition at line 60 of file vtkExtractHistogram2D.h.

Member Enumeration Documentation

enum vtkExtractHistogram2D::OutputIndices

enumeration values to specify output port types

Enumerator:

HISTOGRAM_IMAGE

Reimplemented from vtkStatisticsAlgorithm.

Definition at line 64 of file vtkExtractHistogram2D.h.

Constructor & Destructor Documentation

vtkExtractHistogram2D::vtkExtractHistogram2D ( ) [protected]

vtkExtractHistogram2D::~vtkExtractHistogram2D ( ) [protected]

Member Function Documentation

static vtkExtractHistogram2D* vtkExtractHistogram2D::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkPExtractHistogram2D.

virtual const char* vtkExtractHistogram2D::GetClassName ( ) [virtual]

Reimplemented from vtkBivariateStatisticsAlgorithm.

Reimplemented in vtkPExtractHistogram2D.

static int vtkExtractHistogram2D::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 vtkBivariateStatisticsAlgorithm.

Reimplemented in vtkPExtractHistogram2D.

virtual int vtkExtractHistogram2D::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 vtkBivariateStatisticsAlgorithm.

Reimplemented in vtkPExtractHistogram2D.

static vtkExtractHistogram2D* vtkExtractHistogram2D::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkBivariateStatisticsAlgorithm.

Reimplemented in vtkPExtractHistogram2D.

void vtkExtractHistogram2D::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 vtkBivariateStatisticsAlgorithm.

Reimplemented in vtkPExtractHistogram2D.

virtual void vtkExtractHistogram2D::SetNumberOfBins	(	int	,
		int
	)			`[virtual]`

Set/get the number of bins to be used per dimension (x,y)

void vtkExtractHistogram2D::SetNumberOfBins ( int [2] )

Set/get the number of bins to be used per dimension (x,y)

virtual int* vtkExtractHistogram2D::GetNumberOfBins ( ) [virtual]

Set/get the number of bins to be used per dimension (x,y)

virtual void vtkExtractHistogram2D::GetNumberOfBins	(	int &	,
		int &
	)			`[virtual]`

Set/get the number of bins to be used per dimension (x,y)

virtual void vtkExtractHistogram2D::GetNumberOfBins ( int [2] ) [virtual]

Set/get the number of bins to be used per dimension (x,y)

virtual void vtkExtractHistogram2D::SetComponentsToProcess	(	int	,
		int
	)			`[virtual]`

Set/get the components of the arrays in the two input columns to be used during histogram computation. Defaults to component 0.

void vtkExtractHistogram2D::SetComponentsToProcess ( int [2] )

Set/get the components of the arrays in the two input columns to be used during histogram computation. Defaults to component 0.

virtual int* vtkExtractHistogram2D::GetComponentsToProcess ( ) [virtual]

Set/get the components of the arrays in the two input columns to be used during histogram computation. Defaults to component 0.

virtual void vtkExtractHistogram2D::GetComponentsToProcess	(	int &	,
		int &
	)			`[virtual]`

Set/get the components of the arrays in the two input columns to be used during histogram computation. Defaults to component 0.

virtual void vtkExtractHistogram2D::GetComponentsToProcess ( int [2] ) [virtual]

Set/get the components of the arrays in the two input columns to be used during histogram computation. Defaults to component 0.

virtual void vtkExtractHistogram2D::SetCustomHistogramExtents	(	double	,
		double	,
		double	,
		double
	)			`[virtual]`

Set/get a custom domain for histogram computation. UseCustomHistogramExtents must be called for these to actually be used.

virtual void vtkExtractHistogram2D::SetCustomHistogramExtents ( double [4] ) [virtual]

Set/get a custom domain for histogram computation. UseCustomHistogramExtents must be called for these to actually be used.

virtual double* vtkExtractHistogram2D::GetCustomHistogramExtents ( ) [virtual]

Set/get a custom domain for histogram computation. UseCustomHistogramExtents must be called for these to actually be used.

virtual void vtkExtractHistogram2D::GetCustomHistogramExtents	(	double &	,
		double &	,
		double &	,
		double &
	)			`[virtual]`

Set/get a custom domain for histogram computation. UseCustomHistogramExtents must be called for these to actually be used.

virtual void vtkExtractHistogram2D::GetCustomHistogramExtents ( double [4] ) [virtual]

Set/get a custom domain for histogram computation. UseCustomHistogramExtents must be called for these to actually be used.

virtual void vtkExtractHistogram2D::SetUseCustomHistogramExtents ( int ) [virtual]

Use the extents in CustomHistogramExtents when computing the histogram, rather than the simple range of the input columns.

virtual int vtkExtractHistogram2D::GetUseCustomHistogramExtents ( ) [virtual]

Use the extents in CustomHistogramExtents when computing the histogram, rather than the simple range of the input columns.

virtual void vtkExtractHistogram2D::UseCustomHistogramExtentsOn ( ) [virtual]

Use the extents in CustomHistogramExtents when computing the histogram, rather than the simple range of the input columns.

virtual void vtkExtractHistogram2D::UseCustomHistogramExtentsOff ( ) [virtual]

Use the extents in CustomHistogramExtents when computing the histogram, rather than the simple range of the input columns.

virtual void vtkExtractHistogram2D::SetScalarType ( int ) [virtual]