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 -------------------------------------------------------------------------*/
101
102#ifndef vtkDescriptiveStatistics_h
103#define vtkDescriptiveStatistics_h
104
105#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
106#include "vtkFiltersStatisticsModule.h" // For export macro
108
110class vtkStringArray;
111class vtkTable;
112class vtkVariant;
113class vtkDoubleArray;
114
115class VTKFILTERSSTATISTICS_EXPORT vtkDescriptiveStatistics : public vtkStatisticsAlgorithm
116{
117public:
119 void PrintSelf(ostream& os, vtkIndent indent) override;
121
123
129 VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
131 VTK_DEPRECATED_IN_9_2_0("Please use GetSampleEstimate instead")
133 VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
134 virtual void UnbiasedVarianceOn();
135 VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
136 virtual void UnbiasedVarianceOff();
138
140
145 VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
147 VTK_DEPRECATED_IN_9_2_0("Please use GetSampleEstimate instead")
149 VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
150 virtual void G1SkewnessOn();
151 VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
152 virtual void G1SkewnessOff();
154
156
161 VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
163 VTK_DEPRECATED_IN_9_2_0("Please use GetSampleEstimate instead")
165 VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
166 virtual void G2KurtosisOn();
167 VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
168 virtual void G2KurtosisOff();
170
172
190 vtkSetMacro(SampleEstimate, bool);
191 vtkGetMacro(SampleEstimate, bool);
192 vtkBooleanMacro(SampleEstimate, bool);
194
196
203 vtkBooleanMacro(SignedDeviations, vtkTypeBool);
205
207
217 vtkSetMacro(GhostsToSkip, unsigned char);
218 vtkGetMacro(GhostsToSkip, unsigned char);
220
225
226protected:
229
235
240
245
249 void Assess(vtkTable* inData, vtkMultiBlockDataSet* inMeta, vtkTable* outData) override
250 {
251 this->Superclass::Assess(inData, inMeta, outData, 1);
252 }
253
259
263 void SelectAssessFunctor(vtkTable* outData, vtkDataObject* inMeta, vtkStringArray* rowNames,
264 AssessFunctor*& dfunc) override;
265
268 unsigned char GhostsToSkip;
269
270private:
272 void operator=(const vtkDescriptiveStatistics&) = delete;
273};
274
275#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:34
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:68
A atomic type representing the union of many types.
Definition vtkVariant.h:64
int vtkTypeBool
Definition vtkABI.h:69
#define VTK_DEPRECATED_IN_9_2_0(reason)