VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPairwiseExtractHistogram2D Class Reference

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

#include <vtkPairwiseExtractHistogram2D.h>

Inheritance diagram for vtkPairwiseExtractHistogram2D:
[legend]
Collaboration diagram for vtkPairwiseExtractHistogram2D:
[legend]

Public Types

enum  OutputIndices { HISTOGRAM_IMAGE =3 }
 
typedef vtkStatisticsAlgorithm Superclass
 
- Public Types inherited from vtkStatisticsAlgorithm
typedef vtkTableAlgorithm Superclass
 
enum  InputPorts { INPUT_DATA = 0, LEARN_PARAMETERS = 1, INPUT_MODEL = 2 }
 
enum  OutputIndices { OUTPUT_DATA = 0, OUTPUT_MODEL = 1, ASSESSMENT = 2, OUTPUT_TEST = 2 }
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkPairwiseExtractHistogram2DNewInstance () const
 
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)
 
vtkImageData * GetOutputHistogramImage (int idx)
 
vtkExtractHistogram2DGetHistogramFilter (int idx)
 
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 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 ()
 
- Public Member Functions inherited from vtkStatisticsAlgorithm
vtkStatisticsAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetColumnStatus (const char *namCol, int status)
 
virtual void ResetAllColumnStates ()
 
virtual int RequestSelectedColumns ()
 
virtual void ResetRequests ()
 
virtual vtkIdType GetNumberOfRequests ()
 
virtual vtkIdType GetNumberOfColumnsForRequest (vtkIdType request)
 
void AddColumn (const char *namCol)
 
void AddColumnPair (const char *namColX, const char *namColY)
 
virtual void SetLearnOptionParameterConnection (vtkAlgorithmOutput *params)
 
virtual void SetLearnOptionParameters (vtkDataObject *params)
 
virtual void SetInputModelConnection (vtkAlgorithmOutput *model)
 
virtual void SetInputModel (vtkDataObject *model)
 
virtual void SetLearnOption (bool)
 
virtual bool GetLearnOption ()
 
virtual void SetDeriveOption (bool)
 
virtual bool GetDeriveOption ()
 
virtual void SetAssessOption (bool)
 
virtual bool GetAssessOption ()
 
virtual void SetTestOption (bool)
 
virtual bool GetTestOption ()
 
virtual void SetNumberOfPrimaryTables (vtkIdType)
 
virtual vtkIdType GetNumberOfPrimaryTables ()
 
virtual void SetAssessNames (vtkStringArray *)
 
virtual vtkStringArray * GetAssessNames ()
 
virtual const char * GetColumnForRequest (vtkIdType r, vtkIdType c)
 
virtual int GetColumnForRequest (vtkIdType r, vtkIdType c, vtkStdString &columnName)
 
virtual bool SetParameter (const char *parameter, int index, vtkVariant value)
 

Static Public Member Functions

static
vtkPairwiseExtractHistogram2D
New ()
 
static int IsTypeOf (const char *type)
 
static
vtkPairwiseExtractHistogram2D
SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkStatisticsAlgorithm
static int IsTypeOf (const char *type)
 
static vtkStatisticsAlgorithmSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkPairwiseExtractHistogram2D ()
 
 ~vtkPairwiseExtractHistogram2D ()
 
virtual void Derive (vtkMultiBlockDataSet *)
 
virtual vtkExtractHistogram2DNewHistogramFilter ()
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual void Learn (vtkTable *inData, vtkTable *inParameters, vtkMultiBlockDataSet *outMeta)
 
virtual void Assess (vtkTable *, vtkMultiBlockDataSet *, vtkTable *)
 
virtual void Test (vtkTable *, vtkMultiBlockDataSet *, vtkTable *)
 
virtual void SelectAssessFunctor (vtkTable *vtkNotUsed(outData), vtkDataObject *vtkNotUsed(inMeta), vtkStringArray *vtkNotUsed(rowNames), AssessFunctor *&vtkNotUsed(dfunc))
 
- Protected Member Functions inherited from vtkStatisticsAlgorithm
 vtkStatisticsAlgorithm ()
 
 ~vtkStatisticsAlgorithm ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void Assess (vtkTable *, vtkMultiBlockDataSet *, vtkTable *, int)
 
virtual void SelectAssessFunctor (vtkTable *outData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc)=0
 

Protected Attributes

int NumberOfBins [2]
 
int ScalarType
 
int CustomColumnRangeIndex
 
vtkSmartPointer< vtkIdTypeArray > OutputOutlierIds
 
vtkSmartPointer< vtkCollection > HistogramFilters
 
InternalsImplementation
 
vtkTimeStamp BuildTime
 
- Protected Attributes inherited from vtkStatisticsAlgorithm
int NumberOfPrimaryTables
 
bool LearnOption
 
bool DeriveOption
 
bool AssessOption
 
bool TestOption
 
vtkStringArray * AssessNames
 
vtkStatisticsAlgorithmPrivateInternals
 

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 and Philippe Pebay at Sandia National Laboratories

Definition at line 56 of file vtkPairwiseExtractHistogram2D.h.

Member Typedef Documentation

Definition at line 60 of file vtkPairwiseExtractHistogram2D.h.

Member Enumeration Documentation

Enumerator
HISTOGRAM_IMAGE 

Definition at line 128 of file vtkPairwiseExtractHistogram2D.h.

Constructor & Destructor Documentation

vtkPairwiseExtractHistogram2D::vtkPairwiseExtractHistogram2D ( )
protected
vtkPairwiseExtractHistogram2D::~vtkPairwiseExtractHistogram2D ( )
protected

Member Function Documentation

static vtkPairwiseExtractHistogram2D* vtkPairwiseExtractHistogram2D::New ( )
static
static int vtkPairwiseExtractHistogram2D::IsTypeOf ( const char *  type)
static
virtual int vtkPairwiseExtractHistogram2D::IsA ( const char *  type)
virtual

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPPairwiseExtractHistogram2D.

static vtkPairwiseExtractHistogram2D* vtkPairwiseExtractHistogram2D::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkPairwiseExtractHistogram2D::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPPairwiseExtractHistogram2D.

vtkPairwiseExtractHistogram2D* vtkPairwiseExtractHistogram2D::NewInstance ( ) const
void vtkPairwiseExtractHistogram2D::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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 88 of file vtkPairwiseExtractHistogram2D.h.

void vtkPairwiseExtractHistogram2D::SetScalarTypeToUnsignedLong ( )
inline

Set the scalar type for each of the computed histograms.

Definition at line 90 of file vtkPairwiseExtractHistogram2D.h.

void vtkPairwiseExtractHistogram2D::SetScalarTypeToUnsignedShort ( )
inline

Set the scalar type for each of the computed histograms.

Definition at line 92 of file vtkPairwiseExtractHistogram2D.h.

void vtkPairwiseExtractHistogram2D::SetScalarTypeToUnsignedChar ( )
inline

Set the scalar type for each of the computed histograms.

Definition at line 94 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 *  ,
vtkMultiBlockDataSet *   
)
inlinevirtual

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

Implements vtkStatisticsAlgorithm.

Definition at line 135 of file vtkPairwiseExtractHistogram2D.h.

virtual void vtkPairwiseExtractHistogram2D::Learn ( vtkTable *  inData,
vtkTable *  inParameters,
vtkMultiBlockDataSet *  outMeta 
)
protectedvirtual

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

Implements vtkStatisticsAlgorithm.

virtual void vtkPairwiseExtractHistogram2D::Derive ( vtkMultiBlockDataSet *  )
inlineprotectedvirtual

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

Implements vtkStatisticsAlgorithm.

Definition at line 161 of file vtkPairwiseExtractHistogram2D.h.

virtual void vtkPairwiseExtractHistogram2D::Assess ( vtkTable *  ,
vtkMultiBlockDataSet *  ,
vtkTable *   
)
inlineprotectedvirtual

Execute the assess option. Not implemented.

Implements vtkStatisticsAlgorithm.

Definition at line 165 of file vtkPairwiseExtractHistogram2D.h.

virtual void vtkPairwiseExtractHistogram2D::Test ( vtkTable *  ,
vtkMultiBlockDataSet *  ,
vtkTable *   
)
inlineprotectedvirtual

Execute the calculations required by the Test option.

Implements vtkStatisticsAlgorithm.

Definition at line 172 of file vtkPairwiseExtractHistogram2D.h.

virtual void vtkPairwiseExtractHistogram2D::SelectAssessFunctor ( vtkTable *  vtkNotUsedoutData,
vtkDataObject *  vtkNotUsedinMeta,
vtkStringArray *  vtkNotUsedrowNames,
AssessFunctor *&  vtkNotUseddfunc 
)
inlineprotectedvirtual

Provide the appropriate assessment functor.

Definition at line 179 of file vtkPairwiseExtractHistogram2D.h.

virtual vtkExtractHistogram2D* vtkPairwiseExtractHistogram2D::NewHistogramFilter ( )
protectedvirtual

Generate a new histogram filter

Reimplemented in vtkPPairwiseExtractHistogram2D.

virtual int vtkPairwiseExtractHistogram2D::FillOutputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

Reimplemented from vtkStatisticsAlgorithm.

Member Data Documentation

int vtkPairwiseExtractHistogram2D::NumberOfBins[2]
protected

Definition at line 141 of file vtkPairwiseExtractHistogram2D.h.

int vtkPairwiseExtractHistogram2D::ScalarType
protected

Definition at line 142 of file vtkPairwiseExtractHistogram2D.h.

int vtkPairwiseExtractHistogram2D::CustomColumnRangeIndex
protected

Definition at line 143 of file vtkPairwiseExtractHistogram2D.h.

vtkSmartPointer<vtkIdTypeArray> vtkPairwiseExtractHistogram2D::OutputOutlierIds
protected

Definition at line 146 of file vtkPairwiseExtractHistogram2D.h.

vtkSmartPointer<vtkCollection> vtkPairwiseExtractHistogram2D::HistogramFilters
protected

Definition at line 147 of file vtkPairwiseExtractHistogram2D.h.

Internals* vtkPairwiseExtractHistogram2D::Implementation
protected

Definition at line 148 of file vtkPairwiseExtractHistogram2D.h.

vtkTimeStamp vtkPairwiseExtractHistogram2D::BuildTime
protected

Definition at line 190 of file vtkPairwiseExtractHistogram2D.h.


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