vtkExtractHistogram2D Class Reference

#include <vtkExtractHistogram2D.h>

Inheritance diagram for vtkExtractHistogram2D:

Inheritance graph
[legend]
Collaboration diagram for vtkExtractHistogram2D:

Collaboration graph
[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 at Sandia National Laboratories ------------------------------------------------------------------------------

Definition at line 55 of file vtkExtractHistogram2D.h.


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])
vtkImageDataGetOutputHistogramImage ()
double * GetHistogramExtents ()
virtual void SetSwapColumns (int)
virtual int GetSwapColumns ()
virtual void SwapColumnsOn ()
virtual void SwapColumnsOff ()
virtual void Aggregate (vtkDataObjectCollection *, vtkDataObject *)
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 vtkDataArrayGetRowMask ()

Static Public Member Functions

static vtkExtractHistogram2DNew ()
static int IsTypeOf (const char *type)
static vtkExtractHistogram2DSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkExtractHistogram2D ()
 ~vtkExtractHistogram2D ()
virtual int ComputeBinExtents (vtkDataArray *col1, vtkDataArray *col2)
virtual void Derive (vtkDataObject *)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
int GetInputArrays (vtkDataArray *&col1, vtkDataArray *&col2)
virtual void Learn (vtkTable *inData, vtkTable *inParameters, vtkDataObject *outMeta)
virtual void Test (vtkTable *, vtkDataObject *, vtkDataObject *)
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
vtkDataArrayRowMask

Member Typedef Documentation

Reimplemented from vtkBivariateStatisticsAlgorithm.

Reimplemented in vtkPExtractHistogram2D.

Definition at line 59 of file vtkExtractHistogram2D.h.


Member Enumeration Documentation

enumeration values to specify output port types

Enumerator:
HISTOGRAM_IMAGE 

Reimplemented from vtkStatisticsAlgorithm.

Definition at line 63 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]

Control the scalar type of the output histogram. If the input is relatively small, you can save space by using a smaller data type. Defaults to unsigned integer.

void vtkExtractHistogram2D::SetScalarTypeToUnsignedInt (  )  [inline]

Control the scalar type of the output histogram. If the input is relatively small, you can save space by using a smaller data type. Defaults to unsigned integer.

Definition at line 103 of file vtkExtractHistogram2D.h.

void vtkExtractHistogram2D::SetScalarTypeToUnsignedLong (  )  [inline]

Control the scalar type of the output histogram. If the input is relatively small, you can save space by using a smaller data type. Defaults to unsigned integer.

Definition at line 105 of file vtkExtractHistogram2D.h.

void vtkExtractHistogram2D::SetScalarTypeToUnsignedShort (  )  [inline]

Control the scalar type of the output histogram. If the input is relatively small, you can save space by using a smaller data type. Defaults to unsigned integer.

Definition at line 107 of file vtkExtractHistogram2D.h.

void vtkExtractHistogram2D::SetScalarTypeToUnsignedChar (  )  [inline]

Control the scalar type of the output histogram. If the input is relatively small, you can save space by using a smaller data type. Defaults to unsigned integer.

Definition at line 109 of file vtkExtractHistogram2D.h.

void vtkExtractHistogram2D::SetScalarTypeToFloat (  )  [inline]

Control the scalar type of the output histogram. If the input is relatively small, you can save space by using a smaller data type. Defaults to unsigned integer.

Definition at line 111 of file vtkExtractHistogram2D.h.

void vtkExtractHistogram2D::SetScalarTypeToDouble (  )  [inline]

Control the scalar type of the output histogram. If the input is relatively small, you can save space by using a smaller data type. Defaults to unsigned integer.

Definition at line 113 of file vtkExtractHistogram2D.h.

virtual int vtkExtractHistogram2D::GetScalarType (  )  [virtual]

Control the scalar type of the output histogram. If the input is relatively small, you can save space by using a smaller data type. Defaults to unsigned integer.

virtual double vtkExtractHistogram2D::GetMaximumBinCount (  )  [virtual]

Access the count of the histogram bin containing the largest number of input rows.

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

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

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

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

void vtkExtractHistogram2D::GetBinWidth ( double  bw[2]  ) 

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

vtkImageData* vtkExtractHistogram2D::GetOutputHistogramImage (  ) 

Gets the data object at the histogram image output port and casts it to a vtkImageData.

double* vtkExtractHistogram2D::GetHistogramExtents (  ) 

Get the histogram extents currently in use, either computed or set by the user.

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

virtual int vtkExtractHistogram2D::GetSwapColumns (  )  [virtual]

virtual void vtkExtractHistogram2D::SwapColumnsOn (  )  [virtual]

virtual void vtkExtractHistogram2D::SwapColumnsOff (  )  [virtual]

virtual void vtkExtractHistogram2D::SetRowMask ( vtkDataArray  )  [virtual]

Get/Set an optional mask that can ignore rows of the table

virtual vtkDataArray* vtkExtractHistogram2D::GetRowMask (  )  [virtual]

Get/Set an optional mask that can ignore rows of the table

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

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

Implements vtkStatisticsAlgorithm.

Definition at line 155 of file vtkExtractHistogram2D.h.

virtual int vtkExtractHistogram2D::ComputeBinExtents ( vtkDataArray col1,
vtkDataArray col2 
) [protected, virtual]

Reimplemented in vtkPExtractHistogram2D.

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

Execute the calculations required by the Learn option. This is what actually does the histogram computation.

Implements vtkStatisticsAlgorithm.

Reimplemented in vtkPExtractHistogram2D.

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

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

Implements vtkStatisticsAlgorithm.

Definition at line 182 of file vtkExtractHistogram2D.h.

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

Execute the calculations required by the Test option.

Implements vtkStatisticsAlgorithm.

Definition at line 186 of file vtkExtractHistogram2D.h.

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

Provide the appropriate assessment functor. Not used.

Definition at line 193 of file vtkExtractHistogram2D.h.

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

virtual int vtkExtractHistogram2D::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

Makes sure that the image data output port has up-to-date spacing/origin/etc

Reimplemented from vtkTableAlgorithm.

int vtkExtractHistogram2D::GetInputArrays ( vtkDataArray *&  col1,
vtkDataArray *&  col2 
) [protected]

Get points to the arrays that live in the two input columns


Member Data Documentation

Definition at line 161 of file vtkExtractHistogram2D.h.

Definition at line 162 of file vtkExtractHistogram2D.h.

Definition at line 163 of file vtkExtractHistogram2D.h.

Definition at line 164 of file vtkExtractHistogram2D.h.

Definition at line 165 of file vtkExtractHistogram2D.h.

Definition at line 166 of file vtkExtractHistogram2D.h.

Definition at line 167 of file vtkExtractHistogram2D.h.

Definition at line 168 of file vtkExtractHistogram2D.h.

Definition at line 169 of file vtkExtractHistogram2D.h.


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

Generated on Mon Sep 27 18:23:42 2010 for VTK by  doxygen 1.5.6