VTK: Filters/Statistics/vtkMultiCorrelativeStatistics.h Source File

| VTK 9.3.1

vtkMultiCorrelativeStatistics.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
65 #ifndef vtkMultiCorrelativeStatistics_h
66 #define vtkMultiCorrelativeStatistics_h
67
68 #include "vtkFiltersStatisticsModule.h" // For export macro
69 #include "vtkStatisticsAlgorithm.h"
70
71 VTK_ABI_NAMESPACE_BEGIN
72 class vtkDoubleArray;
73 class vtkMultiBlockDataSet;
74 class vtkOrderStatistics;
75 class vtkVariant;
76
77 class VTKFILTERSSTATISTICS_EXPORT vtkMultiCorrelativeStatistics : public vtkStatisticsAlgorithm
78 {
79 public:
80 vtkTypeMacro(vtkMultiCorrelativeStatistics, vtkStatisticsAlgorithm);
81 void PrintSelf(ostream& os, vtkIndent indent) override;
82 static vtkMultiCorrelativeStatistics* New();
83
87 void Aggregate(vtkDataObjectCollection*, vtkMultiBlockDataSet*) override;
88
90
95 vtkSetMacro(MedianAbsoluteDeviation, bool);
96 vtkGetMacro(MedianAbsoluteDeviation, bool);
97 vtkBooleanMacro(MedianAbsoluteDeviation, bool);
99
101
110 vtkSetMacro(GhostsToSkip, unsigned char);
111 vtkGetMacro(GhostsToSkip, unsigned char);
113
114 protected:
115 vtkMultiCorrelativeStatistics();
116 ~vtkMultiCorrelativeStatistics() override;
117
118 int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
119
123 void Learn(vtkTable*, vtkTable*, vtkMultiBlockDataSet*) override;
124
128 void Derive(vtkMultiBlockDataSet*) override;
129
133 void Assess(vtkTable*, vtkMultiBlockDataSet*, vtkTable*) override;
134
138 void Test(vtkTable*, vtkMultiBlockDataSet*, vtkTable*) override {}
139
143 void SelectAssessFunctor(vtkTable* inData, vtkDataObject* inMeta, vtkStringArray* rowNames,
144 AssessFunctor*& dfunc) override;
145
149 virtual void ComputeMedian(vtkTable* inData, vtkTable* outData);
150
155 virtual vtkOrderStatistics* CreateOrderStatisticsInstance();
156
157 bool MedianAbsoluteDeviation;
158
162 vtkIdType NumberOfGhosts;
163
164 unsigned char GhostsToSkip;
165
166 private:
167 vtkMultiCorrelativeStatistics(const vtkMultiCorrelativeStatistics&) = delete;
168 void operator=(const vtkMultiCorrelativeStatistics&) = delete;
169 };
170
171 VTK_ABI_NAMESPACE_END
172 #endif
vtkDataObjectCollection
maintain an unordered list of data objects
Definition: vtkDataObjectCollection.h:21
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:64
vtkDoubleArray
dynamic, self-adjusting array of double
Definition: vtkDoubleArray.h:40
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:38
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:40
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:72
vtkMultiBlockDataSet
Composite dataset that organizes datasets into blocks.
Definition: vtkMultiBlockDataSet.h:50
vtkMultiCorrelativeStatistics
A class for multivariate linear correlation.
Definition: vtkMultiCorrelativeStatistics.h:78
vtkMultiCorrelativeStatistics::Derive
void Derive(vtkMultiBlockDataSet *) override
Execute the calculations required by the Derive option.
vtkMultiCorrelativeStatistics::MedianAbsoluteDeviation
bool MedianAbsoluteDeviation
Definition: vtkMultiCorrelativeStatistics.h:157
vtkMultiCorrelativeStatistics::~vtkMultiCorrelativeStatistics
~vtkMultiCorrelativeStatistics() override
vtkMultiCorrelativeStatistics::Assess
void Assess(vtkTable *, vtkMultiBlockDataSet *, vtkTable *) override
Execute the calculations required by the Assess option.
vtkMultiCorrelativeStatistics::CreateOrderStatisticsInstance
virtual vtkOrderStatistics * CreateOrderStatisticsInstance()
Return a new vtkOrderStatistics instance.
vtkMultiCorrelativeStatistics::vtkMultiCorrelativeStatistics
vtkMultiCorrelativeStatistics()
vtkMultiCorrelativeStatistics::Learn
void Learn(vtkTable *, vtkTable *, vtkMultiBlockDataSet *) override
Execute the calculations required by the Learn option.
vtkMultiCorrelativeStatistics::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkMultiCorrelativeStatistics::Aggregate
void Aggregate(vtkDataObjectCollection *, vtkMultiBlockDataSet *) override
Given a collection of models, calculate aggregate model.
vtkMultiCorrelativeStatistics::Test
void Test(vtkTable *, vtkMultiBlockDataSet *, vtkTable *) override
Execute the calculations required by the Test option.
Definition: vtkMultiCorrelativeStatistics.h:138
vtkMultiCorrelativeStatistics::New
static vtkMultiCorrelativeStatistics * New()
vtkMultiCorrelativeStatistics::NumberOfGhosts
vtkIdType NumberOfGhosts
Storing the number of ghosts in the input to avoid computing this value multiple times.
Definition: vtkMultiCorrelativeStatistics.h:162
vtkMultiCorrelativeStatistics::RequestData
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
vtkMultiCorrelativeStatistics::GhostsToSkip
unsigned char GhostsToSkip
Definition: vtkMultiCorrelativeStatistics.h:164
vtkMultiCorrelativeStatistics::SelectAssessFunctor
void SelectAssessFunctor(vtkTable *inData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc) override
Provide the appropriate assessment functor.
vtkMultiCorrelativeStatistics::ComputeMedian
virtual void ComputeMedian(vtkTable *inData, vtkTable *outData)
Computes the median of inData with vtkOrderStatistics.
vtkOrderStatistics
A class for univariate order statistics.
Definition: vtkOrderStatistics.h:46
vtkStatisticsAlgorithm::AssessFunctor
A base class for a functor that assesses data.
Definition: vtkStatisticsAlgorithm.h:183
vtkStatisticsAlgorithm
Base class for statistics algorithms.
Definition: vtkStatisticsAlgorithm.h:69
vtkStringArray
a vtkAbstractArray subclass for strings
Definition: vtkStringArray.h:41
vtkTable
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:68
vtkVariant
A type representing the union of many types.
Definition: vtkVariant.h:62
vtkStatisticsAlgorithm.h
vtkIdType
int vtkIdType
Definition: vtkType.h:315