otbSamplingRateCalculator.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 otbSamplingRateCalculator_h
#define otbSamplingRateCalculator_h
 
#include "itkImageRegion.h"
#include "itkVectorContainer.h"
#include <set>
#include "OTBSamplingExport.h"
 
namespace otb
{
class OTBSampling_EXPORT SamplingRateCalculator : public itk::Object
{
public:
  typedef SamplingRateCalculator        Self;
  typedef itk::Object                   Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  typedef std::map<std::string, unsigned long> ClassCountMapType;
  typedef ClassCountMapType::const_iterator constItMapType;
  typedef struct OTBSampling_EXPORT         Triplet
  {
    unsigned long Required;
    unsigned long Tot;
    double        Rate;
    bool operator==(const struct Triplet& triplet) const;
  } TripletType;
 
  typedef std::map<std::string, TripletType> MapRateType;
 
  itkNewMacro(Self);
 
  itkTypeMacro(SamplingRateCalculator, itk::Object);
 
  void SetNbOfSamplesByClass(const ClassCountMapType& required);
 
  void SetNbOfSamplesAllClasses(unsigned long);
 
  void SetPercentageOfSamples(double percent);
 
  void SetTotalNumberOfSamples(unsigned long value);
 
  void SetMinimumNbOfSamplesByClass(void);
 
  void SetAllSamples(void);
 
  void Write(std::string filename);
 
  void Read(std::string filename);
 
  itkGetConstReferenceMacro(RatesByClass, MapRateType);
 
  void SetClassCount(const ClassCountMapType& map);
 
  void ClearRates(void);
 
  static ClassCountMapType ReadRequiredSamples(const std::string& filename);
 
protected:
  SamplingRateCalculator();
 
  ~SamplingRateCalculator() override
  {
  }
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  SamplingRateCalculator(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  void UpdateRate(const std::string& name);
 
  MapRateType m_RatesByClass;
};
} // End namespace otb
 
#endif