Viskores  1.0
Mask.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 
19 #ifndef viskores_filter_entity_extraction_Mask_h
20 #define viskores_filter_entity_extraction_Mask_h
21 
22 #include <viskores/filter/Filter.h>
24 
25 namespace viskores
26 {
27 namespace filter
28 {
29 namespace entity_extraction
30 {
34 class VISKORES_FILTER_ENTITY_EXTRACTION_EXPORT Mask : public viskores::filter::Filter
35 {
36 public:
37  // When CompactPoints is set, instead of copying the points and point fields
38  // from the input, the filter will create new compact fields without the unused elements
40  bool GetCompactPoints() const { return this->CompactPoints; }
42  void SetCompactPoints(bool value) { this->CompactPoints = value; }
43 
44  // Set the stride of the subsample
46  viskores::Id GetStride() const { return this->Stride; }
48  void SetStride(viskores::Id& stride) { this->Stride = stride; }
49 
50 private:
52  viskores::cont::DataSet DoExecute(const viskores::cont::DataSet& input) override;
53 
54  viskores::Id Stride = 1;
55  bool CompactPoints = false;
56 };
57 } // namespace entity_extraction
58 } // namespace filter
59 } // namespace vtk
60 
61 #endif // viskores_filter_entity_extraction_Mask_h
viskores::cont::DataSet
Contains and manages the geometric data structures that Viskores operates on.
Definition: DataSet.h:66
viskores::filter::entity_extraction::Mask::GetCompactPoints
bool GetCompactPoints() const
Definition: Mask.h:40
viskores::filter::Filter
Base class for all filters.
Definition: Filter.h:171
viskores::filter::entity_extraction::Mask::GetStride
viskores::Id GetStride() const
Definition: Mask.h:46
viskores::Id
viskores::Int64 Id
Base type to use to index arrays.
Definition: Types.h:235
viskores::filter::entity_extraction::Mask::SetStride
void SetStride(viskores::Id &stride)
Definition: Mask.h:48
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::entity_extraction::Mask
Subselect cells using a stride.
Definition: Mask.h:34
viskores_filter_entity_extraction_export.h
viskores::filter::entity_extraction::Mask::SetCompactPoints
void SetCompactPoints(bool value)
Definition: Mask.h:42
Filter.h