otbSamplingRateCalculatorList.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 otbSamplingRateCalculatorList_h
#define otbSamplingRateCalculatorList_h
 
#include "otbSamplingRateCalculator.h"
#include "otbObjectList.h"
#include "OTBSamplingExport.h"
 
namespace otb
{
class OTBSampling_EXPORT SamplingRateCalculatorList : public ObjectList<SamplingRateCalculator>
{
public:
  typedef SamplingRateCalculatorList         Self;
  typedef ObjectList<SamplingRateCalculator> Superclass;
  typedef itk::SmartPointer<Self>            Pointer;
  typedef itk::SmartPointer<const Self>      ConstPointer;
 
  typedef SamplingRateCalculator::ClassCountMapType ClassCountMapType;
  typedef SamplingRateCalculator::MapRateType       MapRateType;
 
  enum PartitionType
  {
    PROPORTIONAL,
    EQUAL,
    CUSTOM
  };
 
  itkNewMacro(Self);
 
  itkTypeMacro(SamplingRateCalculatorList, ObjectList);
 
  void SetNthClassCount(unsigned int index, const ClassCountMapType& map);
 
  const MapRateType& GetRatesByClass(unsigned int index);
 
  void ClearRates(void);
 
  void SetAllSamples(PartitionType t);
 
  void SetMinimumNbOfSamplesByClass(PartitionType t);
 
  void SetNbOfSamplesAllClasses(std::vector<unsigned long>& nb, PartitionType t);
 
  void SetNbOfSamplesByClass(const std::vector<ClassCountMapType>& required, PartitionType t);
 
  void SetPercentageOfSamples(std::vector<double>& p, PartitionType t);
 
  void SetTotalNumberOfSamples(std::vector<unsigned long>& tot, PartitionType t);
 
protected:
  SamplingRateCalculatorList()
  {
  }
 
  ~SamplingRateCalculatorList() override
  {
  }
 
private:
  SamplingRateCalculatorList(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  void UpdateGlobalCounts();
 
  ClassCountMapType m_GlobalCountMap;
};
} // end namespace otb
 
#endif