VTK  9.0.20210301
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 
72  void PrintSelf(ostream& os, vtkIndent indent) override;
74 
76 
80  vtkGetMacro(ComputeAverage, vtkTypeBool);
81  vtkSetMacro(ComputeAverage, vtkTypeBool);
82  vtkBooleanMacro(ComputeAverage, vtkTypeBool);
84 
86 
90  vtkGetMacro(ComputeMinimum, vtkTypeBool);
91  vtkSetMacro(ComputeMinimum, vtkTypeBool);
92  vtkBooleanMacro(ComputeMinimum, vtkTypeBool);
94 
96 
100  vtkGetMacro(ComputeMaximum, vtkTypeBool);
101  vtkSetMacro(ComputeMaximum, vtkTypeBool);
102  vtkBooleanMacro(ComputeMaximum, vtkTypeBool);
104 
105  // Definition:
106  // Turn on/off the computation of the standard deviation of the values over
107  // time. On by default. The resulting array names have "_stddev" appended to
108  // them.
109  vtkGetMacro(ComputeStandardDeviation, vtkTypeBool);
110  vtkSetMacro(ComputeStandardDeviation, vtkTypeBool);
111  vtkBooleanMacro(ComputeStandardDeviation, vtkTypeBool);
112 
113 protected:
116 
121 
122  // Used when iterating the pipeline to keep track of which timestep we are on.
124 
126 
128  vtkInformationVector* outputVector) override;
130  vtkInformationVector* outputVector) override;
132  vtkInformationVector* outputVector) override;
133  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
134  vtkInformationVector* outputVector) override;
135 
136  virtual void InitializeStatistics(vtkDataObject* input, vtkDataObject* output);
137  virtual void InitializeStatistics(vtkDataSet* input, vtkDataSet* output);
138  virtual void InitializeStatistics(vtkGraph* input, vtkGraph* output);
140  virtual void InitializeArrays(vtkFieldData* inFd, vtkFieldData* outFd);
141  virtual void InitializeArray(vtkDataArray* array, vtkFieldData* outFd);
142 
143  virtual void AccumulateStatistics(vtkDataObject* input, vtkDataObject* output);
144  virtual void AccumulateStatistics(vtkDataSet* input, vtkDataSet* output);
145  virtual void AccumulateStatistics(vtkGraph* input, vtkGraph* output);
147  virtual void AccumulateArrays(vtkFieldData* inFd, vtkFieldData* outFd);
148 
149  virtual void PostExecute(vtkDataObject* input, vtkDataObject* output);
150  virtual void PostExecute(vtkDataSet* input, vtkDataSet* output);
151  virtual void PostExecute(vtkGraph* input, vtkGraph* output);
152  virtual void PostExecute(vtkCompositeDataSet* input, vtkCompositeDataSet* output);
153  virtual void FinishArrays(vtkFieldData* inFd, vtkFieldData* outFd);
154 
156  vtkFieldData* fieldData, vtkDataArray* inArray, const char* nameSuffix);
157 
158 private:
160  void operator=(const vtkTemporalStatistics&) = delete;
161 
163 
168  bool GeneratedChangingTopologyWarning;
170 };
171 
172 #endif //_vtkTemporalStatistics_h
vtkTemporalStatistics::PostExecute
virtual void PostExecute(vtkCompositeDataSet *input, vtkCompositeDataSet *output)
vtkPassInputTypeAlgorithm.h
vtkTemporalStatistics::vtkTemporalStatistics
vtkTemporalStatistics()
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:36
vtkTemporalStatistics::PostExecute
virtual void PostExecute(vtkDataObject *input, vtkDataObject *output)
vtkTemporalStatistics::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
vtkTemporalStatistics::InitializeStatistics
virtual void InitializeStatistics(vtkCompositeDataSet *input, vtkCompositeDataSet *output)
vtkTemporalStatistics::InitializeStatistics
virtual void InitializeStatistics(vtkGraph *input, vtkGraph *output)
vtkTemporalStatistics::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkTemporalStatistics::AccumulateStatistics
virtual void AccumulateStatistics(vtkGraph *input, vtkGraph *output)
vtkCompositeDataSet
abstract superclass for composite (multi-block or AMR) datasets
Definition: vtkCompositeDataSet.h:46
vtkTemporalStatistics::InitializeArray
virtual void InitializeArray(vtkDataArray *array, vtkFieldData *outFd)
vtkTemporalStatistics::RequestInformation
int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is called within ProcessRequest when a request asks for Information.
vtkTemporalStatistics::ComputeAverage
vtkTypeBool ComputeAverage
Definition: vtkTemporalStatistics.h:117
vtkFieldData
represent and manipulate fields of data
Definition: vtkFieldData.h:54
vtkTemporalStatistics::RequestDataObject
int RequestDataObject(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is called within ProcessRequest when a request asks the algorithm to create empty output data ob...
vtkX3D::port
@ port
Definition: vtkX3D.h:453
vtkTemporalStatistics::InitializeStatistics
virtual void InitializeStatistics(vtkDataSet *input, vtkDataSet *output)
vtkTemporalStatistics::PostExecute
virtual void PostExecute(vtkDataSet *input, vtkDataSet *output)
vtkTemporalStatistics::PostExecute
virtual void PostExecute(vtkGraph *input, vtkGraph *output)
vtkTemporalStatistics::CurrentTimeIndex
int CurrentTimeIndex
Definition: vtkTemporalStatistics.h:123
vtkTemporalStatistics::InitializeArrays
virtual void InitializeArrays(vtkFieldData *inFd, vtkFieldData *outFd)
vtkTemporalStatistics::ComputeStandardDeviation
vtkTypeBool ComputeStandardDeviation
Definition: vtkTemporalStatistics.h:120
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:34
vtkTemporalStatistics::FinishArrays
virtual void FinishArrays(vtkFieldData *inFd, vtkFieldData *outFd)
vtkTemporalStatistics::~vtkTemporalStatistics
~vtkTemporalStatistics() override
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:57
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:74
vtkX3D::info
@ info
Definition: vtkX3D.h:382
vtkTemporalStatistics::AccumulateArrays
virtual void AccumulateArrays(vtkFieldData *inFd, vtkFieldData *outFd)
vtkTemporalStatistics::AccumulateStatistics
virtual void AccumulateStatistics(vtkCompositeDataSet *input, vtkCompositeDataSet *output)
vtkTemporalStatistics::InitializeStatistics
virtual void InitializeStatistics(vtkDataObject *input, vtkDataObject *output)
vtkTemporalStatistics::New
static vtkTemporalStatistics * New()
vtkTemporalStatistics
Compute statistics of point or cell data as it changes over time.
Definition: vtkTemporalStatistics.h:64
vtkTemporalStatistics::AccumulateStatistics
virtual void AccumulateStatistics(vtkDataObject *input, vtkDataObject *output)
vtkTemporalStatistics::RequestUpdateExtent
int RequestUpdateExtent(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is called within ProcessRequest when each filter in the pipeline decides what portion of its inp...
vtkGraph
Base class for graph data types.
Definition: vtkGraph.h:290
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:60
vtkTemporalStatistics::ComputeMaximum
vtkTypeBool ComputeMaximum
Definition: vtkTemporalStatistics.h:118
vtkTemporalStatistics::ComputeMinimum
vtkTypeBool ComputeMinimum
Definition: vtkTemporalStatistics.h:119
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkPassInputTypeAlgorithm
Superclass for algorithms that produce output of the same type as input.
Definition: vtkPassInputTypeAlgorithm.h:52
vtkTemporalStatistics::RequestData
int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is called within ProcessRequest when a request asks the algorithm to do its work.
vtkTemporalStatistics::GetArray
virtual vtkDataArray * GetArray(vtkFieldData *fieldData, vtkDataArray *inArray, const char *nameSuffix)
vtkTemporalStatistics::AccumulateStatistics
virtual void AccumulateStatistics(vtkDataSet *input, vtkDataSet *output)