2016-08-23 14:23:42 +00:00
|
|
|
//============================================================================
|
|
|
|
// Copyright (c) Kitware, Inc.
|
|
|
|
// All rights reserved.
|
|
|
|
// See LICENSE.txt for details.
|
2019-04-15 23:24:21 +00:00
|
|
|
//
|
2016-08-23 14:23:42 +00:00
|
|
|
// This software is distributed WITHOUT ANY WARRANTY; without even
|
|
|
|
// the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
|
|
// PURPOSE. See the above copyright notice for more information.
|
|
|
|
//============================================================================
|
|
|
|
|
2017-04-18 15:01:17 +00:00
|
|
|
#ifndef vtk_m_filter_ClipWithField_h
|
|
|
|
#define vtk_m_filter_ClipWithField_h
|
2016-08-23 14:23:42 +00:00
|
|
|
|
|
|
|
#include <vtkm/filter/FilterDataSetWithField.h>
|
|
|
|
#include <vtkm/worklet/Clip.h>
|
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
namespace vtkm
|
|
|
|
{
|
|
|
|
namespace filter
|
|
|
|
{
|
2017-07-06 17:51:45 +00:00
|
|
|
/// \brief Clip a dataset using a field
|
|
|
|
///
|
|
|
|
/// Clip a dataset using a given field value. All points that are less than that
|
|
|
|
/// value are considered outside, and will be discarded. All points that are greater
|
|
|
|
/// are kept.
|
|
|
|
/// The resulting geometry will not be water tight.
|
2017-04-18 15:01:17 +00:00
|
|
|
class ClipWithField : public vtkm::filter::FilterDataSetWithField<ClipWithField>
|
2016-08-23 14:23:42 +00:00
|
|
|
{
|
|
|
|
public:
|
2016-10-19 22:42:58 +00:00
|
|
|
VTKM_CONT
|
2017-04-18 15:01:17 +00:00
|
|
|
ClipWithField();
|
2016-08-23 14:23:42 +00:00
|
|
|
|
2016-10-19 22:42:58 +00:00
|
|
|
VTKM_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
void SetClipValue(vtkm::Float64 value) { this->ClipValue = value; }
|
2016-08-23 14:23:42 +00:00
|
|
|
|
2018-03-09 02:28:08 +00:00
|
|
|
VTKM_CONT
|
|
|
|
void SetInvertClip(bool invert) { this->Invert = invert; }
|
|
|
|
|
2016-10-19 22:42:58 +00:00
|
|
|
VTKM_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
vtkm::Float64 GetClipValue() const { return this->ClipValue; }
|
2016-08-23 14:23:42 +00:00
|
|
|
|
2018-08-30 15:53:18 +00:00
|
|
|
template <typename T, typename StorageType, typename DerivedPolicy>
|
2018-04-02 21:58:21 +00:00
|
|
|
VTKM_CONT vtkm::cont::DataSet DoExecute(const vtkm::cont::DataSet& input,
|
|
|
|
const vtkm::cont::ArrayHandle<T, StorageType>& field,
|
|
|
|
const vtkm::filter::FieldMetadata& fieldMeta,
|
2018-08-30 15:53:18 +00:00
|
|
|
vtkm::filter::PolicyBase<DerivedPolicy> policy);
|
2016-08-23 14:23:42 +00:00
|
|
|
|
|
|
|
//Map a new field onto the resulting dataset after running the filter.
|
|
|
|
//This call is only valid after Execute has been called.
|
2018-08-30 15:53:18 +00:00
|
|
|
template <typename T, typename StorageType, typename DerivedPolicy>
|
2018-04-02 21:58:21 +00:00
|
|
|
VTKM_CONT bool DoMapField(vtkm::cont::DataSet& result,
|
2017-05-18 14:29:41 +00:00
|
|
|
const vtkm::cont::ArrayHandle<T, StorageType>& input,
|
|
|
|
const vtkm::filter::FieldMetadata& fieldMeta,
|
2018-08-30 15:53:18 +00:00
|
|
|
vtkm::filter::PolicyBase<DerivedPolicy> policy);
|
2016-08-23 14:23:42 +00:00
|
|
|
|
|
|
|
private:
|
|
|
|
vtkm::Float64 ClipValue;
|
|
|
|
vtkm::worklet::Clip Worklet;
|
2018-03-09 02:28:08 +00:00
|
|
|
bool Invert;
|
2016-08-23 14:23:42 +00:00
|
|
|
};
|
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
template <>
|
2017-04-18 15:01:17 +00:00
|
|
|
class FilterTraits<ClipWithField>
|
2016-08-23 14:23:42 +00:00
|
|
|
{ //currently the Clip filter only works on scalar data.
|
|
|
|
public:
|
2018-02-22 13:29:13 +00:00
|
|
|
using InputFieldTypeList = TypeListTagScalarAll;
|
2016-08-23 14:23:42 +00:00
|
|
|
};
|
|
|
|
}
|
|
|
|
} // namespace vtkm::filter
|
|
|
|
|
2017-04-18 15:01:17 +00:00
|
|
|
#include <vtkm/filter/ClipWithField.hxx>
|
2016-08-23 14:23:42 +00:00
|
|
|
|
2017-04-18 15:01:17 +00:00
|
|
|
#endif // vtk_m_filter_ClipWithField_h
|