otbListSampleToBalancedListSampleFilter.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 otbListSampleToBalancedListSampleFilter_h
#define otbListSampleToBalancedListSampleFilter_h
 
#include "otbGaussianAdditiveNoiseSampleListFilter.h"
#include "itkDataObjectDecorator.h"
#include "otbMacro.h"
 
namespace otb
{
namespace Statistics
{
 
template <class TInputSampleList, class TLabelSampleList, class TOutputSampleList = TInputSampleList>
class ITK_EXPORT ListSampleToBalancedListSampleFilter : public otb::Statistics::ListSampleToListSampleFilter<TInputSampleList, TOutputSampleList>
{
public:
  typedef ListSampleToBalancedListSampleFilter Self;
  typedef otb::Statistics::ListSampleToListSampleFilter<TInputSampleList, TOutputSampleList> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkTypeMacro(ListSampleToBalancedListSampleFilter, otb::Statistics::ListSampleToListSampleFilter);
 
  itkNewMacro(Self);
 
  typedef TInputSampleList                                    InputSampleListType;
  typedef typename InputSampleListType::Pointer               InputSampleListPointer;
  typedef typename InputSampleListType::ConstPointer          InputSampleListConstPointer;
  typedef typename InputSampleListType::MeasurementVectorType InputMeasurementVectorType;
  typedef typename InputMeasurementVectorType::ValueType      InputValueType;
 
  typedef TLabelSampleList                                    LabelSampleListType;
  typedef typename LabelSampleListType::Pointer               LabelSampleListPointer;
  typedef typename LabelSampleListType::ConstPointer          LabelSampleListConstPointer;
  typedef typename LabelSampleListType::MeasurementVectorType LabelMeasurementVectorType;
  typedef typename LabelMeasurementVectorType::ValueType      LabelValueType;
  typedef itk::DataObjectDecorator<LabelSampleListType>       LabelSampleListObjectType;
 
  typedef TOutputSampleList                                    OutputSampleListType;
  typedef typename OutputSampleListType::Pointer               OutputSampleListPointer;
  typedef typename OutputSampleListType::ConstPointer          OutputSampleListConstPointer;
  typedef typename OutputSampleListType::MeasurementVectorType OutputMeasurementVectorType;
  typedef typename OutputMeasurementVectorType::ValueType      OutputValueType;
 
  typedef typename Superclass::DataObjectPointer             DataObjectPointer;
  typedef itk::ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType;
 
  typedef otb::Statistics::GaussianAdditiveNoiseSampleListFilter<InputSampleListType, OutputSampleListType> GaussianAdditiveNoiseType;
  typedef typename GaussianAdditiveNoiseType::Pointer GaussianAdditiveNoisePointerType;
 
  void SetInputLabel(const LabelSampleListType* label);
 
  const LabelSampleListType* GetInputLabel() const;
 
  LabelSampleListType* GetOutputLabel();
 
  otbSetObjectMemberMacro(AddGaussianNoiseFilter, Mean, double);
  otbGetObjectMemberConstMacro(AddGaussianNoiseFilter, Mean, double);
 
  otbSetObjectMemberMacro(AddGaussianNoiseFilter, Variance, double);
  otbGetObjectMemberConstMacro(AddGaussianNoiseFilter, Variance, double);
 
  itkSetMacro(BalancingFactor, unsigned int);
  itkGetMacro(BalancingFactor, unsigned int);
 
protected:
  void GenerateData() override;
 
  void ComputeMaxSampleFrequency();
 
  DataObjectPointer MakeOutput(DataObjectPointerArraySizeType idx) override;
  using Superclass::MakeOutput;
 
  ListSampleToBalancedListSampleFilter();
  ~ListSampleToBalancedListSampleFilter() override
  {
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  ListSampleToBalancedListSampleFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  GaussianAdditiveNoisePointerType m_AddGaussianNoiseFilter;
  std::vector<unsigned int>        m_MultiplicativeCoefficient;
  unsigned int                     m_BalancingFactor;
 
}; // end of class ListSampleToBalancedListSampleFilter
 
} // end of namespace Statistics
} // end of namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbListSampleToBalancedListSampleFilter.hxx"
#endif
 
#endif