VTK
vtkStatisticsAlgorithm.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3 Program: Visualization Toolkit
4 Module: vtkStatisticsAlgorithm.h
5 
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. 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 
64 class vtkStdString;
65 class vtkStringArray;
66 class vtkVariant;
67 class vtkVariantArray;
68 class vtkDoubleArray;
70 
71 class VTKFILTERSSTATISTICS_EXPORT vtkStatisticsAlgorithm : public vtkTableAlgorithm
72 {
73 public:
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 
103 
108  virtual void SetLearnOptionParameters( vtkDataObject* params )
110 
117 
122  virtual void SetInputModel( vtkDataObject* model )
124 
126 
129  vtkSetMacro( LearnOption, bool );
130  vtkGetMacro( LearnOption, bool );
132 
134 
137  vtkSetMacro( DeriveOption, bool );
138  vtkGetMacro( DeriveOption, bool );
140 
142 
145  vtkSetMacro( AssessOption, bool );
146  vtkGetMacro( AssessOption, bool );
148 
150 
153  vtkSetMacro( TestOption, bool );
154  vtkGetMacro( TestOption, bool );
156 
158 
161  vtkSetMacro( NumberOfPrimaryTables, vtkIdType );
162  vtkGetMacro( NumberOfPrimaryTables, vtkIdType );
164 
166 
169  virtual void SetAssessNames( vtkStringArray* );
170  vtkGetObjectMacro(AssessNames,vtkStringArray);
172 
174 
178  public:
179  virtual void operator() ( vtkDoubleArray*,
180  vtkIdType ) = 0;
181  virtual ~AssessFunctor() { }
182  };
184 
198  virtual void SetColumnStatus( const char* namCol, int status );
199 
203  virtual void ResetAllColumnStates();
204 
209  virtual int RequestSelectedColumns();
210 
214  virtual void ResetRequests();
215 
223  virtual vtkIdType GetNumberOfRequests();
224 
228  virtual vtkIdType GetNumberOfColumnsForRequest( vtkIdType request );
229 
243  virtual const char* GetColumnForRequest( vtkIdType r, vtkIdType c );
244 
245  virtual int GetColumnForRequest( vtkIdType r, vtkIdType c, vtkStdString& columnName );
246 
254  void AddColumn( const char* namCol );
255 
266  void AddColumnPair( const char* namColX, const char* namColY );
267 
275  virtual bool SetParameter( const char* parameter,
276  int index,
277  vtkVariant value );
278 
282  virtual void Aggregate( vtkDataObjectCollection*,
283  vtkMultiBlockDataSet* ) = 0;
284 
285 protected:
287  ~vtkStatisticsAlgorithm() override;
288 
289  int FillInputPortInformation( int port, vtkInformation* info ) override;
290  int FillOutputPortInformation( int port, vtkInformation* info ) override;
291 
292  int RequestData(
295  vtkInformationVector* ) override;
296 
300  virtual void Learn( vtkTable*,
301  vtkTable*,
302  vtkMultiBlockDataSet* ) = 0;
303 
307  virtual void Derive( vtkMultiBlockDataSet* ) = 0;
308 
312  virtual void Assess( vtkTable*,
314  vtkTable* ) = 0;
315 
319  void Assess( vtkTable*,
321  vtkTable*,
322  int );
323 
327  virtual void Test( vtkTable*,
329  vtkTable* ) = 0;
330 
334  virtual void SelectAssessFunctor( vtkTable* outData,
335  vtkDataObject* inMeta,
336  vtkStringArray* rowNames,
337  AssessFunctor*& dfunc ) = 0;
338 
346 
347 private:
349  void operator=(const vtkStatisticsAlgorithm&) = delete;
350 };
351 
352 #endif
vtkTableAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkStatisticsAlgorithm::SetInputModel
virtual void SetInputModel(vtkDataObject *model)
A convenience method for setting the input model (if one is expected or allowed).
Definition: vtkStatisticsAlgorithm.h:122
vtkStatisticsAlgorithm::SetLearnOptionParameters
virtual void SetLearnOptionParameters(vtkDataObject *params)
A convenience method for setting learn input parameters (if one is expected or allowed).
Definition: vtkStatisticsAlgorithm.h:108
vtkX3D::value
Definition: vtkX3D.h:220
vtkStatisticsAlgorithmPrivate
Definition: vtkStatisticsAlgorithmPrivate.h:41
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkDataObjectCollection
maintain an unordered list of data objects
Definition: vtkDataObjectCollection.h:31
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:35
vtkTable
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:62
vtkStatisticsAlgorithm::TestOption
bool TestOption
Definition: vtkStatisticsAlgorithm.h:343
vtkVariantArray
An array holding vtkVariants.
Definition: vtkVariantArray.h:43
vtkStatisticsAlgorithm::SetInputModelConnection
virtual void SetInputModelConnection(vtkAlgorithmOutput *model)
A convenience method for setting the input model connection (if one is expected or allowed).
Definition: vtkStatisticsAlgorithm.h:115
vtkStatisticsAlgorithm::AssessFunctor
A base class for a functor that assesses data.
Definition: vtkStatisticsAlgorithm.h:177
vtkMultiBlockDataSet
Composite dataset that organizes datasets into blocks.
Definition: vtkMultiBlockDataSet.h:45
vtkStatisticsAlgorithm::LEARN_PARAMETERS
Port 1 is for learn parameters (initial guesses, etc.)
Definition: vtkStatisticsAlgorithm.h:83
vtkStatisticsAlgorithm::LearnOption
bool LearnOption
Definition: vtkStatisticsAlgorithm.h:340
vtkX3D::port
Definition: vtkX3D.h:447
vtkStatisticsAlgorithm::AssessFunctor::~AssessFunctor
virtual ~AssessFunctor()
Definition: vtkStatisticsAlgorithm.h:181
vtkStatisticsAlgorithm::INPUT_MODEL
Port 2 is for a priori models.
Definition: vtkStatisticsAlgorithm.h:84
vtkTableAlgorithm
Superclass for algorithms that produce only vtkTables as output.
Definition: vtkTableAlgorithm.h:48
vtkStatisticsAlgorithm::AssessOption
bool AssessOption
Definition: vtkStatisticsAlgorithm.h:342
impl::Test
int Test(int argc, char *argv[], const char *dfile, const InitializationCallback &initCallback)
Definition: TestMotionFXCFGReaderCommon.h:108
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkVariant
A atomic type representing the union of many types.
Definition: vtkVariant.h:65
vtkTableAlgorithm::SetInputData
void SetInputData(vtkDataObject *obj)
Assign a data object as input.
Definition: vtkTableAlgorithm.h:73
vtkTableAlgorithm::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkStatisticsAlgorithm::AssessNames
vtkStringArray * AssessNames
Definition: vtkStatisticsAlgorithm.h:344
vtkAlgorithm::SetInputConnection
virtual void SetInputConnection(int port, vtkAlgorithmOutput *input)
Set the connection for the given input port index.
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:80
vtkX3D::info
Definition: vtkX3D.h:376
vtkStatisticsAlgorithm::Internals
vtkStatisticsAlgorithmPrivate * Internals
Definition: vtkStatisticsAlgorithm.h:345
vtkAlgorithmOutput
Proxy object to connect input/output ports.
Definition: vtkAlgorithmOutput.h:36
vtkStatisticsAlgorithm::NumberOfPrimaryTables
vtkIdType NumberOfPrimaryTables
Definition: vtkStatisticsAlgorithm.h:339
vtkStringArray
a vtkAbstractArray subclass for strings
Definition: vtkStringArray.h:36
vtkStatisticsAlgorithm::SetLearnOptionParameterConnection
virtual void SetLearnOptionParameterConnection(vtkAlgorithmOutput *params)
A convenience method for setting learn input parameters (if one is expected or allowed).
Definition: vtkStatisticsAlgorithm.h:101
vtkTableAlgorithm.h
vtkDoubleArray
dynamic, self-adjusting array of double
Definition: vtkDoubleArray.h:35
vtkStatisticsAlgorithm::InputPorts
InputPorts
enumeration values to specify input port types
Definition: vtkStatisticsAlgorithm.h:80
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:34
vtkStatisticsAlgorithm
Base class for statistics algorithms.
Definition: vtkStatisticsAlgorithm.h:71
vtkX3D::parameter
Definition: vtkX3D.h:443
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:58
vtkStatisticsAlgorithm::DeriveOption
bool DeriveOption
Definition: vtkStatisticsAlgorithm.h:341
vtkTableAlgorithm::RequestData
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called by the superclass.
vtkX3D::index
Definition: vtkX3D.h:246
vtkStatisticsAlgorithm::OutputIndices
OutputIndices
enumeration values to specify output port types
Definition: vtkStatisticsAlgorithm.h:90
vtkTableAlgorithm::FillOutputPortInformation
int FillOutputPortInformation(int port, vtkInformation *info) override
Fill the output port information objects for this algorithm.