otbExtractROIBase.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2022 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 otbExtractROIBase_hxx
#define otbExtractROIBase_hxx
 
#include "otbExtractROIBase.h"
#include "itkImageRegionIterator.h"
#include "itkObjectFactory.h"
#include "itkProgressReporter.h"
#include "otbMacro.h"
 
namespace otb
{
 
template <class TInputImage, class TOutputImage>
ExtractROIBase<TInputImage, TOutputImage>::ExtractROIBase()
  : itk::ImageToImageFilter<TInputImage, TOutputImage>(), m_StartX(0), m_StartY(0), m_SizeX(0), m_SizeY(0)
{
}
 
template <class TInputImage, class TOutputImage>
void ExtractROIBase<TInputImage, TOutputImage>::PrintSelf(std::ostream& os, itk::Indent indent) const
{
  Superclass::PrintSelf(os, indent);
 
  os << indent << "ExtractionRegion: " << m_ExtractionRegion << std::endl;
  os << indent << "OutputImageRegion: " << m_OutputImageRegion << std::endl;
}
 
template <class TInputImage, class TOutputImage>
void ExtractROIBase<TInputImage, TOutputImage>::CallCopyOutputRegionToInputRegion(InputImageRegionType& destRegion, const OutputImageRegionType& srcRegion)
{
  destRegion = srcRegion;
 
  OutputImageIndexType index = destRegion.GetIndex();
 
  for (unsigned int i = 0; i < InputImageDimension; ++i)
  {
    index[i] += m_ExtractionRegion.GetIndex()[i];
  }
  destRegion.SetIndex(index);
}
 
template <class TInputImage, class TOutputImage>
void ExtractROIBase<TInputImage, TOutputImage>::SetInternalExtractionRegion(InputImageRegionType extractRegion)
{
  m_ExtractionRegion = extractRegion;
 
  unsigned int         nonzeroSizeCount = 0;
  InputImageSizeType   inputSize        = extractRegion.GetSize();
  OutputImageSizeType  outputSize;
  OutputImageIndexType outputIndex;
 
  for (unsigned int i = 0; i < InputImageDimension; ++i)
  {
    if (inputSize[i])
    {
      outputSize[nonzeroSizeCount]  = inputSize[i];
      outputIndex[nonzeroSizeCount] = 0;
      nonzeroSizeCount++;
    }
  }
 
  if (nonzeroSizeCount != OutputImageDimension)
  {
    itkExceptionMacro("Extraction Region not consistent with output image");
  }
 
  m_OutputImageRegion.SetSize(outputSize);
  m_OutputImageRegion.SetIndex(outputIndex);
 
  this->Modified();
}
 
template <class TInputImage, class TOutputImage>
void ExtractROIBase<TInputImage, TOutputImage>::SetExtractionRegion(InputImageRegionType roi)
{
  m_SizeX  = roi.GetSize()[0];
  m_SizeY  = roi.GetSize()[1];
  m_StartX = roi.GetIndex()[0];
  m_StartY = roi.GetIndex()[1];
 
  this->Modified();
}
 
template <class TInputImage, class TOutputImage>
void ExtractROIBase<TInputImage, TOutputImage>::GenerateInputRequestedRegion()
{
  Superclass::GenerateInputRequestedRegion();
 
  typename Superclass::InputImagePointer  inputPtr  = const_cast<InputImageType*>(this->GetInput());
  typename Superclass::OutputImagePointer outputPtr = this->GetOutput();
 
  if (!inputPtr)
  {
    return;
  }
  if (!outputPtr)
  {
    return;
  }
  InputImageRegionType requestedRegion = outputPtr->GetRequestedRegion();
  InputImageIndexType  index           = requestedRegion.GetIndex();
  InputImageIndexType  offset          = m_ExtractionRegion.GetIndex();
 
  for (unsigned int i = 0; i < InputImageDimension; ++i)
  {
    index[i] += offset[i];
  }
  requestedRegion.SetIndex(index);
  inputPtr->SetRequestedRegion(requestedRegion);
}
 
template <class TInputImage, class TOutputImage>
void ExtractROIBase<TInputImage, TOutputImage>::GenerateOutputInformation()
{
  Superclass::GenerateOutputInformation();
 
  // Compute the area to extract
  // If SizeX/Y == 0, then set SizeX/Y to image size
  typename Superclass::InputImageConstPointer inputPtr = this->GetInput();
 
  // Check if input exists or not before doing anything
  if (!inputPtr)
  {
    return;
  }
 
  // Get the input image
  // const InputImageRegionType& inputRegion = inputPtr->GetRequestedRegion();
  const InputImageRegionType& inputRegion = inputPtr->GetLargestPossibleRegion();
 
  if ((m_SizeX == 0) || (m_SizeX > (inputRegion.GetSize()[0] - m_StartX)))
  {
    m_SizeX = inputRegion.GetSize()[0] - m_StartX;
  }
  if ((m_SizeY == 0) || (m_SizeY > (inputRegion.GetSize()[1] - m_StartY)))
  {
    m_SizeY = inputRegion.GetSize()[1] - m_StartY;
  }
 
  InputImageIndexType start;
  start[0] = m_StartX;
  start[1] = m_StartY;
  InputImageSizeType size;
  size[0] = m_SizeX;
  size[1] = m_SizeY;
  InputImageRegionType desiredRegion;
  desiredRegion.SetSize(size);
  desiredRegion.SetIndex(start);
  // Call to the base class method for region initialization
  this->SetInternalExtractionRegion(desiredRegion);
 
  // do not call the superclass' implementation of this method since
  // this filter allows the input the output to be of different dimensions
 
  // get pointers to the input and output
  typename Superclass::OutputImagePointer outputPtr = this->GetOutput();
  //  typename Superclass::InputImageConstPointer  inputPtr  = this->GetInput();
 
  if (!inputPtr)
  {
    return;
  }
  if (!outputPtr)
  {
    return;
  }
 
  // Set the output image size to the same value as the extraction region.
  outputPtr->SetLargestPossibleRegion(m_OutputImageRegion);
 
  // Set the output spacing and origin
  const itk::ImageBase<InputImageDimension>* phyData;
 
  phyData = dynamic_cast<const itk::ImageBase<InputImageDimension>*>(this->GetInput());
 
  if (!phyData)
  {
    // pointer could not be cast back down
    itkExceptionMacro(<< "otb::ExtractROIBase::GenerateOutputInformation "
                      << "cannot cast input to " << typeid(itk::ImageBase<InputImageDimension>*).name());
  }
 
  // Copy what we can from the image from spacing and origin of the input
  // This logic needs to be augmented with logic that select which
  // dimensions to copy
  const typename InputImageType::SpacingType&   inputSpacing   = inputPtr->GetSignedSpacing();
  const typename InputImageType::DirectionType& inputDirection = inputPtr->GetDirection();
  const typename InputImageType::PointType&     inputOrigin    = inputPtr->GetOrigin();
 
  typename OutputImageType::SpacingType   outputSpacing;
  typename OutputImageType::DirectionType outputDirection;
  typename OutputImageType::PointType     outputOrigin;
 
  if (static_cast<unsigned int>(OutputImageDimension) > static_cast<unsigned int>(InputImageDimension))
  {
    unsigned int i;
    // copy the input to the output and fill the rest of the
    // output with zeros.
    for (i = 0; i < InputImageDimension; ++i)
    {
      outputSpacing[i] = inputSpacing[i];
      outputOrigin[i]  = inputOrigin[i] + static_cast<double>(m_ExtractionRegion.GetIndex()[i]) * outputSpacing[i];
      for (unsigned int dim = 0; dim < InputImageDimension; ++dim)
      {
        outputDirection[i][dim] = inputDirection[i][dim];
      }
    }
    for (; i < OutputImageDimension; ++i)
    {
      outputSpacing[i] = 1.0;
      outputOrigin[i]  = 0.0;
      for (unsigned int dim = 0; dim < InputImageDimension; ++dim)
      {
        outputDirection[i][dim] = 0.0;
      }
      outputDirection[i][i] = 1.0;
    }
  }
  else
  {
    // copy the non-collapsed part of the input spacing and origing to the output
    int nonZeroCount = 0;
    for (unsigned int i = 0; i < InputImageDimension; ++i)
    {
      if (m_ExtractionRegion.GetSize()[i] == 0)
        continue;
 
      outputSpacing[nonZeroCount] = inputSpacing[i];
      outputOrigin[nonZeroCount]  = inputOrigin[i] + static_cast<double>(m_ExtractionRegion.GetIndex()[i]) * outputSpacing[i];
      for (unsigned int dim = 0; dim < OutputImageDimension; ++dim)
      {
        outputDirection[nonZeroCount][dim] = inputDirection[nonZeroCount][dim];
      }
      nonZeroCount++;
    }
  }
 
  // set the spacing and origin
  outputPtr->SetSignedSpacing(outputSpacing);
  outputPtr->SetDirection(outputDirection);
  outputPtr->SetOrigin(outputOrigin);
 
  // Thomas Feuvrier:
  // ITK has this code. But not in our case, because the number of component per pixel depends on the bands selected by the user.
  // This parameter is given in the underlying classes.
  //    outputPtr->SetNumberOfComponentsPerPixel(
  //       inputPtr->GetNumberOfComponentsPerPixel() );
  //
}
 
} // end namespace otb
 
#endif