VTK  9.2.6
vtkDescriptiveStatistics.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3 Program: Visualization Toolkit
4 Module: vtkDescriptiveStatistics.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 2010 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  -------------------------------------------------------------------------*/
108 #ifndef vtkDescriptiveStatistics_h
109 #define vtkDescriptiveStatistics_h
110 
111 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
112 #include "vtkFiltersStatisticsModule.h" // For export macro
113 #include "vtkStatisticsAlgorithm.h"
114 
116 class vtkStringArray;
117 class vtkTable;
118 class vtkVariant;
119 class vtkDoubleArray;
120 
121 class VTKFILTERSSTATISTICS_EXPORT vtkDescriptiveStatistics : public vtkStatisticsAlgorithm
122 {
123 public:
125  void PrintSelf(ostream& os, vtkIndent indent) override;
126  static vtkDescriptiveStatistics* New();
127 
129 
135  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
136  virtual void SetUnbiasedVariance(vtkTypeBool);
137  VTK_DEPRECATED_IN_9_2_0("Please use GetSampleEstimate instead")
138  virtual vtkTypeBool GetUnbiasedVariance();
139  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
140  virtual void UnbiasedVarianceOn();
141  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
142  virtual void UnbiasedVarianceOff();
144 
146 
151  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
152  virtual void SetG1Skewness(vtkTypeBool);
153  VTK_DEPRECATED_IN_9_2_0("Please use GetSampleEstimate instead")
154  virtual vtkTypeBool GetG1Skewness();
155  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
156  virtual void G1SkewnessOn();
157  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
158  virtual void G1SkewnessOff();
160 
162 
167  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
168  virtual void SetG2Kurtosis(vtkTypeBool);
169  VTK_DEPRECATED_IN_9_2_0("Please use GetSampleEstimate instead")
170  virtual vtkTypeBool GetG2Kurtosis();
171  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
172  virtual void G2KurtosisOn();
173  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
174  virtual void G2KurtosisOff();
176 
178 
196  vtkSetMacro(SampleEstimate, bool);
197  vtkGetMacro(SampleEstimate, bool);
198  vtkBooleanMacro(SampleEstimate, bool);
200 
202 
207  vtkSetMacro(SignedDeviations, vtkTypeBool);
208  vtkGetMacro(SignedDeviations, vtkTypeBool);
209  vtkBooleanMacro(SignedDeviations, vtkTypeBool);
211 
213 
223  vtkSetMacro(GhostsToSkip, unsigned char);
224  vtkGetMacro(GhostsToSkip, unsigned char);
226 
230  void Aggregate(vtkDataObjectCollection*, vtkMultiBlockDataSet*) override;
231 
232 protected:
234  ~vtkDescriptiveStatistics() override;
235 
240  void Learn(vtkTable*, vtkTable*, vtkMultiBlockDataSet*) override;
241 
245  void Derive(vtkMultiBlockDataSet*) override;
246 
250  void Test(vtkTable*, vtkMultiBlockDataSet*, vtkTable*) override;
251 
255  void Assess(vtkTable* inData, vtkMultiBlockDataSet* inMeta, vtkTable* outData) override
256  {
257  this->Superclass::Assess(inData, inMeta, outData, 1);
258  }
259 
264  virtual vtkDoubleArray* CalculatePValues(vtkDoubleArray*);
265 
269  void SelectAssessFunctor(vtkTable* outData, vtkDataObject* inMeta, vtkStringArray* rowNames,
270  AssessFunctor*& dfunc) override;
271 
274  unsigned char GhostsToSkip;
275 
276 private:
278  void operator=(const vtkDescriptiveStatistics&) = delete;
279 };
280 
281 #endif
static vtkTableAlgorithm * New()
maintain an unordered list of data objects
#define VTK_DEPRECATED_IN_9_2_0(reason)
a vtkAbstractArray subclass for strings
A atomic type representing the union of many types.
Definition: vtkVariant.h:69
dynamic, self-adjusting array of double
int vtkTypeBool
Definition: vtkABI.h:69
Base class for statistics algorithms.
a simple class to control print indentation
Definition: vtkIndent.h:39
int Test(int argc, char *argv[], const char *dfile, const InitializationCallback &initCallback)
A class for univariate descriptive statistics.
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:73
Composite dataset that organizes datasets into blocks.
virtual void SelectAssessFunctor(vtkTable *outData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc)=0
A pure virtual method to select the appropriate assessment functor.
general representation of visualization data
Definition: vtkDataObject.h:65
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.