ContourUncertainUniform.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.
//============================================================================
 
//  This code is based on the algorithm presented in the following papers:
//  Wang, J., Athawale, T., Moreland, K., Chen, J., Johnson, C., & Pugmire,
//  D. (2023). FunMC^ 2: A Filter for Uncertainty Visualization of Marching
//  Cubes on Multi-Core Devices. Oak Ridge National Laboratory (ORNL),
//  Oak Ridge, TN (United States).
//
//  Athawale, T. M., Sane, S., & Johnson, C. R. (2021, October). Uncertainty
//  Visualization of the Marching Squares and Marching Cubes Topology Cases.
//  In 2021 IEEE Visualization Conference (VIS) (pp. 106-110). IEEE.
 
#ifndef viskores_filter_uncertainty_ContourUncertainUniform_h
#define viskores_filter_uncertainty_ContourUncertainUniform_h
 
#include <viskores/filter/Filter.h>
#include <viskores/filter/uncertainty/viskores_filter_uncertainty_export.h>
 
namespace viskores
{
namespace filter
{
namespace uncertainty
{
class VISKORES_FILTER_UNCERTAINTY_EXPORT ContourUncertainUniform : public viskores::filter::Filter
{
 
  std::string NumberNonzeroProbabilityName = "num_nonzero_probability";
  std::string EntropyName = "entropy";
  viskores::Float64 IsoValue = 0.0;
 
public:
  VISKORES_CONT ContourUncertainUniform();
 
  VISKORES_CONT void SetMinField(const std::string& fieldName)
  {
    this->SetActiveField(0, fieldName, viskores::cont::Field::Association::Points);
  }
 
  VISKORES_CONT void SetMaxField(const std::string& fieldName)
  {
    this->SetActiveField(1, fieldName, viskores::cont::Field::Association::Points);
  }
 
  VISKORES_CONT void SetIsoValue(viskores::Float64 value) { this->IsoValue = value; }
 
  VISKORES_CONT viskores::Float64 GetIsoValue() const { return this->IsoValue; }
 
  VISKORES_CONT void SetCrossProbabilityName(const std::string& name)
  {
    this->SetOutputFieldName(name);
  }
 
  VISKORES_CONT const std::string& GetCrossProbabilityName() const
  {
    return this->GetOutputFieldName();
  }
 
  VISKORES_CONT void SetNumberNonzeroProbabilityName(const std::string& name)
  {
    this->NumberNonzeroProbabilityName = name;
  }
 
  VISKORES_CONT const std::string& GetNumberNonzeroProbabilityName() const
  {
    return this->NumberNonzeroProbabilityName;
  }
 
  VISKORES_CONT void SetEntropyName(const std::string& name) { this->EntropyName = name; }
 
  VISKORES_CONT const std::string& GetEntropyName() const { return this->EntropyName; }
 
protected:
  VISKORES_CONT viskores::cont::DataSet DoExecute(const viskores::cont::DataSet& input) override;
};
}
}
}
#endif