otbListSampleToBalancedListSampleFilter.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ORFEO Toolbox
  Language:  C++
  Date:      $Date$
  Version:   $Revision$


  Copyright (c) Centre National d'Etudes Spatiales. All rights reserved.
  See OTBCopyright.txt for details.


     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __otbListSampleToBalancedListSampleFilter_h
#define __otbListSampleToBalancedListSampleFilter_h

#include "otbListSampleToListSampleFilter.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 typename Superclass::InputSampleListObjectType       InputSampleListObjectType;
  typedef typename Superclass::OutputSampleListObjectType      OutputSampleListObjectType;
  
  typedef otb::Statistics::GaussianAdditiveNoiseSampleListFilter
  <InputSampleListType, OutputSampleListType>                   GaussianAdditiveNoiseType;
  typedef typename GaussianAdditiveNoiseType::Pointer          GaussianAdditiveNoisePointerType;
  
  void SetInputLabel( const LabelSampleListType * label );
  void SetInputLabel( const LabelSampleListObjectType * labelPtr );

  const LabelSampleListType * GetLabelSampleList() const;
  
  const LabelSampleListObjectType * GetInputLabel() const;

  LabelSampleListType * GetOutputLabelSampleList();

  LabelSampleListObjectType * 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:
   virtual void GenerateData();
  
  void ComputeMaxSampleFrequency();

  DataObjectPointer MakeOutput(unsigned int idx);
  
  ListSampleToBalancedListSampleFilter();
  virtual ~ListSampleToBalancedListSampleFilter() {}
  void PrintSelf(std::ostream& os, itk::Indent indent) const;

private:
  ListSampleToBalancedListSampleFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  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.txx"
#endif

#endif