VTK  9.1.0
vtkStatisticsAlgorithm.h
Go to the documentation of this file.
1/*=========================================================================
2
3Program: Visualization Toolkit
4Module: vtkStatisticsAlgorithm.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 -------------------------------------------------------------------------*/
56#ifndef vtkStatisticsAlgorithm_h
57#define vtkStatisticsAlgorithm_h
58
59#include "vtkFiltersStatisticsModule.h" // For export macro
60#include "vtkTableAlgorithm.h"
61
64class vtkStdString;
65class vtkStringArray;
66class vtkVariant;
67class vtkVariantArray;
68class vtkDoubleArray;
70
71class VTKFILTERSSTATISTICS_EXPORT vtkStatisticsAlgorithm : public vtkTableAlgorithm
72{
73public:
75 void PrintSelf(ostream& os, vtkIndent indent) override;
76
81 {
82 INPUT_DATA = 0,
83 LEARN_PARAMETERS = 1,
84 INPUT_MODEL = 2
85 };
86
91 {
92 OUTPUT_DATA = 0,
93 OUTPUT_MODEL = 1,
94 OUTPUT_TEST = 2
95 };
96
102 {
104 }
105
111 {
113 }
114
120 {
122 }
123
128 virtual void SetInputModel(vtkDataObject* model)
129 {
131 }
132
134
137 vtkSetMacro(LearnOption, bool);
138 vtkGetMacro(LearnOption, bool);
140
142
145 vtkSetMacro(DeriveOption, bool);
146 vtkGetMacro(DeriveOption, bool);
148
150
153 vtkSetMacro(AssessOption, bool);
154 vtkGetMacro(AssessOption, bool);
156
158
161 vtkSetMacro(TestOption, bool);
162 vtkGetMacro(TestOption, bool);
164
166
169 vtkSetMacro(NumberOfPrimaryTables, vtkIdType);
170 vtkGetMacro(NumberOfPrimaryTables, vtkIdType);
172
174
178 vtkGetObjectMacro(AssessNames, vtkStringArray);
180
182
186 {
187 public:
189 virtual ~AssessFunctor() = default;
190 };
192
206 virtual void SetColumnStatus(const char* namCol, int status);
207
211 virtual void ResetAllColumnStates();
212
218
222 virtual void ResetRequests();
223
232
237
251 virtual const char* GetColumnForRequest(vtkIdType r, vtkIdType c);
252
253 virtual int GetColumnForRequest(vtkIdType r, vtkIdType c, vtkStdString& columnName);
254
262 void AddColumn(const char* namCol);
263
274 void AddColumnPair(const char* namColX, const char* namColY);
275
283 virtual bool SetParameter(const char* parameter, int index, vtkVariant value);
284
289
290protected:
293
294 int FillInputPortInformation(int port, vtkInformation* info) override;
295 int FillOutputPortInformation(int port, vtkInformation* info) override;
296
298
303
307 virtual void Derive(vtkMultiBlockDataSet*) = 0;
308
313
318
323
328 vtkTable* outData, vtkDataObject* inMeta, vtkStringArray* rowNames, AssessFunctor*& dfunc) = 0;
329
337
338private:
340 void operator=(const vtkStatisticsAlgorithm&) = delete;
341};
342
343#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
Definition: vtkDataObject.h:60
dynamic, self-adjusting array of double
a simple class to control print indentation
Definition: vtkIndent.h:34
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.
Definition: vtkStdString.h:36
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:63
An array holding vtkVariants.
A atomic type representing the union of many types.
Definition: vtkVariant.h:66
int vtkIdType
Definition: vtkType.h:332