VTK
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  vtkMultiBlockDataSet* ) override;
117 
118 protected:
120  ~vtkDescriptiveStatistics() override;
121 
126  void Learn( vtkTable*,
127  vtkTable*,
128  vtkMultiBlockDataSet* ) override;
129 
133  void Derive( vtkMultiBlockDataSet* ) override;
134 
138  void Test( vtkTable*,
140  vtkTable* ) override;
141 
145  void Assess( vtkTable* inData,
146  vtkMultiBlockDataSet* inMeta,
147  vtkTable* outData ) override
148  { this->Superclass::Assess( inData, inMeta, outData, 1 ); }
149 
154  virtual vtkDoubleArray* CalculatePValues(vtkDoubleArray*);
155 
159  void SelectAssessFunctor( vtkTable* outData,
160  vtkDataObject* inMeta,
161  vtkStringArray* rowNames,
162  AssessFunctor*& dfunc ) override;
163 
168 
169 private:
171  void operator = ( const vtkDescriptiveStatistics& ) = delete;
172 };
173 
174 #endif
vtkStatisticsAlgorithm.h
vtkDescriptiveStatistics::G2Kurtosis
vtkTypeBool G2Kurtosis
Definition: vtkDescriptiveStatistics.h:166
vtkDataObjectCollection
maintain an unordered list of data objects
Definition: vtkDataObjectCollection.h:31
vtkDescriptiveStatistics::SignedDeviations
vtkTypeBool SignedDeviations
Definition: vtkDescriptiveStatistics.h:167
vtkDescriptiveStatistics::G1Skewness
vtkTypeBool G1Skewness
Definition: vtkDescriptiveStatistics.h:165
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:164
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:145
vtkStatisticsAlgorithm
Base class for statistics algorithms.
Definition: vtkStatisticsAlgorithm.h:71
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:58
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()