vtkExtractTimeSteps.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkExtractTimeSteps_h
#define vtkExtractTimeSteps_h
 
#include "vtkFiltersExtractionModule.h" // for export macro
#include "vtkPassInputTypeAlgorithm.h"
 
#include <set> // for time step indices
 
VTK_ABI_NAMESPACE_BEGIN
class VTKFILTERSEXTRACTION_EXPORT vtkExtractTimeSteps : public vtkPassInputTypeAlgorithm
{
public:
  vtkTypeMacro(vtkExtractTimeSteps, vtkPassInputTypeAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkExtractTimeSteps* New();

  int GetNumberOfTimeSteps() const { return static_cast<int>(this->TimeStepIndices.size()); }

  void AddTimeStepIndex(int timeStepIndex);


  void SetTimeStepIndices(int count, const int* timeStepIndices);
  void GetTimeStepIndices(int* timeStepIndices) const;

  void GenerateTimeStepIndices(int begin, int end, int step);


  void ClearTimeStepIndices()
  {
    this->TimeStepIndices.clear();
    this->Modified();
  }



  vtkGetMacro(UseRange, bool);
  vtkSetMacro(UseRange, bool);
  vtkBooleanMacro(UseRange, bool);


  vtkGetVector2Macro(Range, int);
  vtkSetVector2Macro(Range, int);


  vtkGetMacro(TimeStepInterval, int);
  vtkSetClampMacro(TimeStepInterval, int, 1, VTK_INT_MAX);
 
  // What timestep to provide when the requested time is between the timesteps
  // the filter is set to extract
  enum
  {
    PREVIOUS_TIMESTEP, // floor the time to the previous timestep
    NEXT_TIMESTEP,     // ceiling the time to the next timestep
    NEAREST_TIMESTEP   // take the timestep whose absolute difference from the requested time is
                       // smallest
  } EstimationMode;

  vtkGetMacro(TimeEstimationMode, int);
  vtkSetMacro(TimeEstimationMode, int);
  void SetTimeEstimationModeToPrevious() { this->SetTimeEstimationMode(PREVIOUS_TIMESTEP); }
  void SetTimeEstimationModeToNext() { this->SetTimeEstimationMode(NEXT_TIMESTEP); }
  void SetTimeEstimationModeToNearest() { this->SetTimeEstimationMode(NEAREST_TIMESTEP); }
 
protected:
  vtkExtractTimeSteps();
  ~vtkExtractTimeSteps() override = default;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  std::set<int> TimeStepIndices;
  bool UseRange;
  int Range[2];
  int TimeStepInterval;
  int TimeEstimationMode;
 
private:
  vtkExtractTimeSteps(const vtkExtractTimeSteps&) = delete;
  void operator=(const vtkExtractTimeSteps&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkExtractTimeSteps_h