Threshold.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_Threshold_h
#define viskores_filter_entity_extraction_Threshold_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 Threshold : public viskores::filter::Filter
{
public:
  VISKORES_CONT void SetLowerThreshold(viskores::Float64 value) { this->LowerValue = value; }
  VISKORES_CONT void SetUpperThreshold(viskores::Float64 value) { this->UpperValue = value; }
 
  VISKORES_CONT viskores::Float64 GetLowerThreshold() const { return this->LowerValue; }
  VISKORES_CONT viskores::Float64 GetUpperThreshold() const { return this->UpperValue; }
 
  VISKORES_CONT void SetThresholdBelow(viskores::Float64 value);
 
  VISKORES_CONT void SetThresholdAbove(viskores::Float64 value);
 
  VISKORES_CONT void SetThresholdBetween(viskores::Float64 value1, viskores::Float64 value2);
 
  VISKORES_CONT void SetComponentToTest(viskores::IdComponent component)
  {
    this->ComponentMode = Component::Selected;
    this->SelectedComponent = component;
  }
  VISKORES_CONT void SetComponentToTestToAny() { this->ComponentMode = Component::Any; }
  VISKORES_CONT void SetComponentToTestToAll() { this->ComponentMode = Component::All; }
 
  VISKORES_CONT void SetAllInRange(bool value) { this->AllInRange = value; }
  VISKORES_CONT bool GetAllInRange() const { return this->AllInRange; }
 
  VISKORES_CONT void SetInvert(bool value) { this->Invert = value; }
  VISKORES_CONT bool GetInvert() const { return this->Invert; }
 
private:
  VISKORES_CONT
  viskores::cont::DataSet DoExecute(const viskores::cont::DataSet& input) override;
 
  double LowerValue = 0;
  double UpperValue = 0;
 
  enum struct Component
  {
    Any,
    All,
    Selected
  };
 
  Component ComponentMode = Component::Selected;
  viskores::IdComponent SelectedComponent = 0;
 
  bool AllInRange = false;
  bool Invert = false;
};
} // namespace entity_extraction
} // namespace filter
} // namespace viskores
 
#endif // viskores_filter_entity_extraction_Threshold_h