mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-08 21:33:55 +00:00
42 lines
1.2 KiB
C++
42 lines
1.2 KiB
C++
//============================================================================
|
|
// Copyright (c) Kitware, Inc.
|
|
// All rights reserved.
|
|
// See LICENSE.txt for details.
|
|
//
|
|
// 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.
|
|
//============================================================================
|
|
|
|
#ifndef vtk_m_worklet_BoundaryTypes_h
|
|
#define vtk_m_worklet_BoundaryTypes_h
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace worklet
|
|
{
|
|
/// \brief Clamps boundary values to the nearest valid i,j,k value
|
|
///
|
|
/// BoundaryClamp always returns the nearest valid i,j,k value when at an
|
|
/// image boundary. This is a commonly used when solving differential equations.
|
|
///
|
|
/// For example, when used with WorkletCellNeighborhood3x3x3 when centered
|
|
/// on the point 1:
|
|
/// \code
|
|
/// * * *
|
|
/// * 1 2 (where * denotes points that lie outside of the image boundary)
|
|
/// * 3 5
|
|
/// \endcode
|
|
/// returns the following neighborhood of values:
|
|
/// \code
|
|
/// 1 1 2
|
|
/// 1 1 2
|
|
/// 3 3 5
|
|
/// \endcode
|
|
struct BoundaryClamp
|
|
{
|
|
};
|
|
}
|
|
}
|
|
#endif //vtk_m_worklet_BoundaryTypes_h
|