otbLineDetectorImageFilterBase.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 otbLineDetectorImageFilterBase_hxx
#define otbLineDetectorImageFilterBase_hxx
 
#include "otbLineDetectorImageFilterBase.h"
 
#include "itkDataObject.h"
 
#include "itkConstantPadImageFilter.h"
#include "itkConstNeighborhoodIterator.h"
#include "itkNeighborhoodInnerProduct.h"
#include "itkImageRegionIterator.h"
#include "itkNeighborhoodAlgorithm.h"
#include "itkProgressReporter.h"
#include "otbMacro.h"
#include "otbMath.h"
 
namespace otb
{
 
template <class TInputImage, class TOutputImage, class TOutputImageDirection, class InterpolatorType>
LineDetectorImageFilterBase<TInputImage, TOutputImage, TOutputImageDirection, InterpolatorType>::LineDetectorImageFilterBase()
{
  this->SetNumberOfRequiredOutputs(2);
  this->SetNumberOfRequiredOutputs(1);
  m_Radius.Fill(1);
  m_LengthLine         = 1;
  m_WidthLine          = 0;
  m_Threshold          = 0;
  m_NumberOfDirections = 4;
  m_FaceList.Fill(0);
  // THOMAS : hence base constructor
  //  this->SetNthOutput(0, OutputImageType::New());
  //  this->SetNthOutput(1, OutputImageType::New());
}
 
template <class TInputImage, class TOutputImage, class TOutputImageDirection, class InterpolatorType>
void LineDetectorImageFilterBase<TInputImage, TOutputImage, TOutputImageDirection, InterpolatorType>::GenerateInputRequestedRegion()
{
  // call the superclass' implementation of this method
  Superclass::GenerateInputRequestedRegion();
 
  // get pointers to the input and output
  typename Superclass::InputImagePointer  inputPtr  = const_cast<TInputImage*>(this->GetInput());
  typename Superclass::OutputImagePointer outputPtr = this->GetOutput();
 
  if (!inputPtr || !outputPtr)
  {
    return;
  }
 
  // get a copy of the input requested region (should equal the output
  // requested region)
  typename TInputImage::RegionType inputRequestedRegion;
  inputRequestedRegion = inputPtr->GetRequestedRegion();
 
  // Define the size of the region by the radius
  m_Radius[1] = static_cast<unsigned int>(3 * (2 * m_WidthLine + 1) + 2);
  m_Radius[0] = 2 * m_LengthLine + 1;
 
  // Define the size of the facelist by taking into account the rotation of the region
  m_FaceList[0] = static_cast<unsigned int>(std::sqrt(static_cast<double>((m_Radius[0] * m_Radius[0]) + (m_Radius[1] * m_Radius[1]))) + 1);
  m_FaceList[1] = m_FaceList[0];
 
  otbMsgDevMacro(<< "Radius   : " << m_Radius[0] << " " << m_Radius[1]);
  otbMsgDevMacro(<< "-> FaceList : " << m_FaceList[0] << " " << m_FaceList[1]);
 
  // pad the input requested region by the operator radius
  inputRequestedRegion.PadByRadius(m_FaceList);
 
  // crop the input requested region at the input's largest possible region
  if (inputRequestedRegion.Crop(inputPtr->GetLargestPossibleRegion()))
  {
    inputPtr->SetRequestedRegion(inputRequestedRegion);
    return;
  }
  else
  {
    // Couldn't crop the region (requested region is outside the largest
    // possible region).  Throw an exception.
 
    // store what we tried to request (prior to trying to crop)
    inputPtr->SetRequestedRegion(inputRequestedRegion);
 
    // build an exception
    itk::InvalidRequestedRegionError e(__FILE__, __LINE__);
    std::ostringstream               msg;
    msg << static_cast<const char*>(this->GetNameOfClass()) << "::GenerateInputRequestedRegion()";
    e.SetLocation(msg.str());
    e.SetDescription("Requested region is (at least partially) outside the largest possible region.");
    e.SetDataObject(inputPtr);
    throw e;
  }
}
 
/*
 * Set up state of filter before multi-threading.
 * InterpolatorType::SetInputImage is not thread-safe and hence
 * has to be set up before ThreadedGenerateData
 */
template <class TInputImage, class TOutputImage, class TOutputImageDirection, class InterpolatorType>
void LineDetectorImageFilterBase<TInputImage, TOutputImage, TOutputImageDirection, InterpolatorType>::BeforeThreadedGenerateData()
{
  typename OutputImageType::Pointer output = this->GetOutput();
  output->FillBuffer(0);
  typename OutputImageType::Pointer outputDirection = this->GetOutputDirection();
  outputDirection->FillBuffer(0);
}
 
template <class TInputImage, class TOutputImage, class TOutputImageDirection, class InterpolatorType>
void LineDetectorImageFilterBase<TInputImage, TOutputImage, TOutputImageDirection, InterpolatorType>::ThreadedGenerateData(
    const OutputImageRegionType& outputRegionForThread, itk::ThreadIdType threadId)
{
 
  typename InputImageType::ConstPointer input = this->GetInput();
 
  InterpolatorPointer interpolator2 = InterpolatorType::New();
  interpolator2->SetInputImage(input);
 
  itk::ZeroFluxNeumannBoundaryCondition<InputImageType>               nbc;
  itk::ConstNeighborhoodIterator<InputImageType>                      bit, cit;
  typename itk::ConstNeighborhoodIterator<InputImageType>::OffsetType off;
  itk::ImageRegionIterator<OutputImageType>                           it;
  itk::ImageRegionIterator<OutputImageType>                           itdir;
 
  // Allocate output
  typename OutputImageType::Pointer output    = this->GetOutput();
  typename OutputImageType::Pointer outputDir = this->GetOutputDirection();
 
  // Find the data-set boundary "faces"
  typename itk::NeighborhoodAlgorithm::ImageBoundaryFacesCalculator<InputImageType>::FaceListType           faceList;
  typename itk::NeighborhoodAlgorithm::ImageBoundaryFacesCalculator<InputImageType>::FaceListType::iterator fit;
 
  itk::NeighborhoodAlgorithm::ImageBoundaryFacesCalculator<InputImageType> bC;
  faceList = bC(input, outputRegionForThread, m_FaceList);
 
  // support progress methods/callbacks
  itk::ProgressReporter progress(this, threadId, outputRegionForThread.GetNumberOfPixels());
 
  typename TInputImage::IndexType                bitIndex;
  typename InterpolatorType::ContinuousIndexType Index;
 
  // --------------------------------------------------------------------------
 
  // Number of direction
  const unsigned int NB_DIR = this->GetNumberOfDirections();
  // Number of zone
  const int NB_ZONE = 3;
  // Definition of the 4 directions
  // double Theta[NB_DIR];
  // ROMAIN
  double* Theta = new double[NB_DIR];
 
  // La rotation nulle correspond a un contour horizontal -> 0 !!
  for (unsigned int i = 0; i < NB_DIR; ++i)
  {
    Theta[i] = (CONST_PI * (i / double(NB_DIR)));
    /*    if(Theta[i]>CONST_PI)
          Theta[i] = Theta[i]-CONST_PI;
        if((i/double(NB_DIR))==0.5)
          Theta[i]=0.; */
  }
 
  // Number of the zone
  unsigned int zone;
 
  // Intensity of the linear feature
  double R;
 
  // Direction of detection
  double Direction = 0.;
 
  // Pixel location in the input image
  int X, Y;
 
  // Pixel location after rotation in the system axis of the region
  double xout, yout;
 
  // location of the central pixel in the input image
  int Xc, Yc;
 
  // location of the central pixel between zone 1 and 2 and between zone 1 and 3
  int Yc12, Yc13;
 
  //---------------------------------------------------------------------------
  otbMsgDevMacro(<< "Theta    : " << Theta[0] << " " << Theta[1] << " " << Theta[2] << " " << Theta[3]);
 
  // Process each of the boundary faces.  These are N-d regions which border
  // the edge of the buffer.
 
  // bool interiorFace = true;
 
  for (fit = faceList.begin(); fit != faceList.end(); ++fit)
  {
    bit = itk::ConstNeighborhoodIterator<InputImageType>(m_Radius, input, *fit);
    cit = itk::ConstNeighborhoodIterator<InputImageType>(m_FaceList, input, *fit);
 
    it    = itk::ImageRegionIterator<OutputImageType>(output, *fit);
    itdir = itk::ImageRegionIterator<OutputImageType>(outputDir, *fit);
 
    bit.OverrideBoundaryCondition(&nbc);
    bit.GoToBegin();
    cit.OverrideBoundaryCondition(&nbc);
    cit.GoToBegin();
 
    otbMsgDevMacro(<< " ------------------- FaceList --------------------------");
 
    while ((!bit.IsAtEnd()) && (!cit.IsAtEnd()))
    {
      InterpolatorPointer interpolator = InterpolatorType::New();
      // Location of the central pixel of the region
      off.Fill(0);
      bitIndex = bit.GetIndex(off);
      Xc       = bitIndex[0];
      Yc       = bitIndex[1];
 
      // JULIEN :  If the processed region is the center face
      // the input image can be used for the interpolation
      // if (interiorFace)
      //  {
      //  interpolator->SetInputImage(input);
      //  }
      // else we must feed the interpolator with a partial image corresponding
      // to the boundary conditions
      // else
      //  {
      typename InputImageType::RegionType tempRegion;
      typename InputImageType::SizeType   tempSize;
      tempSize[0] = 2 * m_FaceList[0] + 1;
      tempSize[1] = 2 * m_FaceList[1] + 1;
      tempRegion.SetSize(tempSize);
      typename itk::ConstNeighborhoodIterator<InputImageType>::OffsetType tempIndex;
      tempIndex[0] = off[0] - m_FaceList[0];
      tempIndex[1] = off[1] - m_FaceList[1];
      tempRegion.SetIndex(cit.GetIndex(tempIndex));
      typename InputImageType::Pointer tempImage = InputImageType::New();
      tempImage->SetRegions(tempRegion);
      tempImage->Allocate();
 
      for (unsigned int p = 0; p <= 2 * m_FaceList[0]; ++p)
      {
        for (unsigned int q = 0; q <= 2 * m_FaceList[1]; q++)
        {
          typename itk::ConstNeighborhoodIterator<InputImageType>::OffsetType index;
          index[0] = p - m_FaceList[0];
          index[1] = q - m_FaceList[1];
          tempImage->SetPixel(cit.GetIndex(index), cit.GetPixel(index));
        }
      }
      interpolator->SetInputImage(tempImage);
      // }
 
      // Location of the central pixel between zone 1 and zone 2
      Yc12 = Yc - m_WidthLine - 1;
 
      // Location of the central pixel between zone 1 and zone 3
      Yc13 = Yc + m_WidthLine + 1;
 
      // Contains for the 4 directions the the pixels belonging to each zone
      // std::vector<double> PixelValues[NB_DIR][NB_ZONE];
      // ROMAIN
      std::vector<double>** PixelValues = nullptr;
      PixelValues                       = new std::vector<double>*[NB_DIR];
      for (unsigned int i = 0; i < NB_DIR; ++i)
      {
        PixelValues[i] = nullptr;
        PixelValues[i] = new std::vector<double>[NB_ZONE];
      }
      // otbMsgDevMacro( << "\tCentre Xc/Yc="<<Xc<<" "<<Yc<<" Yc12/Yc13="<<Yc12<<" "<<Yc13);
      // Loop on the region
      for (unsigned int i = 0; i < m_Radius[0]; ++i)
        for (unsigned int j = 0; j < m_Radius[1]; ++j)
        {
 
          off[0] = i - m_Radius[0] / 2;
          off[1] = j - m_Radius[1] / 2;
 
          bitIndex = bit.GetIndex(off);
          X        = bitIndex[0];
          Y        = bitIndex[1];
 
          // We determine in the horizontal direction with which zone the pixel belongs.
          if (Y < Yc12)
            zone = 1;
          else if ((Yc12 < Y) && (Y < Yc13))
            zone = 0;
          else if (Y > Yc13)
            zone = 2;
          else
            continue;
          // otbMsgDevMacro( << "\t\tPoint traite (i, j)=("<<i<<","<<j<<") -> X, Y="<<X<<","<<Y<<"  zone="<<zone);
          // Loop on the directions
          for (unsigned int dir = 0; dir < NB_DIR; ++dir)
          {
            // ROTATION( (X-Xc), (Y-Yc), Theta[dir], xout, yout);
 
            xout = (X - Xc) * std::cos(Theta[dir]) - (Y - Yc) * std::sin(Theta[dir]);
            yout = (X - Xc) * std::sin(Theta[dir]) + (Y - Yc) * std::cos(Theta[dir]);
 
            Index[0] = static_cast<CoordRepType>(xout + Xc);
            Index[1] = static_cast<CoordRepType>(yout + Yc);
 
            PixelValues[dir][zone].push_back(static_cast<double>(interpolator->EvaluateAtContinuousIndex(Index)));
          }
        } // end of the loop on the pixels of the region
 
      R         = 0.;
      Direction = 0.;
 
      // Loop on the 4 directions
 
      for (unsigned int dir = 0; dir < NB_DIR; ++dir)
      {
 
        double Rtemp = this->ComputeMeasure(&PixelValues[dir][0], &PixelValues[dir][1], &PixelValues[dir][2]);
 
        if (Rtemp > R)
        {
          R         = Rtemp;
          Direction = Theta[dir];
        }
 
      } // end of the loop on the directions
 
      // otbMsgDevMacro( << "\t\tR, Direction : "<<R<<","<<Direction);
      if (R >= this->GetThreshold())
      {
 
        // Assignment of this value to the output pixel
        it.Set(static_cast<OutputPixelType>(R));
 
        // Assignment of this value to the "outputdir" pixel
        itdir.Set(static_cast<OutputPixelType>(Direction));
      }
      else
      {
 
        it.Set(itk::NumericTraits<OutputPixelType>::Zero);
 
        itdir.Set(static_cast<OutputPixelType>(0));
      }
      ++bit;
      ++cit;
      ++it;
      ++itdir;
      // interiorFace = false;
      progress.CompletedPixel();
 
      // ROMAIN
      for (unsigned int i = 0; i < NB_DIR; ++i)
      {
        delete[] PixelValues[i];
        PixelValues[i] = nullptr;
      }
      delete[] PixelValues;
      PixelValues = nullptr;
    }
  }
  delete[] Theta;
}
 
template <class TInputImage, class TOutputImage, class TOutputImageDirection, class InterpolatorType>
double LineDetectorImageFilterBase<TInputImage, TOutputImage, TOutputImageDirection, InterpolatorType>::ComputeMeasure(std::vector<double>* itkNotUsed(m1),
                                                                                                                       std::vector<double>* itkNotUsed(m2),
                                                                                                                       std::vector<double>* itkNotUsed(m3))
{
  return 0;
}
 
template <class TInputImage, class TOutputImage, class TOutputImageDirection, class InterpolatorType>
void LineDetectorImageFilterBase<TInputImage, TOutputImage, TOutputImageDirection, InterpolatorType>::PrintSelf(std::ostream& os, itk::Indent indent) const
{
  Superclass::PrintSelf(os, indent);
  os << indent << "Length: " << m_LengthLine << std::endl;
  os << indent << "Width: " << m_WidthLine << std::endl;
}
 
} // end namespace otb
 
#endif