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
52 #ifndef vtkStatisticsAlgorithm_h
53 #define vtkStatisticsAlgorithm_h
54 
55 #include "vtkFiltersStatisticsModule.h" // For export macro
56 #include "vtkTableAlgorithm.h"
57 
58 VTK_ABI_NAMESPACE_BEGIN
61 class vtkStdString;
62 class vtkStringArray;
63 class vtkVariant;
64 class vtkVariantArray;
65 class vtkDoubleArray;
67 
68 class VTKFILTERSSTATISTICS_EXPORT vtkStatisticsAlgorithm : public vtkTableAlgorithm
69 {
70 public:
72  void PrintSelf(ostream& os, vtkIndent indent) override;
73 
78  {
79  INPUT_DATA = 0,
80  LEARN_PARAMETERS = 1,
81  INPUT_MODEL = 2
82  };
83 
88  {
89  OUTPUT_DATA = 0,
90  OUTPUT_MODEL = 1,
91  OUTPUT_TEST = 2
92  };
93 
99  {
101  }
102 
108  {
110  }
111 
117  {
119  }
120 
125  virtual void SetInputModel(vtkDataObject* model)
126  {
128  }
129 
131 
134  vtkSetMacro(LearnOption, bool);
135  vtkGetMacro(LearnOption, bool);
137 
139 
142  vtkSetMacro(DeriveOption, bool);
143  vtkGetMacro(DeriveOption, bool);
145 
147 
150  vtkSetMacro(AssessOption, bool);
151  vtkGetMacro(AssessOption, bool);
153 
155 
158  vtkSetMacro(TestOption, bool);
159  vtkGetMacro(TestOption, bool);
161 
163 
166  vtkSetMacro(NumberOfPrimaryTables, vtkIdType);
167  vtkGetMacro(NumberOfPrimaryTables, vtkIdType);
169 
171 
175  vtkGetObjectMacro(AssessNames, vtkStringArray);
177 
179 
183  {
184  public:
185  virtual void operator()(vtkDoubleArray*, vtkIdType) = 0;
186  virtual ~AssessFunctor() = default;
187  };
189 
203  virtual void SetColumnStatus(const char* namCol, int status);
204 
208  virtual void ResetAllColumnStates();
209 
214  virtual int RequestSelectedColumns();
215 
219  virtual void ResetRequests();
220 
229 
234 
248  virtual const char* GetColumnForRequest(vtkIdType r, vtkIdType c);
249 
250  virtual int GetColumnForRequest(vtkIdType r, vtkIdType c, vtkStdString& columnName);
251 
259  void AddColumn(const char* namCol);
260 
271  void AddColumnPair(const char* namColX, const char* namColY);
272 
280  virtual bool SetParameter(const char* parameter, int index, vtkVariant value);
281 
286 
287 protected:
290 
293 
295 
299  virtual void Learn(vtkTable*, vtkTable*, vtkMultiBlockDataSet*) = 0;
300 
304  virtual void Derive(vtkMultiBlockDataSet*) = 0;
305 
310 
315 
319  virtual void Test(vtkTable*, vtkMultiBlockDataSet*, vtkTable*) = 0;
320 
324  virtual void SelectAssessFunctor(
325  vtkTable* outData, vtkDataObject* inMeta, vtkStringArray* rowNames, AssessFunctor*& dfunc) = 0;
326 
334 
335 private:
337  void operator=(const vtkStatisticsAlgorithm&) = delete;
338 };
339 
340 VTK_ABI_NAMESPACE_END
341 #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:64
dynamic, self-adjusting array of double
a simple class to control print indentation
Definition: vtkIndent.h:38
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.
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 const char * GetColumnForRequest(vtkIdType r, vtkIdType c)
Provide the name of the c-th column for the r-th request.
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:38
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:68
An array holding vtkVariants.
A type representing the union of many types.
Definition: vtkVariant.h:62
@ info
Definition: vtkX3D.h:376
@ value
Definition: vtkX3D.h:220
@ port
Definition: vtkX3D.h:447
@ parameter
Definition: vtkX3D.h:443
@ index
Definition: vtkX3D.h:246
int vtkIdType
Definition: vtkType.h:315