VTK
vtkTemporalStatistics.h
Go to the documentation of this file.
1 // -*- c++ -*-
2 /*=========================================================================
3 
4  Program: Visualization Toolkit
5  Module: vtkTemporalStatistics.h
6 
7  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
8  All rights reserved.
9  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
10 
11  This software is distributed WITHOUT ANY WARRANTY; without even
12  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
13  PURPOSE. See the above copyright notice for more information.
14 
15 =========================================================================*/
16 
17 /*
18  * Copyright 2008 Sandia Corporation.
19  * Under the terms of Contract DE-AC04-94AL85000, there is a non-exclusive
20  * license for use of this work by or on behalf of the
21  * U.S. Government. Redistribution and use in source and binary forms, with
22  * or without modification, are permitted provided that this Notice and any
23  * statement of authorship are reproduced on all copies.
24  */
25 
52 #ifndef vtkTemporalStatistics_h
53 #define vtkTemporalStatistics_h
54 
55 #include "vtkFiltersGeneralModule.h" // For export macro
57 
59 class vtkDataSet;
60 class vtkFieldData;
61 class vtkGraph;
62 
63 class VTKFILTERSGENERAL_EXPORT vtkTemporalStatistics : public vtkPassInputTypeAlgorithm
64 {
65 public:
67  static vtkTemporalStatistics *New();
68  void PrintSelf(ostream &os, vtkIndent indent) override;
69 
71 
75  vtkGetMacro(ComputeAverage, vtkTypeBool);
76  vtkSetMacro(ComputeAverage, vtkTypeBool);
77  vtkBooleanMacro(ComputeAverage, vtkTypeBool);
79 
81 
85  vtkGetMacro(ComputeMinimum, vtkTypeBool);
86  vtkSetMacro(ComputeMinimum, vtkTypeBool);
87  vtkBooleanMacro(ComputeMinimum, vtkTypeBool);
89 
91 
95  vtkGetMacro(ComputeMaximum, vtkTypeBool);
96  vtkSetMacro(ComputeMaximum, vtkTypeBool);
97  vtkBooleanMacro(ComputeMaximum, vtkTypeBool);
99 
100  // Definition:
101  // Turn on/off the computation of the standard deviation of the values over
102  // time. On by default. The resulting array names have "_stddev" appended to
103  // them.
104  vtkGetMacro(ComputeStandardDeviation, vtkTypeBool);
105  vtkSetMacro(ComputeStandardDeviation, vtkTypeBool);
106  vtkBooleanMacro(ComputeStandardDeviation, vtkTypeBool);
107 
108 protected:
110  ~vtkTemporalStatistics() override;
111 
116 
117  // Used when iterating the pipeline to keep track of which timestep we are on.
119 
120  int FillInputPortInformation(int port, vtkInformation *info) override;
121 
122  int RequestDataObject(vtkInformation *request,
123  vtkInformationVector **inputVector,
124  vtkInformationVector *outputVector) override;
125  int RequestInformation(vtkInformation *request,
126  vtkInformationVector **inputVector,
127  vtkInformationVector *outputVector) override;
128  int RequestUpdateExtent(vtkInformation *request,
129  vtkInformationVector **inputVector,
130  vtkInformationVector *outputVector) override;
131  int RequestData(vtkInformation *request,
132  vtkInformationVector **inputVector,
133  vtkInformationVector *outputVector) override;
134 
135  virtual void InitializeStatistics(vtkDataObject *input,
136  vtkDataObject *output);
137  virtual void InitializeStatistics(vtkDataSet *input, vtkDataSet *output);
138  virtual void InitializeStatistics(vtkGraph *input, vtkGraph *output);
139  virtual void InitializeStatistics(vtkCompositeDataSet *input,
140  vtkCompositeDataSet *output);
141  virtual void InitializeArrays(vtkFieldData *inFd, vtkFieldData *outFd);
142  virtual void InitializeArray(vtkDataArray *array, vtkFieldData *outFd);
143 
144  virtual void AccumulateStatistics(vtkDataObject *input,
145  vtkDataObject *output);
146  virtual void AccumulateStatistics(vtkDataSet *input, vtkDataSet *output);
147  virtual void AccumulateStatistics(vtkGraph *input, vtkGraph *output);
148  virtual void AccumulateStatistics(vtkCompositeDataSet *input,
149  vtkCompositeDataSet *output);
150  virtual void AccumulateArrays(vtkFieldData *inFd, vtkFieldData *outFd);
151 
152  virtual void PostExecute(vtkDataObject *input, vtkDataObject *output);
153  virtual void PostExecute(vtkDataSet *input, vtkDataSet *output);
154  virtual void PostExecute(vtkGraph *input, vtkGraph *output);
155  virtual void PostExecute(vtkCompositeDataSet *input,
156  vtkCompositeDataSet *output);
157  virtual void FinishArrays(vtkFieldData *inFd, vtkFieldData *outFd);
158 
159  virtual vtkDataArray *GetArray(vtkFieldData *fieldData,
160  vtkDataArray *inArray,
161  const char *nameSuffix);
162 
163 private:
165  void operator=(const vtkTemporalStatistics &) = delete;
166 
168 
173  bool GeneratedChangingTopologyWarning;
174 };
176 
177 #endif //_vtkTemporalStatistics_h
virtual int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called within ProcessRequest when a request asks for Information.
Superclass for algorithms that produce output of the same type as input.
Store vtkAlgorithm input/output information.
abstract class to specify dataset behavior
Definition: vtkDataSet.h:56
int vtkTypeBool
Definition: vtkABI.h:69
Base class for graph data types.
Definition: vtkGraph.h:281
abstract superclass for composite (multi-block or AMR) datasets
virtual int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called within ProcessRequest when each filter in the pipeline decides what portion of its inp...
a simple class to control print indentation
Definition: vtkIndent.h:33
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:48
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
virtual int RequestDataObject(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called within ProcessRequest to when a request asks the algorithm to create empty output data...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
Store zero or more vtkInformation instances.
Compute statistics of point or cell data as it changes over time.
general representation of visualization data
Definition: vtkDataObject.h:58
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called within ProcessRequest when a request asks the algorithm to do its work.
static vtkPassInputTypeAlgorithm * New()
represent and manipulate fields of data
Definition: vtkFieldData.h:53