VTK  9.2.6
vtkDescriptiveStatistics.h
Go to the documentation of this file.
1/*=========================================================================
2
3Program: Visualization Toolkit
4Module: vtkDescriptiveStatistics.h
5
6Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7All rights reserved.
8See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10This software is distributed WITHOUT ANY WARRANTY; without even
11the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12PURPOSE. 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 -------------------------------------------------------------------------*/
107
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
114
116class vtkStringArray;
117class vtkTable;
118class vtkVariant;
119class vtkDoubleArray;
120
121class VTKFILTERSSTATISTICS_EXPORT vtkDescriptiveStatistics : public vtkStatisticsAlgorithm
122{
123public:
125 void PrintSelf(ostream& os, vtkIndent indent) override;
127
129
135 VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
137 VTK_DEPRECATED_IN_9_2_0("Please use GetSampleEstimate instead")
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")
153 VTK_DEPRECATED_IN_9_2_0("Please use GetSampleEstimate instead")
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")
169 VTK_DEPRECATED_IN_9_2_0("Please use GetSampleEstimate instead")
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
209 vtkBooleanMacro(SignedDeviations, vtkTypeBool);
211
213
223 vtkSetMacro(GhostsToSkip, unsigned char);
224 vtkGetMacro(GhostsToSkip, unsigned char);
226
231
232protected:
235
241
246
251
255 void Assess(vtkTable* inData, vtkMultiBlockDataSet* inMeta, vtkTable* outData) override
256 {
257 this->Superclass::Assess(inData, inMeta, outData, 1);
258 }
259
265
269 void SelectAssessFunctor(vtkTable* outData, vtkDataObject* inMeta, vtkStringArray* rowNames,
270 AssessFunctor*& dfunc) override;
271
274 unsigned char GhostsToSkip;
275
276private:
278 void operator=(const vtkDescriptiveStatistics&) = delete;
279};
280
281#endif
maintain an unordered list of data objects
general representation of visualization data
void SelectAssessFunctor(vtkTable *outData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc) override
Provide the appropriate assessment functor.
virtual void G1SkewnessOn()
virtual vtkTypeBool GetUnbiasedVariance()
virtual void SetG2Kurtosis(vtkTypeBool)
virtual void G2KurtosisOff()
void Derive(vtkMultiBlockDataSet *) override
Execute the calculations required by the Derive option.
virtual vtkDoubleArray * CalculatePValues(vtkDoubleArray *)
Calculate p-value.
void Test(vtkTable *, vtkMultiBlockDataSet *, vtkTable *) override
Execute the calculations required by the Test option.
static vtkDescriptiveStatistics * New()
virtual void SetUnbiasedVariance(vtkTypeBool)
virtual void UnbiasedVarianceOff()
virtual void UnbiasedVarianceOn()
virtual vtkTypeBool GetG2Kurtosis()
virtual vtkTypeBool GetG1Skewness()
virtual void SetG1Skewness(vtkTypeBool)
virtual void G2KurtosisOn()
virtual void G1SkewnessOff()
void Learn(vtkTable *, vtkTable *, vtkMultiBlockDataSet *) override
Execute the calculations required by the Learn option, given some input Data NB: input parameters are...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void Assess(vtkTable *inData, vtkMultiBlockDataSet *inMeta, vtkTable *outData) override
Execute the calculations required by the Assess option.
void Aggregate(vtkDataObjectCollection *, vtkMultiBlockDataSet *) override
Given a collection of models, calculate aggregate model.
dynamic, self-adjusting array of double
a simple class to control print indentation
Definition vtkIndent.h:40
Composite dataset that organizes datasets into blocks.
A base class for a functor that assesses data.
virtual void Assess(vtkTable *, vtkMultiBlockDataSet *, vtkTable *)=0
Execute the calculations required by the Assess option.
a vtkAbstractArray subclass for strings
A table, which contains similar-typed columns of data.
Definition vtkTable.h:74
A atomic type representing the union of many types.
Definition vtkVariant.h:70
int vtkTypeBool
Definition vtkABI.h:69
#define VTK_DEPRECATED_IN_9_2_0(reason)