VTK  9.2.6
vtkPairwiseExtractHistogram2D.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPairwiseExtractHistogram2D.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 /*-------------------------------------------------------------------------
16  Copyright 2009 Sandia Corporation.
17  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18  the U.S. Government retains certain rights in this software.
19 -------------------------------------------------------------------------*/
45 #ifndef vtkPairwiseExtractHistogram2D_h
46 #define vtkPairwiseExtractHistogram2D_h
47 
48 #include "vtkFiltersImagingModule.h" // For export macro
49 #include "vtkSmartPointer.h" //needed for smart pointer ivars
50 #include "vtkStatisticsAlgorithm.h"
51 class vtkCollection;
53 class vtkImageData;
54 class vtkIdTypeArray;
56 
57 class VTKFILTERSIMAGING_EXPORT vtkPairwiseExtractHistogram2D : public vtkStatisticsAlgorithm
58 {
59 public:
62  void PrintSelf(ostream& os, vtkIndent indent) override;
63 
65 
68  vtkSetVector2Macro(NumberOfBins, int);
69  vtkGetVector2Macro(NumberOfBins, int);
71 
73 
78  vtkSetMacro(CustomColumnRangeIndex, int);
79  void SetCustomColumnRangeByIndex(double, double);
81 
83 
88  void SetCustomColumnRange(int col, double range[2]);
89  void SetCustomColumnRange(int col, double rmin, double rmax);
91 
93 
96  vtkSetMacro(ScalarType, int);
97  void SetScalarTypeToUnsignedInt() { this->SetScalarType(VTK_UNSIGNED_INT); }
98  void SetScalarTypeToUnsignedLong() { this->SetScalarType(VTK_UNSIGNED_LONG); }
99  void SetScalarTypeToUnsignedShort() { this->SetScalarType(VTK_UNSIGNED_SHORT); }
100  void SetScalarTypeToUnsignedChar() { this->SetScalarType(VTK_UNSIGNED_CHAR); }
101  vtkGetMacro(ScalarType, int);
103 
107  double GetMaximumBinCount(int idx);
108 
112  double GetMaximumBinCount();
113 
118  int GetBinRange(int idx, vtkIdType binX, vtkIdType binY, double range[4]);
119 
124  int GetBinRange(int idx, vtkIdType bin, double range[4]);
125 
130  void GetBinWidth(int idx, double bw[2]);
131 
136  double* GetHistogramExtents(int idx);
137 
141  vtkImageData* GetOutputHistogramImage(int idx);
142 
146  vtkExtractHistogram2D* GetHistogramFilter(int idx);
147 
149  {
150  HISTOGRAM_IMAGE = 3
151  };
152 
157 
158 protected:
160  ~vtkPairwiseExtractHistogram2D() override;
161 
162  int NumberOfBins[2];
165 
168  class Internals;
169  Internals* Implementation;
170 
175  void Learn(vtkTable* inData, vtkTable* inParameters, vtkMultiBlockDataSet* outMeta) override;
176 
180  void Derive(vtkMultiBlockDataSet*) override {}
181 
186 
190  void Test(vtkTable*, vtkMultiBlockDataSet*, vtkTable*) override { return; }
191 
195  void SelectAssessFunctor(vtkTable* vtkNotUsed(outData), vtkDataObject* vtkNotUsed(inMeta),
196  vtkStringArray* vtkNotUsed(rowNames), AssessFunctor*& vtkNotUsed(dfunc)) override
197  {
198  }
199 
203  virtual vtkExtractHistogram2D* NewHistogramFilter();
204 
206 
208 
209 private:
211  void operator=(const vtkPairwiseExtractHistogram2D&) = delete;
212 };
213 
214 #endif
A base class for a functor that assesses data.
#define VTK_UNSIGNED_INT
Definition: vtkType.h:51
vtkSmartPointer< vtkCollection > HistogramFilters
vtkSmartPointer< vtkIdTypeArray > OutputOutlierIds
static vtkTableAlgorithm * New()
Store vtkAlgorithm input/output information.
#define VTK_UNSIGNED_SHORT
Definition: vtkType.h:49
maintain an unordered list of data objects
record modification and/or execution time
Definition: vtkTimeStamp.h:35
a vtkAbstractArray subclass for strings
dynamic, self-adjusting array of vtkIdType
int vtkIdType
Definition: vtkType.h:332
void Derive(vtkMultiBlockDataSet *) override
Execute the calculations required by the Derive option.
void SetScalarTypeToUnsignedLong()
Set the scalar type for each of the computed histograms.
Base class for statistics algorithms.
a simple class to control print indentation
Definition: vtkIndent.h:39
compute a 2D histogram between two columns of an input vtkTable.
topologically and geometrically regular array of data
Definition: vtkImageData.h:53
virtual void Learn(vtkTable *, vtkTable *, vtkMultiBlockDataSet *)=0
Execute the calculations required by the Learn option, given some input Data.
void SetScalarTypeToUnsignedChar()
Set the scalar type for each of the computed histograms.
void SetScalarTypeToUnsignedInt()
Set the scalar type for each of the computed histograms.
void Aggregate(vtkDataObjectCollection *, vtkMultiBlockDataSet *) override
Given a collection of models, calculate aggregate model.
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:73
#define VTK_UNSIGNED_CHAR
Definition: vtkType.h:47
void SelectAssessFunctor(vtkTable *vtkNotUsed(outData), vtkDataObject *vtkNotUsed(inMeta), vtkStringArray *vtkNotUsed(rowNames), AssessFunctor *&vtkNotUsed(dfunc)) override
Provide the appropriate assessment functor.
create and manipulate ordered lists of objects
Definition: vtkCollection.h:55
int FillOutputPortInformation(int port, vtkInformation *info) override
Fill the output port information objects for this algorithm.
void Assess(vtkTable *, vtkMultiBlockDataSet *, vtkTable *) override
Execute the assess option.
Composite dataset that organizes datasets into blocks.
#define VTK_UNSIGNED_LONG
Definition: vtkType.h:53
void Test(vtkTable *, vtkMultiBlockDataSet *, vtkTable *) override
Execute the calculations required by the Test option.
void SetScalarTypeToUnsignedShort()
Set the scalar type for each of the computed histograms.
general representation of visualization data
Definition: vtkDataObject.h:65
compute a 2D histogram between all adjacent columns of an input vtkTable.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.