otbTrainDimensionalityReductionApplicationBase.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 otbTrainDimensionalityReductionApplicationBase_h
#define otbTrainDimensionalityReductionApplicationBase_h
 
#include "otbConfigure.h"
#include "otbWrapperApplication.h"
#include "otbDimensionalityReductionModelFactory.h"
 
// ListSample
#include "itkListSample.h"
#include "itkVariableLengthVector.h"
 
 
namespace otb
{
namespace Wrapper
{
 
template <class TInputValue, class TOutputValue>
class TrainDimensionalityReductionApplicationBase : public Application
{
public:
  typedef TrainDimensionalityReductionApplicationBase Self;
  typedef Application                                 Superclass;
  typedef itk::SmartPointer<Self>                     Pointer;
  typedef itk::SmartPointer<const Self>               ConstPointer;
 
  itkTypeMacro(TrainDimensionalityReductionApplicationBase, otb::Application);
 
  typedef TInputValue  InputValueType;
  typedef TOutputValue OutputValueType;
 
  typedef otb::VectorImage<InputValueType>    SampleImageType;
  typedef typename SampleImageType::PixelType PixelType;
 
  typedef otb::DimensionalityReductionModelFactory<InputValueType, OutputValueType> ModelFactoryType;
  typedef typename ModelFactoryType::DimensionalityReductionModelTypePointer ModelPointerType;
  typedef typename ModelFactoryType::DimensionalityReductionModelType        ModelType;
 
  typedef typename ModelType::InputSampleType     SampleType;
  typedef typename ModelType::InputListSampleType ListSampleType;
 
protected:
  TrainDimensionalityReductionApplicationBase();
  ~TrainDimensionalityReductionApplicationBase() override;
 
  void Train(typename ListSampleType::Pointer trainingListSample, std::string modelPath);
 
  void Reduce(typename ListSampleType::Pointer validationListSample, std::string modelPath);
 
  void DoInit() override;
 
private:
  void InitSOMParams();
  template <class somchoice>
  void TrainSOM(typename ListSampleType::Pointer trainingListSample, std::string modelPath);
  void BeforeTrainSOM(typename ListSampleType::Pointer trainingListSample, std::string modelPath);
 
#ifdef OTB_USE_SHARK
  void InitAutoencoderParams();
  void InitPCAParams();
 
  void BeforeTrainAutoencoder(typename ListSampleType::Pointer trainingListSample, std::string modelPath);
  template <class autoencoderchoice>
  void TrainAutoencoder(typename ListSampleType::Pointer trainingListSample, std::string modelPath);
 
  void TrainPCA(typename ListSampleType::Pointer trainingListSample, std::string modelPath);
#endif
};
 
} // end of namespace Wrapper
} // end of namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbTrainDimensionalityReductionApplicationBase.hxx"
#include "otbDimensionalityReductionTrainSOM.hxx"
#include <string>
 
#ifdef OTB_USE_SHARK
#include "otbDimensionalityReductionTrainAutoencoder.hxx"
#include "otbDimensionalityReductionTrainPCA.hxx"
#endif
#endif
 
#endif