VTK-m  2.0
LogValues.h
Go to the documentation of this file.
1 //============================================================================
2 // Copyright (c) Kitware, Inc.
3 // All rights reserved.
4 // See LICENSE.txt for details.
5 //
6 // This software is distributed WITHOUT ANY WARRANTY; without even
7 // the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
8 // PURPOSE. See the above copyright notice for more information.
9 //============================================================================
10 #ifndef vtk_m_filter_field_transform_LogValues_h
11 #define vtk_m_filter_field_transform_LogValues_h
12 
14 #include <vtkm/filter/field_transform/vtkm_filter_field_transform_export.h>
15 
16 namespace vtkm
17 {
18 namespace filter
19 {
20 namespace field_transform
21 {
22 
27 class VTKM_FILTER_FIELD_TRANSFORM_EXPORT LogValues : public vtkm::filter::FilterField
28 {
29 public:
30  enum struct LogBase
31  {
32  E,
33  TWO,
34  TEN
35  };
36 
40  const LogBase& GetBaseValue() const { return this->BaseValue; }
41  void SetBaseValue(const LogBase& base) { this->BaseValue = base; }
43 
47  vtkm::FloatDefault GetMinValue() const { return this->MinValue; }
48  void SetMinValue(const vtkm::FloatDefault& value) { this->MinValue = value; }
50 
51 private:
52  vtkm::cont::DataSet DoExecute(const vtkm::cont::DataSet& input) override;
53  LogBase BaseValue = LogBase::E;
54  vtkm::FloatDefault MinValue = std::numeric_limits<FloatDefault>::min();
55 };
56 } // namespace field_transform
57 } // namespace vtkm::filter
58 } // namespace vtkm
59 
60 #endif //vtk_m_filter_field_transform_LogValues_h
vtkm
Groups connected points that have the same field value.
Definition: Atomic.h:19
vtkm::filter::field_transform::LogValues::SetBaseValue
void SetBaseValue(const LogBase &base)
The base value given to the log filter.
Definition: LogValues.h:41
vtkm::cont::DataSet
Definition: DataSet.h:34
vtkm::filter::field_transform::LogValues::GetBaseValue
const LogBase & GetBaseValue() const
The base value given to the log filter.
Definition: LogValues.h:40
FilterField.h
vtkm::filter::FilterField
Definition: FilterField.h:21
vtkm::filter::field_transform::LogValues
Adds field to a DataSet that gives the log values for the user specified field.
Definition: LogValues.h:27
vtkm::filter::field_transform::LogValues::GetMinValue
vtkm::FloatDefault GetMinValue() const
The min value for executing the log filter.
Definition: LogValues.h:47
vtkm::FloatDefault
vtkm::Float32 FloatDefault
The floating point type to use when no other precision is specified.
Definition: Types.h:198
vtkm::filter::field_transform::LogValues::LogBase
LogBase
Definition: LogValues.h:30
vtkm::filter::field_transform::LogValues::SetMinValue
void SetMinValue(const vtkm::FloatDefault &value)
The min value for executing the log filter.
Definition: LogValues.h:48