ExtractStructured.h

Go to the documentation of this file.

//============================================================================
//  The contents of this file are covered by the Viskores license. See
//  LICENSE.txt for details.
//
//  By contributing to this file, all contributors agree to the Developer
//  Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
//============================================================================
 
//============================================================================
//  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 viskores_filter_entity_extraction_ExtractStructured_h
#define viskores_filter_entity_extraction_ExtractStructured_h
 
#include <viskores/RangeId3.h>
#include <viskores/filter/Filter.h>
#include <viskores/filter/entity_extraction/viskores_filter_entity_extraction_export.h>
 
namespace viskores
{
namespace filter
{
namespace entity_extraction
{
class VISKORES_FILTER_ENTITY_EXTRACTION_EXPORT ExtractStructured : public viskores::filter::Filter
{
public:
  VISKORES_CONT
  viskores::RangeId3 GetVOI() const { return this->VOI; }
 
  VISKORES_CONT
  void SetVOI(viskores::Id i0,
              viskores::Id i1,
              viskores::Id j0,
              viskores::Id j1,
              viskores::Id k0,
              viskores::Id k1)
  {
    this->VOI = viskores::RangeId3(i0, i1, j0, j1, k0, k1);
  }
  VISKORES_CONT
  void SetVOI(viskores::Id extents[6]) { this->VOI = viskores::RangeId3(extents); }
  VISKORES_CONT
  void SetVOI(viskores::Id3 minPoint, viskores::Id3 maxPoint)
  {
    this->VOI = viskores::RangeId3(minPoint, maxPoint);
  }
  VISKORES_CONT
  void SetVOI(const viskores::RangeId3& voi) { this->VOI = voi; }
 
  VISKORES_CONT
  viskores::Id3 GetSampleRate() const { return this->SampleRate; }
 
  VISKORES_CONT
  void SetSampleRate(viskores::Id i, viskores::Id j, viskores::Id k)
  {
    this->SampleRate = viskores::Id3(i, j, k);
  }
 
  VISKORES_CONT
  void SetSampleRate(viskores::Id3 sampleRate) { this->SampleRate = sampleRate; }
 
  VISKORES_CONT
  bool GetIncludeBoundary() const { return this->IncludeBoundary; }
  VISKORES_CONT
  void SetIncludeBoundary(bool value) { this->IncludeBoundary = value; }
 
  // Set if VOI is specified in global (rather than in local) point indices
  // (NOTE: Deprecated this method since this does not seem to work as
  // expected and there are no tests for it. Furthermore, neither Viskores nor
  // VTK-h/Ascent seem to use this method. If your are using this method
  // somewhere else and think it should remain, please open a merge request to
  // "de-deprecate" it and add a test and documentation of the expected
  // behavior.)
  VISKORES_DEPRECATED(2.1)
  VISKORES_CONT
  void SetIncludeOffset(bool value) { this->IncludeOffset = value; }
 
private:
  VISKORES_CONT
  viskores::cont::DataSet DoExecute(const viskores::cont::DataSet& input) override;
 
  viskores::RangeId3 VOI = viskores::RangeId3(0, -1, 0, -1, 0, -1);
  viskores::Id3 SampleRate = { 1, 1, 1 };
  bool IncludeBoundary = false;
  bool IncludeOffset = false;
};
 
} // namespace entity_extraction
} // namespace filter
} // namespace viskores
 
#endif // viskores_filter_entity_extraction_ExtractStructured_h