VTK  9.3.0
vtkStatisticsAlgorithm.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
43#ifndef vtkStatisticsAlgorithm_h
44#define vtkStatisticsAlgorithm_h
45
46#include "vtkFiltersStatisticsModule.h" // For export macro
47#include "vtkTableAlgorithm.h"
48
49VTK_ABI_NAMESPACE_BEGIN
52class vtkStdString;
53class vtkStringArray;
54class vtkVariant;
55class vtkVariantArray;
56class vtkDoubleArray;
58
59class VTKFILTERSSTATISTICS_EXPORT vtkStatisticsAlgorithm : public vtkTableAlgorithm
60{
61public:
63 void PrintSelf(ostream& os, vtkIndent indent) override;
64
69 {
70 INPUT_DATA = 0,
71 LEARN_PARAMETERS = 1,
72 INPUT_MODEL = 2
73 };
74
79 {
80 OUTPUT_DATA = 0,
81 OUTPUT_MODEL = 1,
82 OUTPUT_TEST = 2
83 };
84
90 {
92 }
93
99 {
101 }
102
108 {
110 }
111
116 virtual void SetInputModel(vtkDataObject* model)
117 {
119 }
120
122
125 vtkSetMacro(LearnOption, bool);
126 vtkGetMacro(LearnOption, bool);
128
130
133 vtkSetMacro(DeriveOption, bool);
134 vtkGetMacro(DeriveOption, bool);
136
138
141 vtkSetMacro(AssessOption, bool);
142 vtkGetMacro(AssessOption, bool);
144
146
149 vtkSetMacro(TestOption, bool);
150 vtkGetMacro(TestOption, bool);
152
154
157 vtkSetMacro(NumberOfPrimaryTables, vtkIdType);
158 vtkGetMacro(NumberOfPrimaryTables, vtkIdType);
160
162
166 vtkGetObjectMacro(AssessNames, vtkStringArray);
168
170
174 {
175 public:
177 virtual ~AssessFunctor() = default;
178 };
180
194 virtual void SetColumnStatus(const char* namCol, int status);
195
199 virtual void ResetAllColumnStates();
200
206
210 virtual void ResetRequests();
211
220
225
239 virtual const char* GetColumnForRequest(vtkIdType r, vtkIdType c);
240
241 virtual int GetColumnForRequest(vtkIdType r, vtkIdType c, vtkStdString& columnName);
242
250 void AddColumn(const char* namCol);
251
262 void AddColumnPair(const char* namColX, const char* namColY);
263
271 virtual bool SetParameter(const char* parameter, int index, vtkVariant value);
272
277
278protected:
281
282 int FillInputPortInformation(int port, vtkInformation* info) override;
283 int FillOutputPortInformation(int port, vtkInformation* info) override;
284
286
291
295 virtual void Derive(vtkMultiBlockDataSet*) = 0;
296
301
306
311
316 vtkTable* outData, vtkDataObject* inMeta, vtkStringArray* rowNames, AssessFunctor*& dfunc) = 0;
317
325
326private:
328 void operator=(const vtkStatisticsAlgorithm&) = delete;
329};
330
331VTK_ABI_NAMESPACE_END
332#endif
Proxy object to connect input/output ports.
virtual void SetInputConnection(int port, vtkAlgorithmOutput *input)
Set the connection for the given input port index.
maintain an unordered list of data objects
general representation of visualization data
dynamic, self-adjusting array of double
a simple class to control print indentation
Definition vtkIndent.h:29
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Composite dataset that organizes datasets into blocks.
A base class for a functor that assesses data.
virtual void operator()(vtkDoubleArray *, vtkIdType)=0
Base class for statistics algorithms.
virtual void Assess(vtkTable *, vtkMultiBlockDataSet *, vtkTable *)=0
Execute the calculations required by the Assess option.
virtual void SetAssessNames(vtkStringArray *)
Set/get assessment names.
virtual void SetColumnStatus(const char *namCol, int status)
Add or remove a column from the current analysis request.
virtual int GetColumnForRequest(vtkIdType r, vtkIdType c, vtkStdString &columnName)
~vtkStatisticsAlgorithm() override
virtual void ResetAllColumnStates()
Set the status of each and every column in the current request to OFF (0).
virtual void SetInputModelConnection(vtkAlgorithmOutput *model)
A convenience method for setting the input model connection (if one is expected or allowed).
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
virtual const char * GetColumnForRequest(vtkIdType r, vtkIdType c)
Provide the name of the c-th column for the r-th request.
OutputIndices
enumeration values to specify output port types
virtual void ResetRequests()
Empty the list of current requests.
virtual void SelectAssessFunctor(vtkTable *outData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc)=0
A pure virtual method to select the appropriate assessment functor.
virtual vtkIdType GetNumberOfRequests()
Return the number of requests.
virtual void Aggregate(vtkDataObjectCollection *, vtkMultiBlockDataSet *)=0
Given a collection of models, calculate aggregate model.
void AddColumnPair(const char *namColX, const char *namColY)
Convenience method to create a request with a single column name pair (namColX, namColY) in a single ...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void Derive(vtkMultiBlockDataSet *)=0
Execute the calculations required by the Derive option.
virtual void SetLearnOptionParameterConnection(vtkAlgorithmOutput *params)
A convenience method for setting learn input parameters (if one is expected or allowed).
virtual void SetInputModel(vtkDataObject *model)
A convenience method for setting the input model (if one is expected or allowed).
vtkStatisticsAlgorithmPrivate * Internals
void AddColumn(const char *namCol)
Convenience method to create a request with a single column name namCol in a single call; this is the...
void Assess(vtkTable *, vtkMultiBlockDataSet *, vtkTable *, int)
A convenience implementation for generic assessment with variable number of variables.
virtual int RequestSelectedColumns()
Use the current column status values to produce a new request for statistics to be produced when Requ...
int FillOutputPortInformation(int port, vtkInformation *info) override
Fill the output port information objects for this algorithm.
virtual vtkIdType GetNumberOfColumnsForRequest(vtkIdType request)
Return the number of columns for a given request.
virtual bool SetParameter(const char *parameter, int index, vtkVariant value)
A convenience method (in particular for access from other applications) to set parameter values of Le...
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
virtual void Learn(vtkTable *, vtkTable *, vtkMultiBlockDataSet *)=0
Execute the calculations required by the Learn option, given some input Data.
virtual void SetLearnOptionParameters(vtkDataObject *params)
A convenience method for setting learn input parameters (if one is expected or allowed).
InputPorts
enumeration values to specify input port types
@ LEARN_PARAMETERS
Port 1 is for learn parameters (initial guesses, etc.)
@ INPUT_MODEL
Port 2 is for a priori models.
virtual void Test(vtkTable *, vtkMultiBlockDataSet *, vtkTable *)=0
Execute the calculations required by the Test option.
Wrapper around std::string to keep symbols short.
a vtkAbstractArray subclass for strings
Superclass for algorithms that produce only vtkTables as output.
void SetInputData(vtkDataObject *obj)
Assign a data object as input.
A table, which contains similar-typed columns of data.
Definition vtkTable.h:59
An array holding vtkVariants.
A type representing the union of many types.
Definition vtkVariant.h:53
int vtkIdType
Definition vtkType.h:315