VTK  9.3.1
vtkDescriptiveStatistics.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-FileCopyrightText: Copyright 2010 Sandia Corporation
3 // SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
92 #ifndef vtkDescriptiveStatistics_h
93 #define vtkDescriptiveStatistics_h
94 
95 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
96 #include "vtkFiltersStatisticsModule.h" // For export macro
97 #include "vtkStatisticsAlgorithm.h"
98 
99 VTK_ABI_NAMESPACE_BEGIN
101 class vtkStringArray;
102 class vtkTable;
103 class vtkVariant;
104 class vtkDoubleArray;
105 
106 class VTKFILTERSSTATISTICS_EXPORT vtkDescriptiveStatistics : public vtkStatisticsAlgorithm
107 {
108 public:
110  void PrintSelf(ostream& os, vtkIndent indent) override;
111  static vtkDescriptiveStatistics* New();
112 
114 
120  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
121  virtual void SetUnbiasedVariance(vtkTypeBool);
122  VTK_DEPRECATED_IN_9_2_0("Please use GetSampleEstimate instead")
123  virtual vtkTypeBool GetUnbiasedVariance();
124  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
125  virtual void UnbiasedVarianceOn();
126  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
127  virtual void UnbiasedVarianceOff();
129 
131 
136  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
137  virtual void SetG1Skewness(vtkTypeBool);
138  VTK_DEPRECATED_IN_9_2_0("Please use GetSampleEstimate instead")
139  virtual vtkTypeBool GetG1Skewness();
140  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
141  virtual void G1SkewnessOn();
142  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
143  virtual void G1SkewnessOff();
145 
147 
152  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
153  virtual void SetG2Kurtosis(vtkTypeBool);
154  VTK_DEPRECATED_IN_9_2_0("Please use GetSampleEstimate instead")
155  virtual vtkTypeBool GetG2Kurtosis();
156  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
157  virtual void G2KurtosisOn();
158  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
159  virtual void G2KurtosisOff();
161 
163 
181  vtkSetMacro(SampleEstimate, bool);
182  vtkGetMacro(SampleEstimate, bool);
183  vtkBooleanMacro(SampleEstimate, bool);
185 
187 
192  vtkSetMacro(SignedDeviations, vtkTypeBool);
193  vtkGetMacro(SignedDeviations, vtkTypeBool);
194  vtkBooleanMacro(SignedDeviations, vtkTypeBool);
196 
198 
208  vtkSetMacro(GhostsToSkip, unsigned char);
209  vtkGetMacro(GhostsToSkip, unsigned char);
211 
215  void Aggregate(vtkDataObjectCollection*, vtkMultiBlockDataSet*) override;
216 
217 protected:
219  ~vtkDescriptiveStatistics() override;
220 
225  void Learn(vtkTable*, vtkTable*, vtkMultiBlockDataSet*) override;
226 
230  void Derive(vtkMultiBlockDataSet*) override;
231 
235  void Test(vtkTable*, vtkMultiBlockDataSet*, vtkTable*) override;
236 
240  void Assess(vtkTable* inData, vtkMultiBlockDataSet* inMeta, vtkTable* outData) override
241  {
242  this->Superclass::Assess(inData, inMeta, outData, 1);
243  }
244 
249  virtual vtkDoubleArray* CalculatePValues(vtkDoubleArray*);
250 
254  void SelectAssessFunctor(vtkTable* outData, vtkDataObject* inMeta, vtkStringArray* rowNames,
255  AssessFunctor*& dfunc) override;
256 
259  unsigned char GhostsToSkip;
260 
261 private:
263  void operator=(const vtkDescriptiveStatistics&) = delete;
264 };
265 
266 VTK_ABI_NAMESPACE_END
267 #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 type representing the union of many types.
Definition: vtkVariant.h:52
dynamic, self-adjusting array of double
int vtkTypeBool
Definition: vtkABI.h:64
Base class for statistics algorithms.
a simple class to control print indentation
Definition: vtkIndent.h:28
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:58
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:54
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.