otbWrapperTypes.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2020 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 otbWrapperTypes_h
#define otbWrapperTypes_h

#include <complex>
#include <array>
#include "itkRGBPixel.h"
#include "itkRGBAPixel.h"
#include "otbImage.h"
#include "otbVectorImage.h"
#include "otbVectorData.h"

namespace otb
{
namespace Wrapper
{

typedef enum {
  ParameterType_Int,
  ParameterType_Float,
  ParameterType_Double,
  ParameterType_String,
  ParameterType_StringList,
  ParameterType_InputFilename,
  ParameterType_InputFilenameList,
  ParameterType_OutputFilename,
  ParameterType_Directory,
  ParameterType_Choice,
  ParameterType_InputImage,
  ParameterType_InputImageList,
  ParameterType_InputVectorData,
  ParameterType_InputVectorDataList,
  ParameterType_OutputImage,
  ParameterType_OutputVectorData,
  ParameterType_Radius,
  ParameterType_Group,
  ParameterType_ListView,
  ParameterType_RAM,
  ParameterType_OutputProcessXML,
  ParameterType_InputProcessXML,
  ParameterType_Bool,
  ParameterType_MAX__
} ParameterType;

namespace
{
constexpr char const* parameterTypesStrings[] = {"Int",
                                                 "Float",
                                                 "Double",
                                                 "String",
                                                 "StringList",
                                                 "InputFilename",
                                                 "InputFilenameList",
                                                 "OutputFilename",
                                                 "Directory",
                                                 "Choice",
                                                 "InputImage",
                                                 "InputImageList",
                                                 "InputVectorData",
                                                 "InputVectorDataList",
                                                 "OutputImage",
                                                 "OutputVectorData",
                                                 "Radius",
                                                 "Group",
                                                 "ListView",
                                                 "RAM",
                                                 "OutputProcessXML",
                                                 "InputProcessXML",
                                                 "Bool"};
static_assert(std::extent<decltype(parameterTypesStrings)>::value == ParameterType_MAX__, "Wrong number of parameters in parameterTypesStrings");
}

// Free functions to convert from and to std::string
std::string ParameterTypeToString(ParameterType type);
ParameterType ParameterStringToType(const std::string& str);

typedef enum { UserLevel_Basic, UserLevel_Advanced } UserLevel;

typedef enum {
  // Not int8 because not handle by Gdal
  ImagePixelType_uint8,
  ImagePixelType_int16,
  ImagePixelType_uint16,
  ImagePixelType_int32,
  ImagePixelType_uint32,
  ImagePixelType_float,
  ImagePixelType_double,
  ImagePixelType_cint16,
  ImagePixelType_cint32,
  ImagePixelType_cfloat,
  ImagePixelType_cdouble,
} ImagePixelType;

typedef enum {
  ComplexImagePixelType_int16,
  ComplexImagePixelType_int32,
  ComplexImagePixelType_float,
  ComplexImagePixelType_double,
} ComplexImagePixelType;

typedef enum { Role_Input = 0, Role_Output } Role;

// enum used for the map projection choices
typedef enum {
  Elevation_DEM,
  Elevation_Average
  // Elevation_Tiff,
} ElevationType;


typedef otb::Image<unsigned char>  UInt8ImageType;
typedef otb::Image<short>          Int16ImageType;
typedef otb::Image<unsigned short> UInt16ImageType;
typedef otb::Image<int>            Int32ImageType;
typedef otb::Image<unsigned int>   UInt32ImageType;
typedef otb::Image<float>          FloatImageType;
typedef otb::Image<double>         DoubleImageType;

typedef otb::VectorImage<unsigned char>  UInt8VectorImageType;
typedef otb::VectorImage<short>          Int16VectorImageType;
typedef otb::VectorImage<unsigned short> UInt16VectorImageType;
typedef otb::VectorImage<int>            Int32VectorImageType;
typedef otb::VectorImage<unsigned int>   UInt32VectorImageType;
typedef otb::VectorImage<float>          FloatVectorImageType;
typedef otb::VectorImage<double>         DoubleVectorImageType;

typedef otb::Image<itk::RGBPixel<unsigned char>>  UInt8RGBImageType;
typedef otb::Image<itk::RGBAPixel<unsigned char>> UInt8RGBAImageType;

typedef std::complex<short>  Int16ComplexPixelType;
typedef std::complex<int>    Int32ComplexPixelType;
typedef std::complex<float>  FloatComplexPixelType;
typedef std::complex<double> DoubleComplexPixelType;

// Complex Image Type
typedef otb::Image<Int16ComplexPixelType, 2>  ComplexInt16ImageType;
typedef otb::Image<Int32ComplexPixelType, 2>  ComplexInt32ImageType;
typedef otb::Image<FloatComplexPixelType, 2>  ComplexFloatImageType;
typedef otb::Image<DoubleComplexPixelType, 2> ComplexDoubleImageType;

typedef otb::VectorImage<Int16ComplexPixelType, 2>  ComplexInt16VectorImageType;
typedef otb::VectorImage<Int32ComplexPixelType, 2>  ComplexInt32VectorImageType;
typedef otb::VectorImage<FloatComplexPixelType, 2>  ComplexFloatVectorImageType;
typedef otb::VectorImage<DoubleComplexPixelType, 2> ComplexDoubleVectorImageType;


typedef double VectorDataCoordinatePrecisionType;
typedef double VectorDataValuePrecisionType;
typedef otb::VectorData<VectorDataCoordinatePrecisionType, 2, VectorDataValuePrecisionType> VectorDataType;
typedef otb::ObjectList<VectorDataType> VectorDataListType;

typedef otb::ObjectList<FloatVectorImageType> FloatVectorImageListType;
typedef otb::ObjectList<FloatImageType>       FloatImageListType;

typedef itk::ImageBase<2> ImageBaseType;


} // end namespace Wrapper
} // end namespace otb

#endif // otbWrapperApplication_h_