ComplexImageReadWrite.cxx

Example source code (ComplexImageReadWrite.cxx):

/*
 * Copyright (C) 1999-2011 Insight Software Consortium
 * 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.
 */


//  This example illustrates how to read and write an image of pixel type
//  \code{std::complex}. The complex type is defined as an integral part of the
//  C++ language.
//
//  We start by including the headers of the complex class, the image, and the
//  reader and writer classes.
//
//  \index{otb::ImageFileRead!Complex images}
//  \index{otb::ImageFileWrite!Complex images}
//  \index{Complex images!Instantiation}
//  \index{Complex images!Reading}
//  \index{Complex images!Writing}

#include <complex>
#include "otbImage.h"
#include "otbImageFileReader.h"
#include "otbImageFileWriter.h"

int main(int argc, char* argv[])
{

  // Verify the number of parameters in the command line
  if (argc < 3)
  {
    std::cerr << "Usage: " << std::endl;
    std::cerr << argv[0] << " inputImageFile  outputImageFile " << std::endl;
    return EXIT_FAILURE;
  }

  // The image dimension and pixel type must be declared. In this case we use the
  // \code{std::complex<>} as the pixel type. Using the dimension and pixel type
  // we proceed to instantiate the image type.

  const unsigned int Dimension = 2;

  using PixelType = std::complex<float>;
  using ImageType = otb::Image<PixelType, Dimension>;

  // The image file reader and writer types are instantiated using the image
  // type. We can then create objects for both of them.

  using ReaderType = otb::ImageFileReader<ImageType>;
  using WriterType = otb::ImageFileWriter<ImageType>;

  ReaderType::Pointer reader = ReaderType::New();
  WriterType::Pointer writer = WriterType::New();

  // Filenames should be provided for both the reader and the writer. In this
  // particular example we take those filenames from the command line arguments.

  reader->SetFileName(argv[1]);
  writer->SetFileName(argv[2]);

  // Here we simply connect the output of the reader as input to the writer.
  // This simple program could be used for converting complex images from one
  // fileformat to another.

  writer->SetInput(reader->GetOutput());

  // The execution of this short pipeline is triggered by invoking the Update()
  // method of the writer. This invocation must be placed inside a try/catch
  // block since its execution may result in exceptions being thrown.

  try
  {
    writer->Update();
  }
  catch (itk::ExceptionObject& err)
  {
    std::cerr << "ExceptionObject caught !" << std::endl;
    std::cerr << err << std::endl;
    return EXIT_FAILURE;
  }

  // For a more interesting use of this code, you may want to add a filter in
  // between the reader and the writer and perform any complex image to complex
  // image operation.

  return EXIT_SUCCESS;
}