HistSampling.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_resampling_HistSampling_h
#define viskores_filter_resampling_HistSampling_h
 
#include <viskores/filter/Filter.h>
#include <viskores/filter/resampling/viskores_filter_resampling_export.h>
 
#include <viskores/Deprecated.h>
 
namespace viskores
{
namespace filter
{
namespace resampling
{
 
class VISKORES_FILTER_RESAMPLING_EXPORT HistSampling : public viskores::filter::Filter
{
public:
  VISKORES_CONT void SetNumberOfBins(viskores::Id numberOfBins)
  {
    this->NumberOfBins = numberOfBins;
  }
  VISKORES_CONT viskores::Id GetNumberOfBins() { return this->NumberOfBins; }
 
  VISKORES_CONT void SetSampleFraction(viskores::FloatDefault fraction)
  {
    this->SampleFraction = fraction;
  }
  VISKORES_CONT viskores::FloatDefault GetSampleFraction() const { return this->SampleFraction; }
 
  VISKORES_DEPRECATED(2.2, "Use SetSampleFraction().")
  VISKORES_CONT void SetSamplePercent(viskores::FloatDefault samplePercent)
  {
    this->SetSampleFraction(samplePercent);
  }
  VISKORES_DEPRECATED(2.2, "Use GetSampleFraction().")
  VISKORES_CONT viskores::FloatDefault GetSamplePercent() const
  {
    return this->GetSampleFraction();
  }
 
  VISKORES_CONT void SetSeed(viskores::UInt32 seed) { this->Seed = seed; }
  VISKORES_CONT viskores::UInt32 GetSeed() { return this->Seed; }
 
private:
  VISKORES_CONT viskores::cont::DataSet DoExecute(const viskores::cont::DataSet& input) override;
  viskores::Id NumberOfBins = 10;
  viskores::FloatDefault SampleFraction = 0.1f;
  viskores::UInt32 Seed = 0;
};
 
} // namespace resampling
} // namespace filter
} // namespace viskores
 
#endif // viskores_filter_resampling_HistSampling_h