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
vtkPExtractHistogram2D Class Reference

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

#include <vtkPExtractHistogram2D.h>

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

Public Types

typedef vtkExtractHistogram2D Superclass
 
- Public Types inherited from vtkExtractHistogram2D
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)
 
vtkPExtractHistogram2DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetController (vtkMultiProcessController *)
 
virtual vtkMultiProcessController * GetController ()
 
- Public Member Functions inherited from vtkExtractHistogram2D
vtkExtractHistogram2DNewInstance () const
 
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 ()
 
- 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 vtkPExtractHistogram2DNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPExtractHistogram2DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkExtractHistogram2D
static vtkExtractHistogram2DNew ()
 
static int IsTypeOf (const char *type)
 
static vtkExtractHistogram2DSafeDownCast (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
 
 vtkPExtractHistogram2D ()
 
 ~vtkPExtractHistogram2D ()
 
virtual int ComputeBinExtents (vtkDataArray *col1, vtkDataArray *col2)
 
virtual void Learn (vtkTable *inData, vtkTable *inParameters, vtkMultiBlockDataSet *outMeta)
 
- Protected Member Functions inherited from vtkExtractHistogram2D
 vtkExtractHistogram2D ()
 
 ~vtkExtractHistogram2D ()
 
virtual void Derive (vtkMultiBlockDataSet *)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual void Test (vtkTable *, vtkMultiBlockDataSet *, vtkTable *)
 
virtual void Assess (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)
 
int GetInputArrays (vtkDataArray *&col1, vtkDataArray *&col2)
 
- 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

vtkMultiProcessController * Controller
 
- Protected Attributes inherited from vtkExtractHistogram2D
int SwapColumns
 
int NumberOfBins [2]
 
double HistogramExtents [4]
 
double CustomHistogramExtents [4]
 
int UseCustomHistogramExtents
 
int ComponentsToProcess [2]
 
double MaximumBinCount
 
int ScalarType
 
vtkDataArray * RowMask
 
- 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 two columns of an input vtkTable in parallel.

This class does exactly the same this as vtkExtractHistogram2D, but does it in a multi-process environment. After each node computes their own local histograms, this class does an AllReduce that distributes the sum of all local histograms onto each node.

See Also
vtkExtractHistogram2D
Thanks:

Developed by David Feng and Philippe Pebay at Sandia National Laboratories

Definition at line 47 of file vtkPExtractHistogram2D.h.

Member Typedef Documentation

Definition at line 51 of file vtkPExtractHistogram2D.h.

Constructor & Destructor Documentation

vtkPExtractHistogram2D::vtkPExtractHistogram2D ( )
protected
vtkPExtractHistogram2D::~vtkPExtractHistogram2D ( )
protected

Member Function Documentation

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

Reimplemented from vtkExtractHistogram2D.

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

Reimplemented from vtkExtractHistogram2D.

vtkPExtractHistogram2D* vtkPExtractHistogram2D::NewInstance ( ) const
void vtkPExtractHistogram2D::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkPExtractHistogram2D::SetController ( vtkMultiProcessController *  )
virtual
virtual vtkMultiProcessController* vtkPExtractHistogram2D::GetController ( )
virtual
virtual int vtkPExtractHistogram2D::ComputeBinExtents ( vtkDataArray *  col1,
vtkDataArray *  col2 
)
protectedvirtual

Reimplemented from vtkExtractHistogram2D.

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

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

Reimplemented from vtkExtractHistogram2D.

Member Data Documentation

vtkMultiProcessController* vtkPExtractHistogram2D::Controller
protected

Definition at line 61 of file vtkPExtractHistogram2D.h.


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