VTK-m  2.0
ContourTreeNodeComparator.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 // Copyright (c) 2018, The Regents of the University of California, through
11 // Lawrence Berkeley National Laboratory (subject to receipt of any required approvals
12 // from the U.S. Dept. of Energy). All rights reserved.
13 //
14 // Redistribution and use in source and binary forms, with or without modification,
15 // are permitted provided that the following conditions are met:
16 //
17 // (1) Redistributions of source code must retain the above copyright notice, this
18 // list of conditions and the following disclaimer.
19 //
20 // (2) Redistributions in binary form must reproduce the above copyright notice,
21 // this list of conditions and the following disclaimer in the documentation
22 // and/or other materials provided with the distribution.
23 //
24 // (3) Neither the name of the University of California, Lawrence Berkeley National
25 // Laboratory, U.S. Dept. of Energy nor the names of its contributors may be
26 // used to endorse or promote products derived from this software without
27 // specific prior written permission.
28 //
29 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
30 // ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
31 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
32 // IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 // INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
34 // BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
36 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
37 // OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
38 // OF THE POSSIBILITY OF SUCH DAMAGE.
39 //
40 //=============================================================================
41 //
42 // This code is an extension of the algorithm presented in the paper:
43 // Parallel Peak Pruning for Scalable SMP Contour Tree Computation.
44 // Hamish Carr, Gunther Weber, Christopher Sewell, and James Ahrens.
45 // Proceedings of the IEEE Symposium on Large Data Analysis and Visualization
46 // (LDAV), October 2016, Baltimore, Maryland.
47 //
48 // The PPP2 algorithm and software were jointly developed by
49 // Hamish Carr (University of Leeds), Gunther H. Weber (LBNL), and
50 // Oliver Ruebel (LBNL)
51 //==============================================================================
52 
53 #ifndef vtk_m_worklet_contourtree_augmented_contourtree_maker_inc_contour_tree_node_comparator_h
54 #define vtk_m_worklet_contourtree_augmented_contourtree_maker_inc_contour_tree_node_comparator_h
55 
56 #include <vtkm/cont/ArrayHandle.h>
59 
60 namespace vtkm
61 {
62 namespace worklet
63 {
64 namespace contourtree_augmented
65 {
66 namespace contourtree_maker_inc
67 {
68 
69 
70 // comparator used for initial sort of data values
72 {
73 public:
75 
78 
79  // constructor
80  VTKM_CONT
82  const IdArrayType& superarcs,
84  vtkm::cont::Token& token)
85  {
86  this->SuperparentsPortal = superparents.PrepareForInput(device, token);
87  this->SuperarcsPortal = superarcs.PrepareForInput(device, token);
88  }
89 
90  // () operator - gets called to do comparison
91  VTKM_EXEC
92  bool operator()(const vtkm::Id& leftNode, const vtkm::Id& rightNode) const
93  { // operator()
94  // first compare the left & right superparents
95  vtkm::Id leftSuperparent = this->SuperparentsPortal.Get(leftNode);
96  vtkm::Id rightSuperparent = this->SuperparentsPortal.Get(rightNode);
97  if (leftSuperparent < rightSuperparent)
98  return true;
99  else if (leftSuperparent > rightSuperparent)
100  return false;
101 
102  // the parents are equal, so we compare the nodes, which are sort indices & indicate value
103  // but we need to flip for ascending edges - we retrieve this information from the superarcs array
104  bool isAscendingSuperarc = IsAscending(this->SuperarcsPortal.Get(leftSuperparent));
105  if (leftNode < rightNode)
106  return isAscendingSuperarc;
107  else if (leftNode > rightNode)
108  return !isAscendingSuperarc;
109  else
110  return false;
111  } // operator()
112 }; // ContourTreeNodeComparatorImpl
113 
115 {
116 public:
117  // constructor
118  VTKM_CONT
119  ContourTreeNodeComparator(const IdArrayType& superparents, const IdArrayType& superarcs)
120  : Superparents(superparents)
121  , Superarcs(superarcs)
122  {
123  }
124 
126  vtkm::cont::Token& token)
127  {
128  return ContourTreeNodeComparatorImpl(this->Superparents, this->Superarcs, device, token);
129  }
130 
131 private:
134 }; // ContourTreeNodeComparator
135 
136 } // namespace contourtree_maker_inc
137 } // namespace contourtree_augmented
138 } // namespace worklet
139 } // namespace vtkm
140 
141 #endif
vtkm::cont::ArrayHandle< vtkm::Id >
vtkm::worklet::contourtree_augmented::IsAscending
VTKM_EXEC_CONT bool IsAscending(vtkm::Id flaggedIndex)
Definition: filter/scalar_topology/worklet/contourtree_augmented/Types.h:121
ArrayHandle.h
VTKM_EXEC
#define VTKM_EXEC
Definition: ExportMacros.h:51
vtkm
Groups connected points that have the same field value.
Definition: Atomic.h:19
vtkm::cont::ArrayHandle::PrepareForInput
VTKM_CONT ReadPortalType PrepareForInput(vtkm::cont::DeviceAdapterId device, vtkm::cont::Token &token) const
Prepares this array to be used as an input to an operation in the execution environment.
Definition: ArrayHandle.h:574
vtkm::worklet::contourtree_augmented::contourtree_maker_inc::ContourTreeNodeComparator::Superparents
IdArrayType Superparents
Definition: ContourTreeNodeComparator.h:132
vtkm::worklet::contourtree_augmented::contourtree_maker_inc::ContourTreeNodeComparator::PrepareForExecution
VTKM_CONT ContourTreeNodeComparatorImpl PrepareForExecution(vtkm::cont::DeviceAdapterId device, vtkm::cont::Token &token)
Definition: ContourTreeNodeComparator.h:125
vtkm::worklet::contourtree_augmented::contourtree_maker_inc::ContourTreeNodeComparator::ContourTreeNodeComparator
VTKM_CONT ContourTreeNodeComparator(const IdArrayType &superparents, const IdArrayType &superarcs)
Definition: ContourTreeNodeComparator.h:119
vtkm::worklet::contourtree_augmented::contourtree_maker_inc::ContourTreeNodeComparatorImpl::SuperparentsPortal
IdPortalType SuperparentsPortal
Definition: ContourTreeNodeComparator.h:76
vtkm::cont::ArrayHandle::ReadPortalType
typename StorageType::ReadPortalType ReadPortalType
Definition: ArrayHandle.h:294
vtkm::worklet::contourtree_augmented::contourtree_maker_inc::ContourTreeNodeComparator
Definition: ContourTreeNodeComparator.h:114
vtkm::worklet::contourtree_augmented::contourtree_maker_inc::ContourTreeNodeComparator::Superarcs
IdArrayType Superarcs
Definition: ContourTreeNodeComparator.h:133
vtkm::Id
vtkm::Int32 Id
Represents an ID (index into arrays).
Definition: Types.h:191
vtkm::cont::Token
A token to hold the scope of an ArrayHandle or other object.
Definition: Token.h:35
Types.h
VTKM_CONT
#define VTKM_CONT
Definition: ExportMacros.h:57
vtkm::worklet::contourtree_augmented::contourtree_maker_inc::ContourTreeNodeComparatorImpl::IdPortalType
vtkm::cont::ArrayHandle< vtkm::Id >::ReadPortalType IdPortalType
Definition: ContourTreeNodeComparator.h:74
vtkm::worklet::contourtree_augmented::contourtree_maker_inc::ContourTreeNodeComparatorImpl::ContourTreeNodeComparatorImpl
VTKM_CONT ContourTreeNodeComparatorImpl(const IdArrayType &superparents, const IdArrayType &superarcs, vtkm::cont::DeviceAdapterId device, vtkm::cont::Token &token)
Definition: ContourTreeNodeComparator.h:81
vtkm::cont::ExecutionObjectBase
Base ExecutionObjectBase for execution objects to inherit from so that you can use an arbitrary objec...
Definition: ExecutionObjectBase.h:31
vtkm::cont::DeviceAdapterId
Definition: DeviceAdapterTag.h:52
vtkm::worklet::contourtree_augmented::contourtree_maker_inc::ContourTreeNodeComparatorImpl::SuperarcsPortal
IdPortalType SuperarcsPortal
Definition: ContourTreeNodeComparator.h:77
vtkm::worklet::contourtree_augmented::contourtree_maker_inc::ContourTreeNodeComparatorImpl::operator()
VTKM_EXEC bool operator()(const vtkm::Id &leftNode, const vtkm::Id &rightNode) const
Definition: ContourTreeNodeComparator.h:92
vtkm::worklet::contourtree_augmented::contourtree_maker_inc::ContourTreeNodeComparatorImpl
Definition: ContourTreeNodeComparator.h:71
ExecutionObjectBase.h