Viskores  1.0
Probe.h
Go to the documentation of this file.
1 //============================================================================
2 // The contents of this file are covered by the Viskores license. See
3 // LICENSE.txt for details.
4 //
5 // By contributing to this file, all contributors agree to the Developer
6 // Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
7 //============================================================================
8 
9 //============================================================================
10 // Copyright (c) Kitware, Inc.
11 // All rights reserved.
12 // See LICENSE.txt for details.
13 //
14 // This software is distributed WITHOUT ANY WARRANTY; without even
15 // the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
16 // PURPOSE. See the above copyright notice for more information.
17 //============================================================================
18 #ifndef viskores_filter_resampling_Probe_h
19 #define viskores_filter_resampling_Probe_h
20 
21 #include <viskores/filter/Filter.h>
23 
24 namespace viskores
25 {
26 namespace filter
27 {
28 namespace resampling
29 {
30 
44 class VISKORES_FILTER_RESAMPLING_EXPORT Probe : public viskores::filter::Filter
45 {
46 public:
52  {
53  this->Geometry = viskores::cont::DataSet();
54  this->Geometry.CopyStructure(geometry);
55  }
56 
58  VISKORES_CONT const viskores::cont::DataSet& GetGeometry() const { return this->Geometry; }
59 
66  {
67  this->InvalidValue = invalidValue;
68  }
70  VISKORES_CONT viskores::Float64 GetInvalidValue() const { return this->InvalidValue; }
71 
72 private:
73  VISKORES_CONT viskores::cont::DataSet DoExecute(const viskores::cont::DataSet& input) override;
74 
76 
77  viskores::Float64 InvalidValue = viskores::Nan64();
78 };
79 
80 } // namespace resampling
81 } // namespace filter
82 } // namespace viskores
83 
84 #endif // viskores_filter_resampling_Probe_h
viskores::cont::DataSet
Contains and manages the geometric data structures that Viskores operates on.
Definition: DataSet.h:66
viskores::filter::resampling::Probe::SetInvalidValue
void SetInvalidValue(viskores::Float64 invalidValue)
Specify the value to use for points outside the bounds of the input.
Definition: Probe.h:65
viskores::filter::resampling::Probe::SetGeometry
void SetGeometry(const viskores::cont::DataSet &geometry)
Specify the geometry to probe with.
Definition: Probe.h:51
viskores::filter::Filter
Base class for all filters.
Definition: Filter.h:171
viskores::filter::resampling::Probe::Geometry
viskores::cont::DataSet Geometry
Definition: Probe.h:75
viskores::filter::resampling::Probe
Sample the fields of a data set at specified locations.
Definition: Probe.h:44
VISKORES_CONT
#define VISKORES_CONT
Definition: ExportMacros.h:65
viskores
Groups connected points that have the same field value.
Definition: Atomic.h:27
viskores_filter_resampling_export.h
viskores::filter::resampling::Probe::GetGeometry
const viskores::cont::DataSet & GetGeometry() const
Specify the geometry to probe with.
Definition: Probe.h:58
viskores::Float64
double Float64
Base type to use for 64-bit floating-point numbers.
Definition: Types.h:169
viskores::filter::resampling::Probe::GetInvalidValue
viskores::Float64 GetInvalidValue() const
Specify the value to use for points outside the bounds of the input.
Definition: Probe.h:70
Filter.h