/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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.txt
 *
 *  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.
 *
 *=========================================================================*/

#include <iostream>
#include "itkImageRegion.h"
#include "itkFloatingPointExceptions.h"

int itkImageRegionTest(int, char* [] )
{

  const unsigned int dimension = 3;

  typedef double                         TCoordRepType;
  typedef itk::ImageRegion< dimension >  RegionType;
  typedef RegionType::IndexType          IndexType;
  typedef RegionType::SizeType           SizeType;
  typedef RegionType::SliceRegion        SliceRegionType;
  typedef itk::ContinuousIndex< TCoordRepType, dimension >
                                         ContinuousIndexType;

  typedef itk::NumericTraits<IndexType::IndexValueType>
                                         IndexNumericTraits;
  typedef itk::NumericTraits<ContinuousIndexType::ValueType>
                                         ContinuousIndexNumericTraits;

  bool passed = true;

  SizeType sizeA = {{ 10, 20, 30 }};
  SizeType sizeB = {{  5, 10, 15 }};

  IndexType startA = {{ 12, 12, 12 }};
  IndexType startB = {{ 14, 14, 14 }};
  IndexType endA = {{ 21, 31, 41 }};

  RegionType regionA;
  RegionType regionB;

  regionA.SetSize(  sizeA  );
  regionA.SetIndex( startA );

  if( regionA.GetUpperIndex() != endA )
    {
    std::cout << "Upper index is " << regionA.GetUpperIndex() << " instead of " << endA << std::endl;
    return EXIT_FAILURE;
    }
  RegionType regionC;
  regionC.SetIndex( startA );
  regionC.SetUpperIndex( endA );
  if( regionC.GetSize() != sizeA )
    {
    std::cout << "Size is " << regionC.GetSize() << " instead of " << sizeA << std::endl;
    return EXIT_FAILURE;
    }

  // Take slices of a region
  try
    {
    SliceRegionType sliceA;
    sliceA = regionA.Slice(0);
    std::cout << "regionA.Slice(0): " << sliceA;
    }
  catch (itk::ExceptionObject &err)
    {
    std::cout << "Caught unexpected exception" << err;
    return EXIT_FAILURE;
    }

  try
    {
    SliceRegionType sliceA;
    sliceA = regionA.Slice(1);
    std::cout << "regionA.Slice(1): " << sliceA;
    }
  catch (itk::ExceptionObject &err)
    {
    std::cout << "Caught unexpected exception" << err;
    return EXIT_FAILURE;
    }

  try
    {
    SliceRegionType sliceA;
    sliceA = regionA.Slice(2);
    std::cout << "regionA.Slice(2): " << sliceA;
    }
  catch (itk::ExceptionObject &err)
    {
    std::cout << "Caught unexpected exception" << err;
    return EXIT_FAILURE;
    }

  try
    {
    SliceRegionType sliceA;
    sliceA = regionA.Slice(20);
    std::cout << "regionA.Slice(20): " << sliceA;
    std::cout << "Failed to catch expected exception" << std::endl;
    return EXIT_FAILURE;
    }
  catch (itk::ExceptionObject &err)
    {
    std::cout << "Caught expected exception" << err;
    }

  regionB.SetSize(  sizeB  );
  regionB.SetIndex( startB );

  //Test IsInside( integerIndex )
  IndexType index = startA;
  if( !regionA.IsInside( index ) )
    {
    std::cout << "Error with IsInside 1." << std::endl;
    passed = false;
    }
  index[0] = startA[0] + sizeA[0] - 1;
  if( !regionA.IsInside( index ) )
    {
    std::cout << "Error with IsInside 2." << std::endl;
    passed = false;
    }
  index[0] = startA[0]-1;
  if( regionA.IsInside( index ) )
    {
    std::cout << "Error with IsInside 3. Expected false." << std::endl;
    passed = false;
    }
  index[0] = IndexNumericTraits::max();
  if( regionA.IsInside( index ) )
    {
    std::cout << "Error with IsInside 4. Expected false." << std::endl;
    passed = false;
    }
  if( IndexNumericTraits::is_signed )
    {
    index[0] = IndexNumericTraits::min();
    if( regionA.IsInside( index ) )
      {
      std::cout << "Error with IsInside 5. Expected false." << std::endl;
      passed = false;
      }
    }

  //Test IsInside( ContinuousIndex )
  ContinuousIndexType indexC;
  indexC[0] = startA[0];
  indexC[1] = startA[1];
  indexC[2] = startA[2];
  if( !regionA.IsInside( indexC ) )
    {
    std::cout << "Error with IsInside 1C." << std::endl;
    passed = false;
    }
  indexC[0] = startA[0] + sizeA[0] - 0.5;
  indexC[1] = startA[1] + sizeA[1] - 0.5;
  indexC[2] = startA[2] + sizeA[2] - 0.5;
  if( !regionA.IsInside( indexC ) )
    {
    std::cout << "Error with IsInside 2C." << std::endl;
    passed = false;
    }
  indexC[0] = startA[0]-1;
  if( regionA.IsInside( indexC ) )
    {
    std::cout << "Error with IsInside 3C. Expected false." << std::endl
              << "  indexC: " << indexC << std::endl
              << "  start & size: "
              << startA << " " << sizeA << std::endl;
    passed = false;
    }
  std::cout << "Testing ContinuousIndexNumericTraits::min()." << std::endl;
  indexC[0] = ContinuousIndexNumericTraits::min();
  if( regionA.IsInside( indexC ) )
    {
    std::cout << "Error with IsInside 5C. Expected false." << std::endl;
    passed = false;
    }
  /* Some tests cause floating point exceptions, so
   * only run them when Floating Point Exceptions are not enabled. */
  if( ! itk::FloatingPointExceptions::GetEnabled() )
    {
    std::cout << "Floating Point Exceptions's are disabled. " << std::endl;
    std::cout << "...Proceeding with tests that can generate Floating Point Exceptions's." << std::endl;

    /* Generates overflow exception */
    std::cout << "Testing ContinuousIndexNumericTraits::max()." << std::endl;
    indexC[0] = ContinuousIndexNumericTraits::max();
    if( regionA.IsInside( indexC ) )
      {
      std::cout << "Error with IsInside 4C. Expected false." << std::endl;
      passed = false;
      }
    /* Note for NaN. IsInside doesn't properly catch NaN. It gets cast to integer
     * which means it becomes a large negative number so it falls outside of
     * region bounds. In this way the test returns false appropriately, but for
     * the wrong reasons. If this test fails, then the compiler is handling a
     * cast of NaN to integer differently. */
    if( ContinuousIndexNumericTraits::has_quiet_NaN )
      {
      std::cout << "Testing quiet NaN behavior." << std::endl;
      indexC[0] = ContinuousIndexNumericTraits::quiet_NaN();
      if( regionA.IsInside( indexC ) )
        {
        std::cout << "Error with IsInside 6C. Expected false." << std::endl;
        passed = false;
        }
      }
    /* Note that signaling_NaN seems to simply wrap quiet_NaN */
    if( ContinuousIndexNumericTraits::has_signaling_NaN )
      {
      std::cout << "Testing signaling NaN behavior." << std::endl;
      indexC[0] = ContinuousIndexNumericTraits::signaling_NaN();
      if( regionA.IsInside( indexC ) )
        {
        std::cout << "Error with IsInside 7C. Expected false." << std::endl;
        passed = false;
        }
      }
    std::cout << "Testing infinity behavior." << std::endl;
    indexC[0] = ContinuousIndexNumericTraits::infinity();
    if( regionA.IsInside( indexC ) )
      {
      std::cout << "Error with IsInside 8C. Expected false." << std::endl;
      passed = false;
      }
    }// ! FloatingPointExceptions::GetEnabled()
  else
    {
    std::cout << "Not testing behavior that triggers Floating Point Exceptions." << std::endl;
    }

  if( ! itk::FloatingPointExceptions::GetEnabled() &&
      ContinuousIndexNumericTraits::has_quiet_NaN )
    {
    std::cout << "Floating Point Exceptions's are disabled. Test some more NaN-related behavior..."
              << std::endl;
    /* NaN behavior
     * Experimenting. Can be removed before final merge.
     * Issue with ImageRegion::IsInside is that it's using RoundHalfIntegerUp
     * and thereby casting to integer and
     * rounding, and thus NaN's get converted to a large negative int and
     * are only caught indirectly. */

    indexC.Fill(13);
    if( regionA.IsInside(indexC) )
      std::cout << "13,13,13 IsInside" << std::endl;
    else
      std::cout << "13,13,13 is not inside !" << std::endl;

    indexC[0] = ContinuousIndexNumericTraits::quiet_NaN();
    if( regionA.IsInside(indexC) )
      std::cout << "** NaN,13,13 *is* inside. **" << std::endl;
    else
      std::cout << "NaN,13,13 is not inside" << std::endl;

    std::cout << "NaN < -1 = " << (indexC[0] < -1.0) << std::endl;
    std::cout << "NaN > -1 = " << (indexC[0] > -1.0) << std::endl;

    TCoordRepType NaN = ContinuousIndexNumericTraits::quiet_NaN();
    std::cout << "RoundHalfIntegerUp(NaN): "
              << itk::Math::RoundHalfIntegerUp< TCoordRepType >(NaN) << std::endl;
    std::cout
      << "RoundHalfIntegerUp< TCoordRepType >(NaN) < static_cast<TCoordRepType> (0): "
      << ( itk::Math::RoundHalfIntegerUp< TCoordRepType >(NaN) <
      static_cast<TCoordRepType> (0) ) << std::endl;
    std::cout
      << "RoundHalfIntegerUp< TCoordRepType >(NaN) > static_cast<TCoordRepType> (0): "
      << ( itk::Math::RoundHalfIntegerUp< TCoordRepType >(NaN) >
      static_cast<TCoordRepType> (0) ) << std::endl;
    TCoordRepType rf = itk::Math::RoundHalfIntegerUp< TCoordRepType >(NaN);
    std::cout << "TCoordRepType = RoundHalfIntegerUp(NaN): " << rf << std::endl;
    RegionType::IndexValueType rl =
      itk::Math::RoundHalfIntegerUp< RegionType::IndexValueType, TCoordRepType >(NaN);
    std::cout << "RegionType::IndexValueType type = RoundHalfIntegerUp(NaN): "
              << rl << std::endl;
    std::cout << "static_cast<RegionType::IndexValueType>( NaN ): "
              << static_cast<RegionType::IndexValueType> (NaN)
              << std::endl;
    std::cout << "NumericTraits<RegionType::IndexValueType>::min(): "
              << itk::NumericTraits<RegionType::IndexValueType>::min()
              << std::endl;
    std::cout << "TCoordRepType min(): " << ContinuousIndexNumericTraits::min()
              << std::endl;
    std::cout << "...end NaN tests." << std::endl << std::endl;
    }

  //Test IsInside( region )
  if( ! regionA.IsInside( regionB ) )
    {
    passed = false;
    }

  if( regionB.IsInside( regionA ) )
    {
    passed = false;
    }

  // Test ShrinkByRadius
  IndexType shrinkIndex;
  shrinkIndex[0] = 22;
  shrinkIndex[1] = 343;
  shrinkIndex[2] = 5;
  SizeType  shrinkSize;
  shrinkSize[0]  = 33;
  shrinkSize[1]  = 21;
  shrinkSize[2]  = 3;
  RegionType shrinkRegion;
  shrinkRegion.SetIndex( shrinkIndex );
  shrinkRegion.SetSize ( shrinkSize );
  RegionType padAndShrinkRegion = shrinkRegion;

  itk::OffsetValueType offsetValueRadius = 4;
  padAndShrinkRegion.PadByRadius( offsetValueRadius );
  padAndShrinkRegion.ShrinkByRadius( offsetValueRadius );
  if( shrinkRegion != padAndShrinkRegion )
    {
    passed = false;
    std::cerr << "Pad and shrink by an OffSetValueType radius failed." << std::endl;
    }

  SizeType sizeRadius;
  sizeRadius[0] = 0;
  sizeRadius[1] = 1;
  sizeRadius[2] = 2;
  padAndShrinkRegion.PadByRadius( sizeRadius );
  padAndShrinkRegion.ShrinkByRadius( sizeRadius );
  if( shrinkRegion != padAndShrinkRegion )
    {
    passed = false;
    std::cerr << "Pad and shrink by an SizeType radius failed." << std::endl;
    }

  RegionType::IndexValueArrayType indexValueArrayRadius;
  indexValueArrayRadius[0] = 0;
  indexValueArrayRadius[1] = 1;
  indexValueArrayRadius[2] = 2;
  padAndShrinkRegion.PadByRadius( indexValueArrayRadius );
  padAndShrinkRegion.ShrinkByRadius( indexValueArrayRadius );
  if( shrinkRegion != padAndShrinkRegion )
    {
    passed = false;
    std::cerr << "Pad and shrink by an IndexValueArrayType radius failed." << std::endl;
    }

  if (passed)
    {
    std::cout << "ImageRegion test passed." << std::endl;
    return EXIT_SUCCESS;
    }
  else
    {
    std::cout << "ImageRegion test failed." << std::endl;
    return EXIT_FAILURE;
    }

}