VTK  9.2.5
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 -------------------------------------------------------------------------*/
49#ifndef vtkOrderStatistics_h
50#define vtkOrderStatistics_h
51
52#include "vtkFiltersStatisticsModule.h" // For export macro
54
56class vtkStringArray;
57class vtkTable;
58class vtkVariant;
59
60class VTKFILTERSSTATISTICS_EXPORT vtkOrderStatistics : public vtkStatisticsAlgorithm
61{
62public:
64 void PrintSelf(ostream& os, vtkIndent indent) override;
66
71 {
72 InverseCDF = 0, // Identical to method 1 of R
73 InverseCDFAveragedSteps = 1, // Identical to method 2 of R, ignored for non-numeric types
74 NearestObservation = 2 // Identical to method 3 of R
75 };
76
78
81 vtkSetMacro(NumberOfIntervals, vtkIdType);
82 vtkGetMacro(NumberOfIntervals, vtkIdType);
84
86
89 vtkSetMacro(QuantileDefinition, QuantileDefinitionType);
92
94
97 vtkSetMacro(Quantize, bool);
98 vtkGetMacro(Quantize, bool);
100
102
106 vtkSetMacro(MaximumHistogramSize, vtkIdType);
107 vtkGetMacro(MaximumHistogramSize, vtkIdType);
109
113 vtkIdType GetQuantileDefinition() { return static_cast<vtkIdType>(this->QuantileDefinition); }
114
120 bool SetParameter(const char* parameter, int index, vtkVariant value) override;
121
127
129
139 vtkSetMacro(GhostsToSkip, unsigned char);
140 vtkGetMacro(GhostsToSkip, unsigned char);
142
143protected:
146
148
153
158
163
167 void Assess(vtkTable* inData, vtkMultiBlockDataSet* inMeta, vtkTable* outData) override
168 {
169 this->Superclass::Assess(inData, inMeta, outData, 1);
170 }
171
175 void SelectAssessFunctor(vtkTable* outData, vtkDataObject* inMeta, vtkStringArray* rowNames,
176 AssessFunctor*& dfunc) override;
177
183 unsigned char GhostsToSkip;
184
185private:
186 vtkOrderStatistics(const vtkOrderStatistics&) = delete;
187 void operator=(const vtkOrderStatistics&) = delete;
188};
189
190#endif
maintain an unordered list of data objects
general representation of visualization data
Definition: vtkDataObject.h:66
a simple class to control print indentation
Definition: vtkIndent.h:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
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.
unsigned char GhostsToSkip
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.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
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:74
A atomic type representing the union of many types.
Definition: vtkVariant.h:70
int vtkIdType
Definition: vtkType.h:332