/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 "itkVectorImage.h"

#include "itkImageRegionIteratorWithIndex.h"
#include "itkMaskImageFilter.h"

int
itkMaskImageFilterTest(int, char *[])
{

  // Define the dimension of the images
  constexpr unsigned int myDimension{ 3 };

  // Declare the types of the images
  using myImageType1 = itk::Image<float, myDimension>;
  using myImageType2 = itk::Image<unsigned short, myDimension>;
  using myImageType3 = itk::Image<float, myDimension>;

  // Declare the type of the size
  using mySizeType = itk::Size<myDimension>;

  // Declare the type of the Region
  using myRegionType = itk::ImageRegion<myDimension>;

  // Create two images
  auto inputImageA = myImageType1::New();
  auto inputImageB = myImageType2::New();

  // Define their size and region
  auto size = mySizeType::Filled(2);

  const myRegionType region{ size };

  // Initialize Image A
  inputImageA->SetRegions(region);
  inputImageA->Allocate();

  // Initialize Image B
  inputImageB->SetRegions(region);
  inputImageB->Allocate();


  // Declare Iterator types appropriate for each image
  using myIteratorType1 = itk::ImageRegionIteratorWithIndex<myImageType1>;
  using myIteratorType2 = itk::ImageRegionIteratorWithIndex<myImageType2>;
  using myIteratorType3 = itk::ImageRegionIteratorWithIndex<myImageType3>;

  // Create one iterator for Image A (this is a light object)
  myIteratorType1 it1(inputImageA, inputImageA->GetBufferedRegion());

  // Initialize the content of Image A
  std::cout << "First operand " << std::endl;
  while (!it1.IsAtEnd())
  {
    it1.Set(255.0);
    std::cout << it1.Get() << std::endl;
    ++it1;
  }

  // Create one iterator for Image B (this is a light object)
  myIteratorType2 it2(inputImageB, inputImageB->GetBufferedRegion());

  // Initialize the content of Image B
  // Set to mask first 2 pixels and last 2 pixels and leave the rest as is
  std::cout << "Second operand " << std::endl;
  for (unsigned int i = 0; i < 2; ++i, ++it2)
  {
    it2.Set(0);
  }

  while (!it2.IsAtEnd())
  {
    it2.Set(3);
    ++it2;
  }

  for (unsigned int i = 0; i < 3; ++i, --it2)
  {
    it2.Set(0);
  }

  it2.GoToBegin();
  while (!it2.IsAtEnd())
  {
    std::cout << it2.Get() << std::endl;
    ++it2;
  }

  // Declare the type for the Mask image filter
  using myFilterType = itk::MaskImageFilter<myImageType1, myImageType2, myImageType3>;


  // Create a mask  Filter
  auto filter = myFilterType::New();


  // Connect the input images
  filter->SetInput1(inputImageA);
  filter->SetInput2(inputImageB);
  filter->SetOutsideValue(50);

  // Get the Smart Pointer to the Filter Output
  const myImageType3::Pointer outputImage = filter->GetOutput();


  // Execute the filter
  filter->Update();

  // Create an iterator for going through the image output
  myIteratorType3 it3(outputImage, outputImage->GetBufferedRegion());

  // Print the content of the result image
  std::cout << " Result " << std::endl;
  while (!it3.IsAtEnd())
  {
    std::cout << it3.Get() << std::endl;
    ++it3;
  }


  filter->Print(std::cout);

  // Vector image tests
  using myVectorImageType = itk::VectorImage<float, myDimension>;

  auto inputVectorImage = myVectorImageType::New();
  inputVectorImage->SetRegions(region);
  inputVectorImage->SetNumberOfComponentsPerPixel(3);
  inputVectorImage->Allocate();

  using myVectorFilterType = itk::MaskImageFilter<myVectorImageType, myImageType2, myVectorImageType>;

  auto vectorFilter = myVectorFilterType::New();
  vectorFilter->SetInput1(inputVectorImage);
  vectorFilter->SetMaskImage(inputImageB);

  myVectorImageType::PixelType outsideValue = vectorFilter->GetOutsideValue();
  if (outsideValue.GetSize() != 0)
  {
    std::cerr << "Default outside value prior to running filter does not "
              << "have 0 components." << std::endl;
    return EXIT_FAILURE;
  }

  try
  {
    vectorFilter->Update();
  }
  catch (const itk::ExceptionObject & e)
  {
    std::cout << "Caught unexpected exception when default outside value "
              << "is used." << e;
  }

  // Check that the outside value consists of three zeros.
  const myVectorImageType::PixelType outsideValue3 = vectorFilter->GetOutsideValue();
  myVectorImageType::PixelType       threeZeros(3, 0.0f);
  if (outsideValue3 != threeZeros)
  {
    std::cerr << "Unexpected default outside value after running filter "
              << "on image with 3 components." << std::endl;
    std::cerr << "Got " << outsideValue3 << " and expected " << threeZeros << std::endl;
    return EXIT_FAILURE;
  }

  // Try out non-zero outside value.
  outsideValue = myVectorImageType::PixelType(3);
  outsideValue[0] = 1.0;
  outsideValue[1] = 2.0;
  outsideValue[2] = 3.0;
  vectorFilter->SetOutsideValue(outsideValue);

  try
  {
    vectorFilter->Update();
  }
  catch (const itk::ExceptionObject & e)
  {
    std::cerr << "Caught unexpected exception:" << e;
    return EXIT_FAILURE;
  }

  // Add components to image
  inputVectorImage->Initialize();
  inputVectorImage->SetRegions(region);
  inputVectorImage->SetNumberOfComponentsPerPixel(5);
  inputVectorImage->Allocate();

  try
  {
    vectorFilter->Update();
    std::cerr << "Expected exception not caught when number of components in."
              << "outside value is not the same as number of components in "
              << "image and non-default value is used." << std::endl;
    return EXIT_FAILURE;
  }
  catch (const itk::ExceptionObject & e)
  {
    std::cout << "Caught expected exception: " << e;
  }

  // Reset the outside value to zero vector of length 23.
  myVectorImageType::PixelType zeros23(23, 0.0f);
  vectorFilter->SetOutsideValue(zeros23);

  try
  {
    vectorFilter->Update();
  }
  catch (const itk::ExceptionObject & e)
  {
    std::cerr << "Caught unexpected exception when resetting outside value "
              << "to  vector of length 0." << e;
    return EXIT_FAILURE;
  }

  // Check updated outside value.
  const myVectorImageType::PixelType outsideValue5 = vectorFilter->GetOutsideValue();
  myVectorImageType::PixelType       fiveZeros(5, 0.0f);
  if (outsideValue5 != fiveZeros)
  {
    std::cerr << "Unexpected default outside value after running filter "
              << "on image with 5 components." << std::endl;
    std::cerr << "Got " << outsideValue5 << " and expected " << fiveZeros << std::endl;
    return EXIT_FAILURE;
  }

  std::cout << "[PASSED]" << std::endl;

  // All objects should be automatically destroyed at this point
  return EXIT_SUCCESS;
}
