VTK  9.0.1
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  -------------------------------------------------------------------------*/
49 #ifndef vtkDescriptiveStatistics_h
50 #define vtkDescriptiveStatistics_h
51 
52 #include "vtkFiltersStatisticsModule.h" // For export macro
53 #include "vtkStatisticsAlgorithm.h"
54 
56 class vtkStringArray;
57 class vtkTable;
58 class vtkVariant;
59 class vtkDoubleArray;
60 
61 class VTKFILTERSSTATISTICS_EXPORT vtkDescriptiveStatistics : public vtkStatisticsAlgorithm
62 {
63 public:
65  void PrintSelf(ostream& os, vtkIndent indent) override;
66  static vtkDescriptiveStatistics* New();
67 
69 
74  vtkSetMacro(UnbiasedVariance, vtkTypeBool);
75  vtkGetMacro(UnbiasedVariance, vtkTypeBool);
76  vtkBooleanMacro(UnbiasedVariance, vtkTypeBool);
78 
80 
85  vtkSetMacro(G1Skewness, vtkTypeBool);
86  vtkGetMacro(G1Skewness, vtkTypeBool);
87  vtkBooleanMacro(G1Skewness, vtkTypeBool);
89 
91 
96  vtkSetMacro(G2Kurtosis, vtkTypeBool);
97  vtkGetMacro(G2Kurtosis, vtkTypeBool);
98  vtkBooleanMacro(G2Kurtosis, vtkTypeBool);
100 
102 
107  vtkSetMacro(SignedDeviations, vtkTypeBool);
108  vtkGetMacro(SignedDeviations, vtkTypeBool);
109  vtkBooleanMacro(SignedDeviations, vtkTypeBool);
111 
116 
117 protected:
119  ~vtkDescriptiveStatistics() override;
120 
125  void Learn(vtkTable*, vtkTable*, vtkMultiBlockDataSet*) override;
126 
130  void Derive(vtkMultiBlockDataSet*) override;
131 
135  void Test(vtkTable*, vtkMultiBlockDataSet*, vtkTable*) override;
136 
140  void Assess(vtkTable* inData, vtkMultiBlockDataSet* inMeta, vtkTable* outData) override
141  {
142  this->Superclass::Assess(inData, inMeta, outData, 1);
143  }
144 
149  virtual vtkDoubleArray* CalculatePValues(vtkDoubleArray*);
150 
154  void SelectAssessFunctor(vtkTable* outData, vtkDataObject* inMeta, vtkStringArray* rowNames,
155  AssessFunctor*& dfunc) override;
156 
161 
162 private:
164  void operator=(const vtkDescriptiveStatistics&) = delete;
165 };
166 
167 #endif
vtkStatisticsAlgorithm.h
vtkDescriptiveStatistics::G2Kurtosis
vtkTypeBool G2Kurtosis
Definition: vtkDescriptiveStatistics.h:159
vtkDataObjectCollection
maintain an unordered list of data objects
Definition: vtkDataObjectCollection.h:31
vtkDescriptiveStatistics::SignedDeviations
vtkTypeBool SignedDeviations
Definition: vtkDescriptiveStatistics.h:160
vtkDescriptiveStatistics::G1Skewness
vtkTypeBool G1Skewness
Definition: vtkDescriptiveStatistics.h:158
vtkTable
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:62
vtkDescriptiveStatistics
A class for univariate descriptive statistics.
Definition: vtkDescriptiveStatistics.h:61
vtkMultiBlockDataSet
Composite dataset that organizes datasets into blocks.
Definition: vtkMultiBlockDataSet.h:45
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkVariant
A atomic type representing the union of many types.
Definition: vtkVariant.h:65
vtkStatisticsAlgorithm::Learn
virtual void Learn(vtkTable *, vtkTable *, vtkMultiBlockDataSet *)=0
Execute the calculations required by the Learn option, given some input Data.
vtkStatisticsAlgorithm::Aggregate
virtual void Aggregate(vtkDataObjectCollection *, vtkMultiBlockDataSet *)=0
Given a collection of models, calculate aggregate model.
vtkStatisticsAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkStatisticsAlgorithm::SelectAssessFunctor
virtual void SelectAssessFunctor(vtkTable *outData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc)=0
A pure virtual method to select the appropriate assessment functor.
vtkStatisticsAlgorithm::Derive
virtual void Derive(vtkMultiBlockDataSet *)=0
Execute the calculations required by the Derive option.
vtkDescriptiveStatistics::UnbiasedVariance
vtkTypeBool UnbiasedVariance
Definition: vtkDescriptiveStatistics.h:157
vtkStringArray
a vtkAbstractArray subclass for strings
Definition: vtkStringArray.h:36
vtkDoubleArray
dynamic, self-adjusting array of double
Definition: vtkDoubleArray.h:35
vtkDescriptiveStatistics::Assess
void Assess(vtkTable *inData, vtkMultiBlockDataSet *inMeta, vtkTable *outData) override
Execute the calculations required by the Assess option.
Definition: vtkDescriptiveStatistics.h:140
vtkStatisticsAlgorithm
Base class for statistics algorithms.
Definition: vtkStatisticsAlgorithm.h:71
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:59
vtkStatisticsAlgorithm::Test
virtual void Test(vtkTable *, vtkMultiBlockDataSet *, vtkTable *)=0
Execute the calculations required by the Test option.
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkTableAlgorithm::New
static vtkTableAlgorithm * New()