otbPeriodicSampler.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 otbPeriodicSampler_h
#define otbPeriodicSampler_h
 
#include "otbSamplerBase.h"
#include "OTBStatisticsExport.h"
 
namespace otb
{
 
class OTBStatistics_EXPORT PeriodicSampler : public SamplerBase
{
public:
  typedef PeriodicSampler               Self;
  typedef SamplerBase                   Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  typedef struct Parameter
  {
 
    unsigned long Offset;
 
    unsigned long MaxJitter;
 
    unsigned long MaxBufferSize;
 
    bool operator!=(const struct Parameter& param) const;
  } ParameterType;
 
  itkNewMacro(Self);
 
  itkTypeMacro(PeriodicSampler, SamplerBase);
 
  void SetParameters(const ParameterType& param)
  {
    if (m_Parameters != param)
    {
      this->Modified();
      m_Parameters = param;
    }
  }
 
  ParameterType GetParameters()
  {
    return m_Parameters;
  }
 
  void Reset(void) override;
 
  bool TakeSample(void);
 
protected:
  PeriodicSampler();
 
  ~PeriodicSampler() override
  {
  }
 
private:
  // Not implemented
  PeriodicSampler(const Self&);
  void operator=(const Self&);
 
  ParameterType m_Parameters;
 
  double m_JitterSize;
 
  double m_OffsetValue;
 
  std::vector<double> m_JitterValues;
};
 
} // namespace otb
#endif