otbSamplerBase.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef otbSamplerBase_h
#define otbSamplerBase_h
 
#include "itkObject.h"
#include "itkObjectFactory.h"
#include "OTBStatisticsExport.h"
 
namespace otb
{
 
class OTBStatistics_EXPORT SamplerBase : public itk::Object
{
public:
  typedef SamplerBase                   Self;
  typedef itk::Object                   Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkTypeMacro(SamplerBase, itk::Object);
 
  virtual void Reset(void);
 
  void SetNumberOfElements(unsigned long needed, unsigned long total);
 
  void SetRate(double rate, unsigned long total = 0UL);
 
  itkGetMacro(Rate, double);
 
  itkGetMacro(TotalElements, unsigned long);
 
  itkGetMacro(NeededElements, unsigned long);
 
  itkGetMacro(ChosenElements, unsigned long);
 
  itkGetMacro(ProcessedElements, unsigned long);
 
protected:
  SamplerBase();
 
  ~SamplerBase() override
  {
  }
 
  unsigned long m_ChosenElements;
 
  unsigned long m_ProcessedElements;
 
private:
  // Not implemented
  SamplerBase(const Self&);
  void operator=(const Self&);
 
  unsigned long m_TotalElements;
 
  unsigned long m_NeededElements;
 
  double m_Rate;
};
 
} // namespace otb
#endif