vtkPairwiseExtractHistogram2D Class Reference

#include <vtkPairwiseExtractHistogram2D.h>

Inheritance diagram for vtkPairwiseExtractHistogram2D:

Inheritance graph
[legend]
Collaboration diagram for vtkPairwiseExtractHistogram2D:

Collaboration graph
[legend]

List of all members.


Detailed Description

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

This class computes a 2D histogram between all adjacent pairs of columns of an input vtkTable. Internally it creates multiple vtkExtractHistogram2D instances (one for each pair of adjacent table columns). It also manages updating histogram computations intelligently, only recomputing those histograms for whom a relevant property has been altered.

Note that there are two different outputs from this filter. One is a table for which each column contains a flattened 2D histogram array. The other is a vtkMultiBlockDataSet for which each block is a vtkImageData representation of the 2D histogram.

See also:
vtkExtractHistogram2D vtkPPairwiseExtractHistogram2D
Thanks:
Developed by David Feng at Sandia National Laboratories ------------------------------------------------------------------------------

Definition at line 54 of file vtkPairwiseExtractHistogram2D.h.


Public Types

enum  OutputIndices { HISTOGRAM_IMAGE = 3 }
typedef vtkStatisticsAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
double GetMaximumBinCount (int idx)
double GetMaximumBinCount ()
int GetBinRange (int idx, vtkIdType binX, vtkIdType binY, double range[4])
int GetBinRange (int idx, vtkIdType bin, double range[4])
void GetBinWidth (int idx, double bw[2])
double * GetHistogramExtents (int idx)
vtkImageDataGetOutputHistogramImage (int idx)
vtkExtractHistogram2DGetHistogramFilter (int idx)
virtual void SetNumberOfBins (int, int)
void SetNumberOfBins (int[2])
virtual int * GetNumberOfBins ()
virtual void GetNumberOfBins (int &, int &)
virtual void GetNumberOfBins (int[2])
virtual void SetCustomColumnRangeIndex (int)
void SetCustomColumnRangeByIndex (double, double)
void SetCustomColumnRange (int col, double range[2])
void SetCustomColumnRange (int col, double rmin, double rmax)
virtual void SetScalarType (int)
void SetScalarTypeToUnsignedInt ()
void SetScalarTypeToUnsignedLong ()
void SetScalarTypeToUnsignedShort ()
void SetScalarTypeToUnsignedChar ()
virtual int GetScalarType ()
virtual void Aggregate (vtkDataObjectCollection *, vtkDataObject *)

Static Public Member Functions

static
vtkPairwiseExtractHistogram2D
New ()
static int IsTypeOf (const char *type)
static
vtkPairwiseExtractHistogram2D
SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkPairwiseExtractHistogram2D ()
 ~vtkPairwiseExtractHistogram2D ()
virtual void Derive (vtkDataObject *)
virtual vtkExtractHistogram2DNewHistogramFilter ()
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual void Learn (vtkTable *inData, vtkTable *inParameters, vtkDataObject *outMeta)
virtual void Assess (vtkTable *, vtkDataObject *, vtkTable *)
virtual void Test (vtkTable *, vtkDataObject *, vtkDataObject *)
virtual void SelectAssessFunctor (vtkTable *vtkNotUsed(outData), vtkDataObject *vtkNotUsed(inMeta), vtkStringArray *vtkNotUsed(rowNames), AssessFunctor *&vtkNotUsed(dfunc))

Protected Attributes

int NumberOfBins [2]
int ScalarType
int CustomColumnRangeIndex
vtkSmartPointer< vtkIdTypeArrayOutputOutlierIds
vtkSmartPointer< vtkCollectionHistogramFilters
InternalsImplementation
vtkTimeStamp BuildTime

Member Typedef Documentation

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPPairwiseExtractHistogram2D.

Definition at line 58 of file vtkPairwiseExtractHistogram2D.h.


Member Enumeration Documentation

enumeration values to specify output port types

Enumerator:
HISTOGRAM_IMAGE 

Reimplemented from vtkStatisticsAlgorithm.

Definition at line 126 of file vtkPairwiseExtractHistogram2D.h.


Constructor & Destructor Documentation

vtkPairwiseExtractHistogram2D::vtkPairwiseExtractHistogram2D (  )  [protected]

vtkPairwiseExtractHistogram2D::~vtkPairwiseExtractHistogram2D (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkPPairwiseExtractHistogram2D.

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

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPPairwiseExtractHistogram2D.

static int vtkPairwiseExtractHistogram2D::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 vtkStatisticsAlgorithm.

Reimplemented in vtkPPairwiseExtractHistogram2D.

virtual int vtkPairwiseExtractHistogram2D::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 vtkStatisticsAlgorithm.

Reimplemented in vtkPPairwiseExtractHistogram2D.

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

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPPairwiseExtractHistogram2D.

void vtkPairwiseExtractHistogram2D::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 vtkStatisticsAlgorithm.

Reimplemented in vtkPPairwiseExtractHistogram2D.

virtual void vtkPairwiseExtractHistogram2D::SetNumberOfBins ( int  ,
int   
) [virtual]

Set/get the bin dimensions of the histograms to compute

void vtkPairwiseExtractHistogram2D::SetNumberOfBins ( int  [2]  ) 

Set/get the bin dimensions of the histograms to compute

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

Set/get the bin dimensions of the histograms to compute

virtual void vtkPairwiseExtractHistogram2D::GetNumberOfBins ( int &  ,
int &   
) [virtual]

Set/get the bin dimensions of the histograms to compute

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

Set/get the bin dimensions of the histograms to compute

virtual void vtkPairwiseExtractHistogram2D::SetCustomColumnRangeIndex ( int   )  [virtual]

Strange method for setting an index to be used for setting custom column range. This was (probably) necessary to get this class to interact with the ParaView client/server message passing interface.

void vtkPairwiseExtractHistogram2D::SetCustomColumnRangeByIndex ( double  ,
double   
)

Strange method for setting an index to be used for setting custom column range. This was (probably) necessary to get this class to interact with the ParaView client/server message passing interface.

void vtkPairwiseExtractHistogram2D::SetCustomColumnRange ( int  col,
double  range[2] 
)

More standard way to set the custom range for a particular column. This makes sure that only the affected histograms know that they need to be updated.

void vtkPairwiseExtractHistogram2D::SetCustomColumnRange ( int  col,
double  rmin,
double  rmax 
)

More standard way to set the custom range for a particular column. This makes sure that only the affected histograms know that they need to be updated.

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

Set the scalar type for each of the computed histograms.

void vtkPairwiseExtractHistogram2D::SetScalarTypeToUnsignedInt (  )  [inline]

Set the scalar type for each of the computed histograms.

Definition at line 86 of file vtkPairwiseExtractHistogram2D.h.

void vtkPairwiseExtractHistogram2D::SetScalarTypeToUnsignedLong (  )  [inline]

Set the scalar type for each of the computed histograms.

Definition at line 88 of file vtkPairwiseExtractHistogram2D.h.

void vtkPairwiseExtractHistogram2D::SetScalarTypeToUnsignedShort (  )  [inline]

Set the scalar type for each of the computed histograms.

Definition at line 90 of file vtkPairwiseExtractHistogram2D.h.

void vtkPairwiseExtractHistogram2D::SetScalarTypeToUnsignedChar (  )  [inline]

Set the scalar type for each of the computed histograms.

Definition at line 92 of file vtkPairwiseExtractHistogram2D.h.

virtual int vtkPairwiseExtractHistogram2D::GetScalarType (  )  [virtual]

Set the scalar type for each of the computed histograms.

double vtkPairwiseExtractHistogram2D::GetMaximumBinCount ( int  idx  ) 

Get the maximum bin count for a single histogram

double vtkPairwiseExtractHistogram2D::GetMaximumBinCount (  ) 

Get the maximum bin count over all histograms

int vtkPairwiseExtractHistogram2D::GetBinRange ( int  idx,
vtkIdType  binX,
vtkIdType  binY,
double  range[4] 
)

Compute the range of the bin located at position (binX,binY) in the 2D histogram at idx.

int vtkPairwiseExtractHistogram2D::GetBinRange ( int  idx,
vtkIdType  bin,
double  range[4] 
)

Get the range of the of the bin located at 1D position index bin in the 2D histogram array at idx.

void vtkPairwiseExtractHistogram2D::GetBinWidth ( int  idx,
double  bw[2] 
)

Get the width of all of the bins. Also stored in the spacing ivar of the histogram image output at idx.

double* vtkPairwiseExtractHistogram2D::GetHistogramExtents ( int  idx  ) 

Get the histogram extents currently in use, either computed or set by the user for the idx'th histogram.

vtkImageData* vtkPairwiseExtractHistogram2D::GetOutputHistogramImage ( int  idx  ) 

Get the vtkImageData output of the idx'th histogram filter

vtkExtractHistogram2D* vtkPairwiseExtractHistogram2D::GetHistogramFilter ( int  idx  ) 

Get a pointer to the idx'th histogram filter.

virtual void vtkPairwiseExtractHistogram2D::Aggregate ( vtkDataObjectCollection ,
vtkDataObject  
) [inline, virtual]

Given a collection of models, calculate aggregate model. Not used

Implements vtkStatisticsAlgorithm.

Definition at line 134 of file vtkPairwiseExtractHistogram2D.h.

virtual void vtkPairwiseExtractHistogram2D::Learn ( vtkTable inData,
vtkTable inParameters,
vtkDataObject outMeta 
) [protected, virtual]

Execute the calculations required by the Learn option. Does the actual histogram computation works.

Implements vtkStatisticsAlgorithm.

virtual void vtkPairwiseExtractHistogram2D::Derive ( vtkDataObject  )  [inline, protected, virtual]

Execute the calculations required by the Derive option. Not used.

Implements vtkStatisticsAlgorithm.

Definition at line 162 of file vtkPairwiseExtractHistogram2D.h.

virtual void vtkPairwiseExtractHistogram2D::Assess ( vtkTable ,
vtkDataObject ,
vtkTable  
) [inline, protected, virtual]

Execute the assess option. Not implemented.

Implements vtkStatisticsAlgorithm.

Definition at line 166 of file vtkPairwiseExtractHistogram2D.h.

virtual void vtkPairwiseExtractHistogram2D::Test ( vtkTable ,
vtkDataObject ,
vtkDataObject  
) [inline, protected, virtual]

Execute the calculations required by the Test option.

Implements vtkStatisticsAlgorithm.

Definition at line 173 of file vtkPairwiseExtractHistogram2D.h.

virtual void vtkPairwiseExtractHistogram2D::SelectAssessFunctor ( vtkTable vtkNotUsedoutData,
vtkDataObject vtkNotUsedinMeta,
vtkStringArray vtkNotUsedrowNames,
AssessFunctor *&  vtkNotUseddfunc 
) [inline, protected, virtual]

Provide the appropriate assessment functor.

Definition at line 180 of file vtkPairwiseExtractHistogram2D.h.

virtual vtkExtractHistogram2D* vtkPairwiseExtractHistogram2D::NewHistogramFilter (  )  [protected, virtual]

Generate a new histogram filter

Reimplemented in vtkPPairwiseExtractHistogram2D.

virtual int vtkPairwiseExtractHistogram2D::FillOutputPortInformation ( int  port,
vtkInformation info 
) [protected, virtual]

Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkStatisticsAlgorithm.


Member Data Documentation

Definition at line 142 of file vtkPairwiseExtractHistogram2D.h.

Definition at line 143 of file vtkPairwiseExtractHistogram2D.h.

Definition at line 144 of file vtkPairwiseExtractHistogram2D.h.

Definition at line 147 of file vtkPairwiseExtractHistogram2D.h.

Definition at line 148 of file vtkPairwiseExtractHistogram2D.h.

Definition at line 149 of file vtkPairwiseExtractHistogram2D.h.

Definition at line 191 of file vtkPairwiseExtractHistogram2D.h.


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

Generated on Mon Sep 27 18:38:24 2010 for VTK by  doxygen 1.5.6