VTK  9.1.0
vtkOrderStatistics.h
Go to the documentation of this file.
1/*=========================================================================
2
3Program: Visualization Toolkit
4Module: vtkOrderStatistics.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 2011 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 -------------------------------------------------------------------------*/
43#ifndef vtkOrderStatistics_h
44#define vtkOrderStatistics_h
45
46#include "vtkFiltersStatisticsModule.h" // For export macro
48
50class vtkStringArray;
51class vtkTable;
52class vtkVariant;
53
54class VTKFILTERSSTATISTICS_EXPORT vtkOrderStatistics : public vtkStatisticsAlgorithm
55{
56public:
58 void PrintSelf(ostream& os, vtkIndent indent) override;
60
65 {
66 InverseCDF = 0, // Identical to method 1 of R
67 InverseCDFAveragedSteps = 1, // Identical to method 2 of R, ignored for non-numeric types
68 NearestObservation = 2 // Identical to method 3 of R
69 };
70
72
75 vtkSetMacro(NumberOfIntervals, vtkIdType);
76 vtkGetMacro(NumberOfIntervals, vtkIdType);
78
80
83 vtkSetMacro(QuantileDefinition, QuantileDefinitionType);
86
88
91 vtkSetMacro(Quantize, bool);
92 vtkGetMacro(Quantize, bool);
94
96
100 vtkSetMacro(MaximumHistogramSize, vtkIdType);
101 vtkGetMacro(MaximumHistogramSize, vtkIdType);
103
107 vtkIdType GetQuantileDefinition() { return static_cast<vtkIdType>(this->QuantileDefinition); }
108
114 bool SetParameter(const char* parameter, int index, vtkVariant value) override;
115
121
122protected:
125
130
135
140
144 void Assess(vtkTable* inData, vtkMultiBlockDataSet* inMeta, vtkTable* outData) override
145 {
146 this->Superclass::Assess(inData, inMeta, outData, 1);
147 }
148
152 void SelectAssessFunctor(vtkTable* outData, vtkDataObject* inMeta, vtkStringArray* rowNames,
153 AssessFunctor*& dfunc) override;
154
159
160private:
161 vtkOrderStatistics(const vtkOrderStatistics&) = delete;
162 void operator=(const vtkOrderStatistics&) = delete;
163};
164
165#endif
maintain an unordered list of data objects
general representation of visualization data
a simple class to control print indentation
Definition: vtkIndent.h:113
Composite dataset that organizes datasets into blocks.
A class for univariate order statistics.
void Learn(vtkTable *, vtkTable *, vtkMultiBlockDataSet *) override
Execute the calculations required by the Learn option.
bool SetParameter(const char *parameter, int index, vtkVariant value) override
A convenience method (in particular for access from other applications) to set parameter values.
vtkIdType GetQuantileDefinition()
Get the quantile definition.
void Derive(vtkMultiBlockDataSet *) override
Execute the calculations required by the Derive option.
static vtkOrderStatistics * New()
void Test(vtkTable *, vtkMultiBlockDataSet *, vtkTable *) override
Execute the calculations required by the Test option.
void Aggregate(vtkDataObjectCollection *, vtkMultiBlockDataSet *) override
Given a collection of models, calculate aggregate model NB: not implemented.
void Assess(vtkTable *inData, vtkMultiBlockDataSet *inMeta, vtkTable *outData) override
Execute the calculations required by the Assess option.
QuantileDefinitionType
The type of quantile definition.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
QuantileDefinitionType QuantileDefinition
void SetQuantileDefinition(int)
Set the quantile definition.
~vtkOrderStatistics() override
void SelectAssessFunctor(vtkTable *outData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc) override
Provide the appropriate assessment functor.
A base class for a functor that assesses data.
Base class for statistics algorithms.
a vtkAbstractArray subclass for strings
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:172
A atomic type representing the union of many types.
Definition: vtkVariant.h:145
int vtkIdType
Definition: vtkType.h:332