mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-19 02:25:42 +00:00
405643ddbb
During the VTK-m 1.8 and 1.9 development, the filter infrastructure was overhauled. Part of this created a completely new set of base classes. To avoid confusion with the original filter base classes and ease transition, the new filter base classes were named `NewFilter*`. Eventually after all filters were transitioned, the old filter base classes were deprecated. With the release of VTK-m 2.0, the old filter base classes are removed. The "new" filter base classes are no longer new. Thus, they have been renamed simply `Filter` (and `FilterField`).
99 lines
3.4 KiB
C++
99 lines
3.4 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_filter_entity_extraction_ExtractStructured_h
|
|
#define vtk_m_filter_entity_extraction_ExtractStructured_h
|
|
|
|
#include <vtkm/RangeId3.h>
|
|
#include <vtkm/filter/FilterField.h>
|
|
#include <vtkm/filter/entity_extraction/vtkm_filter_entity_extraction_export.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace filter
|
|
{
|
|
namespace entity_extraction
|
|
{
|
|
/// \brief Select piece (e.g., volume of interest) and/or subsample structured points dataset
|
|
///
|
|
/// Select or subsample a portion of an input structured dataset. The selected
|
|
/// portion of interested is referred to as the Volume Of Interest, or VOI.
|
|
/// The output of this filter is a structured dataset. The filter treats input
|
|
/// data of any topological dimension (i.e., point, line, plane, or volume) and
|
|
/// can generate output data of any topological dimension.
|
|
///
|
|
/// To use this filter set the VOI ivar which are i-j-k min/max indices that
|
|
/// specify a rectangular region in the data. (Note that these are 0-offset.)
|
|
/// You can also specify a sampling rate to subsample the data.
|
|
///
|
|
/// Typical applications of this filter are to extract a slice from a volume
|
|
/// for image processing, subsampling large volumes to reduce data size, or
|
|
/// extracting regions of a volume with interesting data.
|
|
///
|
|
class VTKM_FILTER_ENTITY_EXTRACTION_EXPORT ExtractStructured : public vtkm::filter::FilterField
|
|
{
|
|
public:
|
|
// Set the bounding box for the volume of interest
|
|
VTKM_CONT
|
|
vtkm::RangeId3 GetVOI() const { return this->VOI; }
|
|
|
|
VTKM_CONT
|
|
void SetVOI(vtkm::Id i0, vtkm::Id i1, vtkm::Id j0, vtkm::Id j1, vtkm::Id k0, vtkm::Id k1)
|
|
{
|
|
this->VOI = vtkm::RangeId3(i0, i1, j0, j1, k0, k1);
|
|
}
|
|
VTKM_CONT
|
|
void SetVOI(vtkm::Id extents[6]) { this->VOI = vtkm::RangeId3(extents); }
|
|
VTKM_CONT
|
|
void SetVOI(vtkm::Id3 minPoint, vtkm::Id3 maxPoint)
|
|
{
|
|
this->VOI = vtkm::RangeId3(minPoint, maxPoint);
|
|
}
|
|
VTKM_CONT
|
|
void SetVOI(const vtkm::RangeId3& voi) { this->VOI = voi; }
|
|
|
|
/// Get the Sampling rate
|
|
VTKM_CONT
|
|
vtkm::Id3 GetSampleRate() const { return this->SampleRate; }
|
|
|
|
/// Set the Sampling rate
|
|
VTKM_CONT
|
|
void SetSampleRate(vtkm::Id i, vtkm::Id j, vtkm::Id k) { this->SampleRate = vtkm::Id3(i, j, k); }
|
|
|
|
/// Set the Sampling rate
|
|
VTKM_CONT
|
|
void SetSampleRate(vtkm::Id3 sampleRate) { this->SampleRate = sampleRate; }
|
|
|
|
/// Get if we should include the outer boundary on a subsample
|
|
VTKM_CONT
|
|
bool GetIncludeBoundary() const { return this->IncludeBoundary; }
|
|
/// Set if we should include the outer boundary on a subsample
|
|
VTKM_CONT
|
|
void SetIncludeBoundary(bool value) { this->IncludeBoundary = value; }
|
|
|
|
VTKM_CONT
|
|
void SetIncludeOffset(bool value) { this->IncludeOffset = value; }
|
|
|
|
private:
|
|
VTKM_CONT
|
|
vtkm::cont::DataSet DoExecute(const vtkm::cont::DataSet& input) override;
|
|
|
|
vtkm::RangeId3 VOI = vtkm::RangeId3(0, -1, 0, -1, 0, -1);
|
|
vtkm::Id3 SampleRate = { 1, 1, 1 };
|
|
bool IncludeBoundary = false;
|
|
bool IncludeOffset = false;
|
|
};
|
|
|
|
} // namespace entity_extraction
|
|
} // namespace filter
|
|
} // namespace vtkm
|
|
|
|
#endif // vtk_m_filter_entity_extraction_ExtractStructured_h
|