otbWrapperOutputImageParameter.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 otbWrapperOutputImageParameter_h
#define otbWrapperOutputImageParameter_h
 
//#include "otbVectorImage.h"
#include "itkImageBase.h"
#include "otbWrapperParameter.h"
#include "otbImageFileWriter.h"
#include <string>
#include "otbMultiImageFileWriter.h"
 
namespace otb
{
namespace Wrapper
{
class OTBApplicationEngine_EXPORT OutputImageParameter : public Parameter
{
public:
  typedef OutputImageParameter          Self;
  typedef Parameter                     Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(OutputImageParameter, Parameter);
 
  itkSetObjectMacro(Image, ImageBaseType);
 
  itkGetObjectMacro(Image, ImageBaseType);
 
  void SetValue(ImageBaseType* image);
 
  ImageBaseType* GetValue(void);
 
  itkSetMacro(PixelType, ImagePixelType);
  itkGetMacro(PixelType, ImagePixelType);
 
  itkSetMacro(DefaultPixelType, ImagePixelType);
  itkGetMacro(DefaultPixelType, ImagePixelType);
 
  itkSetMacro(RAMValue, unsigned int);
  itkGetMacro(RAMValue, unsigned int);
 
  bool IsMultiWritingEnabled();
 
  void Reset() override
  {
    m_PixelType = m_DefaultPixelType;
  }
 
  static std::string ConvertPixelTypeToString(ImagePixelType type);
 
  static bool ConvertStringToPixelType(const std::string& value, ImagePixelType& type);
 
  bool HasValue() const override;
 
  void SetFileName(const char* filename);
  void SetFileName(const std::string& filename);
 
  itkGetStringMacro(FileName);
 
  void Write();
 
  itk::ProcessObject* GetWriter();
 
  void InitializeWriters(otb::MultiImageFileWriter::Pointer multi = otb::MultiImageFileWriter::Pointer() );
 
  std::string CheckFileName(bool fixMissingExtension = false);
 
  ParameterType GetType() const override
  {
    return ParameterType_OutputImage;
  }
 
  std::string ToString() const override
  {
    return GetFileName();
  }
 
  void FromString(const std::string& value) override
  {
    SetFileName(value);
  }
 
protected:
  OutputImageParameter();
 
  ~OutputImageParameter() override;
 
private:
  OutputImageParameter(const Parameter&) = delete;
  void operator=(const Parameter&) = delete;
 
  template <typename TInputImage>
  void SwitchInput(TInputImage*);
 
  template <typename TOutputImage, typename TInputImage>
  void ClampAndWriteVectorImage(TInputImage*);
 
  // FloatVectorImageType::Pointer m_Image;
  ImageBaseType::Pointer m_Image;
 
  itk::ProcessObject::Pointer m_InputCaster;
  itk::ProcessObject::Pointer m_OutputCaster;
 
  itk::ProcessObject::Pointer m_Writer;
 
  std::string m_FileName;
 
  ImagePixelType m_PixelType;
  ImagePixelType m_DefaultPixelType;
 
  unsigned int m_RAMValue;
 
  otb::MultiImageFileWriter::Pointer m_MultiWriter;
}; // End class OutputImage Parameter
 
} // End namespace Wrapper
} // End namespace otb
 
#endif