/*=========================================================================

  Program:   ITK-SNAP
  Module:    $RCSfile: ImageWrapper.txx,v $
  Language:  C++
  Date:      $Date: 2010/10/14 16:21:04 $
  Version:   $Revision: 1.11 $
  Copyright (c) 2007 Paul A. Yushkevich

  This file is part of ITK-SNAP

  ITK-SNAP is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

  -----

  Copyright (c) 2003 Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.  See the above copyright notices for more information.

  -----

  Copyright (c) 2003 Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef NONORTHOGONALSLICER_TXX
#define NONORTHOGONALSLICER_TXX

#include "NonOrthogonalSlicer.h"
#include "FastLinearInterpolator.h"
#include "ImageRegionConstIteratorWithIndexOverride.h"

template <typename TInputImage, typename TOutputImage, typename TWorkerTraits>
NonOrthogonalSlicer<TInputImage, TOutputImage, TWorkerTraits>
::NonOrthogonalSlicer()
    : m_UseNearestNeighbor(true)
{
}

template <typename TInputImage, typename TOutputImage, typename TWorkerTraits>
NonOrthogonalSlicer<TInputImage, TOutputImage, TWorkerTraits>
::~NonOrthogonalSlicer()
{
}

template <typename TInputImage, typename TOutputImage, typename TWorkerTraits>
void
NonOrthogonalSlicer<TInputImage, TOutputImage, TWorkerTraits>
::GenerateOutputInformation()
{  
  // The output information can be left to defaults because it's in screen
  // space anyway and just does not matter for any geometry
  OutputImagePointer output = this->GetOutput();
  typename OutputImageType::SpacingType out_spacing;
  typename OutputImageType::DirectionType out_direction;
  typename OutputImageType::PointType out_origin;

  out_origin.Fill(0.0);
  out_spacing.Fill(1.0);
  out_direction.SetIdentity();

  // Set up the output region
  OutputImageRegionType out_region;
  for(int d = 0; d < SliceDimension; d++)
    {
    out_region.SetIndex(d, this->GetReferenceImage()->GetLargestPossibleRegion().GetIndex(d));
    out_region.SetSize(d, this->GetReferenceImage()->GetLargestPossibleRegion().GetSize(d));
    }

  output->SetSpacing(out_spacing);
  output->SetOrigin(out_origin);
  output->SetDirection(out_direction);
  output->SetLargestPossibleRegion(out_region);
  output->SetNumberOfComponentsPerPixel(this->GetInput()->GetNumberOfComponentsPerPixel());
}

template <typename TInputImage, typename TOutputImage, typename TWorkerTraits>
void
NonOrthogonalSlicer<TInputImage, TOutputImage, TWorkerTraits>
::GenerateInputRequestedRegion()
{
  // get pointers to the input and output
  InputImageType *inputPtr  =
    const_cast< InputImageType * >( this->GetInput() );

  // Request the entire input image
  if(inputPtr)
    inputPtr->SetRequestedRegionToLargestPossibleRegion();
}

template <typename TInputImage, typename TOutputImage, typename TWorkerTraits>
void
NonOrthogonalSlicer<TInputImage, TOutputImage, TWorkerTraits>
::DynamicThreadedGenerateData(const OutputImageRegionType &outputRegionForThread)
{
  // The input 4D image volume
  InputImageType *input = const_cast<InputImageType *>(this->GetInput());

  // The reference image
  const ReferenceImageBaseType *reference = this->GetReferenceImage();

  // The transform
  const TransformType *transform = this->GetTransform();

  // Length of the line along which we are going to be sampling
  int line_len = outputRegionForThread.GetSize(0);

  // Create an iterator over the output image
  typedef itk::ImageLinearIteratorWithIndex<OutputImageType> IterBase;
  typedef IteratorExtender<IterBase> IterType;

  // Determine the appropriate float/double type for the interpolator.
  typedef typename itk::NumericTraits<OutputComponentType>::MeasurementVectorType::ValueType FloatType;

  // Get the extents of the image cube that can be sampled
  itk::ContinuousIndex<double, InputImageDimension> cixCubeStart, cixCubeEnd;
  for(int d = 0; d < InputImageDimension; d++)
    {
    cixCubeStart[d] = input->GetBufferedRegion().GetIndex()[d] - 0.5;
    cixCubeEnd[d] =
        input->GetBufferedRegion().GetIndex()[d] +
        input->GetBufferedRegion().GetSize()[d] - 0.5;
    }

  // Create a fast interpolator for the input image - via the traits, allowing for
  // partial specialization for imageadapters and other such things
  TWorkerTraits worker(input);

  // Whether to use nn
  bool use_nn = this->GetUseNearestNeighbor();

  // Loop over the lines in the input image
  for(IterType it(this->GetOutput(), outputRegionForThread); !it.IsAtEnd(); it.NextLine())
    {
    // Get a pointer to the output pixels for this line
    OutputComponentType *outPixelPtr = it.GetPixelPointer(this->GetOutput());

    // Get the index of the first pixel - this is in 2D
    typename OutputImageType::IndexType outIndex = it.GetIndex();

    // Get the 3D index of the first pixel of the line
    typename ReferenceImageBaseType::IndexType idxStart;
    idxStart.Fill(0.0);
    for(int d = 0; d < SliceDimension; d++)
      idxStart[d] = outIndex[d];

    // Get the 3D index of the second pixel of the line
    typename ReferenceImageBaseType::IndexType idxNext = idxStart;
    idxNext[0] += 1;

    // Convert to a physical point relative to refernece image
    typename ReferenceImageBaseType::PointType pRefStart, pRefNext;
    reference->TransformIndexToPhysicalPoint(idxStart, pRefStart);
    reference->TransformIndexToPhysicalPoint(idxNext, pRefNext);

    // Apply the affine transform to this point - so it's relative to the input image
    typename ReferenceImageBaseType::PointType pInpStart, pInpNext;
    pInpStart = transform->TransformPoint(pRefStart);
    pInpNext = transform->TransformPoint(pRefNext);

    // Compute the sample point in input image space and the step
    itk::ContinuousIndex<double, InputImageDimension> cixSample, cixNext, cixStep;
    input->TransformPhysicalPointToContinuousIndex(pInpStart, cixSample);
    input->TransformPhysicalPointToContinuousIndex(pInpNext, cixNext);

    for(int d = 0; d < InputImageDimension; d++)
      cixStep[d] = cixNext[d] - cixSample[d];

    // Determine the starting and ending indices for the line
    int kStart = 0, kEnd = line_len - 1;
    bool skipLine = false;
    for(int d = 0; d < InputImageDimension; d++)
      {
      double x0 = cixCubeStart[d], x1 = cixCubeEnd[d], dx = cixStep[d], x = cixSample[d];

      // TODO: this may behave badly for small voxel sizes
      if(fabs(dx) < 1.0e-5)
        {
        if((x < x0 && x < x1) || (x > x0 && x > x1))
          {
          skipLine = true;
          break;
          }
        }
      else
        {
        double z0 = (x0 - x) / dx, z1 = (x1 - x) / dx;
        if(z1 > z0)
          {
          kStart = std::max(kStart, (int) floor(z0));
          kEnd = std::min(kEnd, (int) ceil(z1));
          }
        else
          {
          kStart = std::max(kStart, (int) floor(z1));
          kEnd = std::min(kEnd, (int) ceil(z0));
          }
        }
      }

    if(kStart >= line_len || kEnd <= 0)
      skipLine = true;

    // This should not happen but it does, must be a bug in the code
    if(kEnd <= kStart)
      skipLine = true;

    // Deal with skipped lines
    if(skipLine)
      {
      worker.SkipVoxels(line_len, &outPixelPtr);
      }
    else
      {
      // Skip the starting voxels
      if(kStart > 0)
        {
        // Skip the voxels
        worker.SkipVoxels(kStart, &outPixelPtr);

        // Update the sample location
        for(int d = 0; d < InputImageDimension; d++)
          cixSample[d] += kStart * cixStep[d];
        }

      // Process the voxels that cross the image cube
      for(int i = kStart; i <= kEnd; i++)
        {
        worker.ProcessVoxel(cixSample.GetDataPointer(), use_nn, &outPixelPtr);

        // Update the sample location
        for(int d = 0; d < InputImageDimension; d++)
          cixSample[d] += cixStep[d];
        }

      // Process the rest
      if(kEnd < line_len - 1)
        {
        worker.SkipVoxels((line_len - 1) - kEnd, &outPixelPtr);
        }
      }
    }
}



/* ===========================================================================================
 * DefaultNonOrthogonalSlicerWorkerTraits traits for itk::Image or itk::VectorImage
 * ===========================================================================================  */

template <class TInputImage, class TOutputImage>
DefaultNonOrthogonalSlicerWorkerTraits<TInputImage, TOutputImage>
::DefaultNonOrthogonalSlicerWorkerTraits(TInputImage *image)
  : m_Interpolator(image)
{
  m_NumComponents = m_Interpolator.GetPointerIncrement();
  m_Buffer = new double[m_NumComponents];
}

template <class TInputImage, class TOutputImage>
DefaultNonOrthogonalSlicerWorkerTraits<TInputImage, TOutputImage>
::~DefaultNonOrthogonalSlicerWorkerTraits()
{
  delete m_Buffer;
}

template <class TInputImage, class TOutputImage>
void
DefaultNonOrthogonalSlicerWorkerTraits<TInputImage, TOutputImage>
::ProcessVoxel(double *cix, bool use_nn, OutputComponentType **out_ptr)
{
  // Perform the interpolation
  typename Interpolator::InOut status =
      use_nn
      ? m_Interpolator.InterpolateNearestNeighbor(cix,  m_Buffer)
      : m_Interpolator.Interpolate(cix, m_Buffer);

  if(status == Interpolator::INSIDE || status == Interpolator::BORDER)
    {
    for(int k = 0; k < m_NumComponents; k++)
      *(*out_ptr)++ = static_cast<OutputComponentType>(m_Buffer[k]);
    }
  else
    {
    SkipVoxels(1, out_ptr);
    }
}

template <class TInputImage, class TOutputImage>
void
DefaultNonOrthogonalSlicerWorkerTraits<TInputImage, TOutputImage>
::SkipVoxels(int n, OutputComponentType **out_ptr)
{
  // TODO: this is problematic, why are we using zero? !!!!
  int n_total = n * m_NumComponents;
  for(int k = 0; k < n_total; k++)
    *(*out_ptr)++ = 0; //itk::NumericTraits<OutputComponentType>::Zero;
}

/* ===========================================================================================
 * DefaultNonOrthogonalSlicerWorkerTraits traits for itk::VectorImageToImageAdaptor
 * ===========================================================================================  */

/*
 * Traits for the component extracting image adaptor. Note that in the call to the
 * constructor for the interpolator, we are passing the buffer pointer offset by
 * the component index, and only requesting a single component to be sampled
 */
template <typename TPixelType, unsigned int Dimension, typename TOutputImage>
DefaultNonOrthogonalSlicerWorkerTraits<
  itk::VectorImageToImageAdaptor<TPixelType, Dimension>,
  TOutputImage>
::DefaultNonOrthogonalSlicerWorkerTraits(AdaptorType *adaptor)
  : m_Interpolator(adaptor,
                   adaptor->GetBufferPointer() + adaptor->GetPixelAccessor().GetExtractComponentIdx(),
                   adaptor->GetPixelAccessor().GetVectorLength(), 1)
{
  m_NumComponents = m_Interpolator.GetPointerIncrement();
  m_ExtractComponent = adaptor->GetPixelAccessor().GetExtractComponentIdx();
}

template <typename TPixelType, unsigned int Dimension, typename TOutputImage>
DefaultNonOrthogonalSlicerWorkerTraits<
  itk::VectorImageToImageAdaptor<TPixelType, Dimension>,
  TOutputImage>
::~DefaultNonOrthogonalSlicerWorkerTraits()
{
}

template <typename TPixelType, unsigned int Dimension, typename TOutputImage>
void
DefaultNonOrthogonalSlicerWorkerTraits<
  itk::VectorImageToImageAdaptor<TPixelType, Dimension>,
  TOutputImage>
::ProcessVoxel(double *cix, bool use_nn, OutputComponentType **out_ptr)
{
  // Perform the interpolation
  typename Interpolator::InOut status =
      use_nn
      ? m_Interpolator.InterpolateNearestNeighbor(cix, &m_BufferValue)
      : m_Interpolator.Interpolate(cix, &m_BufferValue);

  if(status == Interpolator::INSIDE)
    *(*out_ptr)++ = static_cast<OutputComponentType>(m_BufferValue);
  else
    *(*out_ptr)++ = 0;
}

template <typename TPixelType, unsigned int Dimension, typename TOutputImage>
void
DefaultNonOrthogonalSlicerWorkerTraits<
  itk::VectorImageToImageAdaptor<TPixelType, Dimension>,
  TOutputImage>
::SkipVoxels(int n, OutputComponentType **out_ptr)
{
  for(int i = 0; i < n; i++)
    *(*out_ptr)++ = 0;
}

/* ===========================================================================================
 * DefaultNonOrthogonalSlicerWorkerTraits traits for generic itk::ImageAdaptor
 * ===========================================================================================  */

template <typename TPixelType, unsigned int Dimension, typename TAccessor, typename TOutputImage>
DefaultNonOrthogonalSlicerWorkerTraits<
  itk::ImageAdaptor<itk::VectorImage<TPixelType, Dimension>, TAccessor>,
  TOutputImage>
::DefaultNonOrthogonalSlicerWorkerTraits(AdaptorType *adaptor)
  : m_Interpolator(adaptor, adaptor->GetBufferPointer(), adaptor->GetPixelAccessor().GetVectorLength()),
    m_VectorPixel(adaptor->GetPixelAccessor().GetVectorLength()),
    m_Adaptor(adaptor)
{
  m_NumComponents = m_Interpolator.GetPointerIncrement();
  m_Buffer = new double[m_NumComponents];
}

template <typename TPixelType, unsigned int Dimension, typename TAccessor, typename TOutputImage>
DefaultNonOrthogonalSlicerWorkerTraits<
  itk::ImageAdaptor<itk::VectorImage<TPixelType, Dimension>, TAccessor>,
  TOutputImage>
::~DefaultNonOrthogonalSlicerWorkerTraits()
{
  delete m_Buffer;
}

template <typename TPixelType, unsigned int Dimension, typename TAccessor, typename TOutputImage>
void
DefaultNonOrthogonalSlicerWorkerTraits<
  itk::ImageAdaptor<itk::VectorImage<TPixelType, Dimension>, TAccessor>,
  TOutputImage>
::ProcessVoxel(double *cix, bool use_nn, OutputComponentType **out_ptr)
{
  // Perform the interpolation
  typename Interpolator::InOut status =
      use_nn
      ? m_Interpolator.InterpolateNearestNeighbor(cix, m_Buffer)
      : m_Interpolator.Interpolate(cix, m_Buffer);

  const typename InternalImageType::PixelType &vpref = m_VectorPixel;

  if(status == Interpolator::INSIDE)
    {
    // Cast to the vector pixel type
    for(int i = 0; i < m_NumComponents; i++)
      m_VectorPixel[i] = static_cast<OutputComponentType>(m_Buffer[i]);

    // Apply the accessor
    *(*out_ptr)++ =
        m_Adaptor->GetPixelAccessor().Get(m_VectorPixel.GetDataPointer());
    }
  else
    {
    *(*out_ptr)++ = 0;
    }
}

template <typename TPixelType, unsigned int Dimension, typename TAccessor, typename TOutputImage>
void
DefaultNonOrthogonalSlicerWorkerTraits<
  itk::ImageAdaptor<itk::VectorImage<TPixelType, Dimension>, TAccessor>,
  TOutputImage>
::SkipVoxels(int n, OutputComponentType **out_ptr)
{
  for(int i = 0; i < n; i++)
    *(*out_ptr)++ = 0;
}

/* ===========================================================================================
 * DefaultNonOrthogonalSlicerWorkerTraits traits for RLEImage
 * ===========================================================================================  */

template <typename TPixel, unsigned int Dimension, typename TCounter, typename TOutputImage>
DefaultNonOrthogonalSlicerWorkerTraits<RLEImage<TPixel, Dimension, TCounter>, TOutputImage>
::DefaultNonOrthogonalSlicerWorkerTraits(InputImageType *image)
  : m_Image(image)
{
}

template <typename TPixel, unsigned int Dimension, typename TCounter, typename TOutputImage>
DefaultNonOrthogonalSlicerWorkerTraits<RLEImage<TPixel, Dimension, TCounter>, TOutputImage>
::~DefaultNonOrthogonalSlicerWorkerTraits()
{
}

template <typename TPixel, unsigned int Dimension, typename TCounter, typename TOutputImage>
void
DefaultNonOrthogonalSlicerWorkerTraits<RLEImage<TPixel, Dimension, TCounter>, TOutputImage>
::ProcessVoxel(double *cix, bool itkNotUsed(use_nn), OutputComponentType **out_ptr)
{
  // We simply have to round cix to the closest index, check if it's inside the buffer
  // and call GetPixel(). There is not a faster way
  itk::Index<Dimension> idx;
  for(unsigned int k = 0; k < Dimension; k++)
    idx[k] = (int)(cix[k] + 0.5);

  if(m_Image->GetBufferedRegion().IsInside(idx))
    {
    *(*out_ptr)++ = m_Image->GetPixel(idx);
    }
  else
    {
    *(*out_ptr)++ = 0;
    }
}

template <typename TPixel, unsigned int Dimension, typename TCounter, typename TOutputImage>
void
DefaultNonOrthogonalSlicerWorkerTraits<RLEImage<TPixel, Dimension, TCounter>, TOutputImage>
::SkipVoxels(int n, OutputComponentType **out_ptr)
{
  for(int i = 0; i < n; i++)
    *(*out_ptr)++ = 0;
}


#endif // NONORTHOGONALSLICER_TXX
