VTK  9.2.6
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
55#ifndef vtkTemporalStatistics_h
56#define vtkTemporalStatistics_h
57
58#include "vtkFiltersGeneralModule.h" // For export macro
60
62class vtkDataSet;
63class vtkFieldData;
64class vtkGraph;
65
66class VTKFILTERSGENERAL_EXPORT vtkTemporalStatistics : public vtkPassInputTypeAlgorithm
67{
68public:
70
75 void PrintSelf(ostream& os, vtkIndent indent) override;
77
79
83 vtkGetMacro(ComputeAverage, vtkTypeBool);
84 vtkSetMacro(ComputeAverage, vtkTypeBool);
85 vtkBooleanMacro(ComputeAverage, vtkTypeBool);
87
89
93 vtkGetMacro(ComputeMinimum, vtkTypeBool);
94 vtkSetMacro(ComputeMinimum, vtkTypeBool);
95 vtkBooleanMacro(ComputeMinimum, vtkTypeBool);
97
99
103 vtkGetMacro(ComputeMaximum, vtkTypeBool);
104 vtkSetMacro(ComputeMaximum, vtkTypeBool);
105 vtkBooleanMacro(ComputeMaximum, vtkTypeBool);
107
108 // Definition:
109 // Turn on/off the computation of the standard deviation of the values over
110 // time. On by default. The resulting array names have "_stddev" appended to
111 // them.
112 vtkGetMacro(ComputeStandardDeviation, vtkTypeBool);
113 vtkSetMacro(ComputeStandardDeviation, vtkTypeBool);
114 vtkBooleanMacro(ComputeStandardDeviation, vtkTypeBool);
115
116protected:
119
124
125 // Used when iterating the pipeline to keep track of which timestep we are on.
127
128 int FillInputPortInformation(int port, vtkInformation* info) override;
129
131 vtkInformationVector* outputVector) override;
133 vtkInformationVector* outputVector) override;
135 vtkInformationVector* outputVector) override;
137 vtkInformationVector* outputVector) override;
138
139 virtual void InitializeStatistics(vtkDataObject* input, vtkDataObject* output);
140 virtual void InitializeStatistics(vtkDataSet* input, vtkDataSet* output);
141 virtual void InitializeStatistics(vtkGraph* input, vtkGraph* output);
143 virtual void InitializeArrays(vtkFieldData* inFd, vtkFieldData* outFd);
144 virtual void InitializeArray(vtkDataArray* array, vtkFieldData* outFd);
145
146 virtual void AccumulateStatistics(vtkDataObject* input, vtkDataObject* output);
147 virtual void AccumulateStatistics(vtkDataSet* input, vtkDataSet* output);
148 virtual void AccumulateStatistics(vtkGraph* input, vtkGraph* 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);
156 virtual void FinishArrays(vtkFieldData* inFd, vtkFieldData* outFd);
157
159 vtkFieldData* fieldData, vtkDataArray* inArray, const char* nameSuffix);
160
161private:
163 void operator=(const vtkTemporalStatistics&) = delete;
164
166
171 bool GeneratedChangingTopologyWarning;
173};
174
175#endif //_vtkTemporalStatistics_h
abstract superclass for composite (multi-block or AMR) datasets
abstract superclass for arrays of numeric data
general representation of visualization data
abstract class to specify dataset behavior
Definition vtkDataSet.h:63
represent and manipulate fields of data
Base class for graph data types.
Definition vtkGraph.h:296
a simple class to control print indentation
Definition vtkIndent.h:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Superclass for algorithms that produce output of the same type as input.
Compute statistics of point or cell data as it changes over time.
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
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...
virtual void InitializeStatistics(vtkDataObject *input, vtkDataObject *output)
virtual void PostExecute(vtkCompositeDataSet *input, vtkCompositeDataSet *output)
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...
~vtkTemporalStatistics() override
virtual void InitializeStatistics(vtkCompositeDataSet *input, vtkCompositeDataSet *output)
virtual void AccumulateStatistics(vtkGraph *input, vtkGraph *output)
virtual void AccumulateStatistics(vtkCompositeDataSet *input, vtkCompositeDataSet *output)
virtual void FinishArrays(vtkFieldData *inFd, vtkFieldData *outFd)
virtual void AccumulateStatistics(vtkDataObject *input, vtkDataObject *output)
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for instantiation, type information, and printing.
virtual void AccumulateArrays(vtkFieldData *inFd, vtkFieldData *outFd)
int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is called within ProcessRequest when a request asks for Information.
virtual void InitializeStatistics(vtkDataSet *input, vtkDataSet *output)
virtual void InitializeStatistics(vtkGraph *input, vtkGraph *output)
virtual void AccumulateStatistics(vtkDataSet *input, vtkDataSet *output)
virtual void InitializeArrays(vtkFieldData *inFd, vtkFieldData *outFd)
int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is called within ProcessRequest when a request asks the algorithm to do its work.
virtual void PostExecute(vtkGraph *input, vtkGraph *output)
virtual void PostExecute(vtkDataObject *input, vtkDataObject *output)
virtual void PostExecute(vtkDataSet *input, vtkDataSet *output)
static vtkTemporalStatistics * New()
Standard methods for instantiation, type information, and printing.
virtual vtkDataArray * GetArray(vtkFieldData *fieldData, vtkDataArray *inArray, const char *nameSuffix)
virtual void InitializeArray(vtkDataArray *array, vtkFieldData *outFd)
int vtkTypeBool
Definition vtkABI.h:69