VTK: Filters/Statistics/vtkOrderStatistics.h Source File

| VTK 9.3.1

vtkOrderStatistics.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-FileCopyrightText: Copyright 2011 Sandia Corporation
3 // SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
33 #ifndef vtkOrderStatistics_h
34 #define vtkOrderStatistics_h
35
36 #include "vtkFiltersStatisticsModule.h" // For export macro
37 #include "vtkStatisticsAlgorithm.h"
38
39 VTK_ABI_NAMESPACE_BEGIN
40 class vtkMultiBlockDataSet;
41 class vtkStringArray;
42 class vtkTable;
43 class vtkVariant;
44
45 class VTKFILTERSSTATISTICS_EXPORT vtkOrderStatistics : public vtkStatisticsAlgorithm
46 {
47 public:
48 vtkTypeMacro(vtkOrderStatistics, vtkStatisticsAlgorithm);
49 void PrintSelf(ostream& os, vtkIndent indent) override;
50 static vtkOrderStatistics* New();
51
55 enum QuantileDefinitionType
56 {
57 InverseCDF = 0, // Identical to method 1 of R
58 InverseCDFAveragedSteps = 1, // Identical to method 2 of R, ignored for non-numeric types
59 NearestObservation = 2 // Identical to method 3 of R
60 };
61
63
66 vtkSetMacro(NumberOfIntervals, vtkIdType);
67 vtkGetMacro(NumberOfIntervals, vtkIdType);
69
71
74 vtkSetMacro(QuantileDefinition, QuantileDefinitionType);
75 void SetQuantileDefinition(int);
77
79
82 vtkSetMacro(Quantize, bool);
83 vtkGetMacro(Quantize, bool);
85
87
91 vtkSetMacro(MaximumHistogramSize, vtkIdType);
92 vtkGetMacro(MaximumHistogramSize, vtkIdType);
94
98 vtkIdType GetQuantileDefinition() { return static_cast<vtkIdType>(this->QuantileDefinition); }
99
105 bool SetParameter(const char* parameter, int index, vtkVariant value) override;
106
111 void Aggregate(vtkDataObjectCollection*, vtkMultiBlockDataSet*) override {}
112
114
124 vtkSetMacro(GhostsToSkip, unsigned char);
125 vtkGetMacro(GhostsToSkip, unsigned char);
127
128 protected:
129 vtkOrderStatistics();
130 ~vtkOrderStatistics() override;
131
132 int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
133
137 void Learn(vtkTable*, vtkTable*, vtkMultiBlockDataSet*) override;
138
142 void Derive(vtkMultiBlockDataSet*) override;
143
147 void Test(vtkTable*, vtkMultiBlockDataSet*, vtkTable*) override;
148
152 void Assess(vtkTable* inData, vtkMultiBlockDataSet* inMeta, vtkTable* outData) override
153 {
154 this->Superclass::Assess(inData, inMeta, outData, 1);
155 }
156
160 void SelectAssessFunctor(vtkTable* outData, vtkDataObject* inMeta, vtkStringArray* rowNames,
161 AssessFunctor*& dfunc) override;
162
163 vtkIdType NumberOfIntervals;
164 QuantileDefinitionType QuantileDefinition;
165 bool Quantize;
166 vtkIdType MaximumHistogramSize;
167 vtkIdType NumberOfGhosts;
168 unsigned char GhostsToSkip;
169
170 private:
171 vtkOrderStatistics(const vtkOrderStatistics&) = delete;
172 void operator=(const vtkOrderStatistics&) = delete;
173 };
174
175 VTK_ABI_NAMESPACE_END
176 #endif
vtkDataObjectCollection
maintain an unordered list of data objects
Definition: vtkDataObjectCollection.h:21
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:64
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
vtkOrderStatistics
A class for univariate order statistics.
Definition: vtkOrderStatistics.h:46
vtkOrderStatistics::Learn
void Learn(vtkTable *, vtkTable *, vtkMultiBlockDataSet *) override
Execute the calculations required by the Learn option.
vtkOrderStatistics::MaximumHistogramSize
vtkIdType MaximumHistogramSize
Definition: vtkOrderStatistics.h:166
vtkOrderStatistics::SetParameter
bool SetParameter(const char *parameter, int index, vtkVariant value) override
A convenience method (in particular for access from other applications) to set parameter values.
vtkOrderStatistics::GetQuantileDefinition
vtkIdType GetQuantileDefinition()
Get the quantile definition.
Definition: vtkOrderStatistics.h:98
vtkOrderStatistics::Derive
void Derive(vtkMultiBlockDataSet *) override
Execute the calculations required by the Derive option.
vtkOrderStatistics::GhostsToSkip
unsigned char GhostsToSkip
Definition: vtkOrderStatistics.h:168
vtkOrderStatistics::NumberOfGhosts
vtkIdType NumberOfGhosts
Definition: vtkOrderStatistics.h:167
vtkOrderStatistics::New
static vtkOrderStatistics * New()
vtkOrderStatistics::Test
void Test(vtkTable *, vtkMultiBlockDataSet *, vtkTable *) override
Execute the calculations required by the Test option.
vtkOrderStatistics::Aggregate
void Aggregate(vtkDataObjectCollection *, vtkMultiBlockDataSet *) override
Given a collection of models, calculate aggregate model NB: not implemented.
Definition: vtkOrderStatistics.h:111
vtkOrderStatistics::Quantize
bool Quantize
Definition: vtkOrderStatistics.h:165
vtkOrderStatistics::Assess
void Assess(vtkTable *inData, vtkMultiBlockDataSet *inMeta, vtkTable *outData) override
Execute the calculations required by the Assess option.
Definition: vtkOrderStatistics.h:152
vtkOrderStatistics::QuantileDefinitionType
QuantileDefinitionType
The type of quantile definition.
Definition: vtkOrderStatistics.h:56
vtkOrderStatistics::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkOrderStatistics::QuantileDefinition
QuantileDefinitionType QuantileDefinition
Definition: vtkOrderStatistics.h:164
vtkOrderStatistics::SetQuantileDefinition
void SetQuantileDefinition(int)
Set the quantile definition.
vtkOrderStatistics::~vtkOrderStatistics
~vtkOrderStatistics() override
vtkOrderStatistics::SelectAssessFunctor
void SelectAssessFunctor(vtkTable *outData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc) override
Provide the appropriate assessment functor.
vtkOrderStatistics::NumberOfIntervals
vtkIdType NumberOfIntervals
Definition: vtkOrderStatistics.h:163
vtkOrderStatistics::RequestData
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
vtkOrderStatistics::vtkOrderStatistics
vtkOrderStatistics()
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
vtkX3D::value
@ value
Definition: vtkX3D.h:220
vtkX3D::parameter
@ parameter
Definition: vtkX3D.h:443
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkStatisticsAlgorithm.h
vtkIdType
int vtkIdType
Definition: vtkType.h:315