otbWrapperInputImageParameter.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 otbWrapperInputImageParameter_h
#define otbWrapperInputImageParameter_h
 
 
#include "otbImageFileReader.h"
#include "otbClampImageFilter.h"
#include "otbWrapperParameter.h"
 
#include "itkImageBase.h"
 
#include <string>
 
namespace otb
{
namespace Wrapper
{
class OTBApplicationEngine_EXPORT InputImageParameter : public Parameter
{
public:
  typedef InputImageParameter           Self;
  typedef Parameter                     Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(InputImageParameter, Parameter);
 
  struct Connector
  {
    itk::Object::Pointer app;
    std::string          key;
    bool                 isMem;
  };
 
  bool SetFromFileName(std::string filename);
  itkGetConstReferenceMacro(FileName, std::string);
 
  void SetConnection(Connector c)
  {
    m_Connection = std::move(c);
  }
 
  const Connector& GetConnection() const
  {
    return m_Connection;
  }
 
  void SetConnectionMode(bool isMem)
  {
    m_Connection.isMem = isMem;
  }
 
  ImageBaseType const* GetImage() const;
  ImageBaseType*       GetImage();
 
  UInt8ImageType*  GetUInt8Image();
  UInt16ImageType* GetUInt16Image();
  Int16ImageType*  GetInt16Image();
  UInt32ImageType* GetUInt32Image();
  Int32ImageType*  GetInt32Image();
  FloatImageType*  GetFloatImage();
  DoubleImageType* GetDoubleImage();
 
  UInt8VectorImageType*  GetUInt8VectorImage();
  UInt16VectorImageType* GetUInt16VectorImage();
  Int16VectorImageType*  GetInt16VectorImage();
  UInt32VectorImageType* GetUInt32VectorImage();
  Int32VectorImageType*  GetInt32VectorImage();
  FloatVectorImageType*  GetFloatVectorImage();
  DoubleVectorImageType* GetDoubleVectorImage();
 
  UInt8RGBImageType*  GetUInt8RGBImage();
  UInt8RGBAImageType* GetUInt8RGBAImage();
 
  // Complex image
  ComplexInt16ImageType*  GetComplexInt16Image();
  ComplexInt32ImageType*  GetComplexInt32Image();
  ComplexFloatImageType*  GetComplexFloatImage();
  ComplexDoubleImageType* GetComplexDoubleImage();
 
  ComplexInt16VectorImageType*  GetComplexInt16VectorImage();
  ComplexInt32VectorImageType*  GetComplexInt32VectorImage();
  ComplexFloatVectorImageType*  GetComplexFloatVectorImage();
  ComplexDoubleVectorImageType* GetComplexDoubleVectorImage();
 
  template <class TImageType>
  TImageType* GetImage();
 
  void SetImage(ImageBaseType* image);
 
 
  template <class TInputImage, class TOutputImage>
  TOutputImage* CastImage();
 
  bool HasValue() const override;
  void ClearValue() override;
 
  ParameterType GetType() const override;
  std::string   ToString() const override;
  void FromString(const std::string& value) override;
 
protected:
  InputImageParameter();
 
  ~InputImageParameter() override = default;
 
private:
  InputImageParameter(const Parameter&) = delete;
  void operator=(const Parameter&) = delete;
 
  std::string                 m_FileName;
  itk::ProcessObject::Pointer m_Reader = nullptr;
 
  ImageBaseType::Pointer      m_Image = nullptr;
 
  itk::ProcessObject::Pointer m_OutputCaster = nullptr;
  itk::DataObject::Pointer    m_OutputCasted = nullptr;
 
private:
  template <typename TOutputImage, typename TInputImage>
  TOutputImage* Cast(TInputImage*);
 
  std::string m_PreviousFileName;
 
  bool        m_UseFilename = true;
 
  Connector   m_Connection{};
 
}; // End class InputImage Parameter
 
} // End namespace Wrapper
} // End namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbWrapperInputImageParameter.hxx"
#endif
 
#endif