mitkImageAccessorTest.cpp

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

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

#include "itkBarrier.h"
#include "mitkIOUtil.h"
#include "mitkImage.h"
#include "mitkImagePixelReadAccessor.h"
#include "mitkImagePixelWriteAccessor.h"
#include "mitkImageReadAccessor.h"
#include "mitkImageTimeSelector.h"
#include "mitkImageWriteAccessor.h"
#include <fstream>
#include <itkMultiThreader.h>
#include <itksys/SystemTools.hxx>
#include <mitkTestingMacros.h>
#include <cstdlib>
#include <ctime>

struct ThreadData
{
  itk::Barrier::Pointer m_Barrier; // holds a pointer to the used barrier
  mitk::Image::Pointer data;       // some random data
  int m_NoOfThreads;               // holds the number of generated threads
  bool m_Successful;               // to check if everything worked
};

itk::SimpleFastMutexLock testMutex;

ITK_THREAD_RETURN_TYPE ThreadMethod(void *data)
{
  /* extract data pointer from Thread Info structure */
  auto *pInfo = (struct itk::MultiThreader::ThreadInfoStruct *)data;

  // some data validity checking
  if (pInfo == nullptr)
  {
    return ITK_THREAD_RETURN_VALUE;
  }
  if (pInfo->UserData == nullptr)
  {
    return ITK_THREAD_RETURN_VALUE;
  }

  // obtain user data for processing
  auto *threadData = (ThreadData *)pInfo->UserData;

  srand(pInfo->ThreadID);

  mitk::Image::Pointer im = threadData->data;

  int nrSlices = im->GetDimension(2);

  // Create randomly a PixelRead- or PixelWriteAccessor for a slice and access all pixels in it.
  try
  {
    if (rand() % 2)
    {
      testMutex.Lock();
      mitk::ImageDataItem *iDi = im->GetSliceData(rand() % nrSlices);
      testMutex.Unlock();
      while (!iDi->IsComplete())
      {
      }

      // MITK_INFO << "pixeltype: " << im->GetPixelType().GetComponentTypeAsString();

      if ((im->GetPixelType().GetComponentTypeAsString() == "short") && (im->GetDimension() == 3))
      {
        // Use pixeltype&dimension specific read accessor

        int xlength = im->GetDimension(0);
        int ylength = im->GetDimension(1);

        mitk::ImagePixelReadAccessor<short, 2> readAccessor(im, iDi);

        itk::Index<2> idx;
        for (int i = 0; i < xlength; ++i)
        {
          for (int j = 0; j < ylength; ++j)
          {
            idx[0] = i;
            idx[1] = j;
            readAccessor.GetPixelByIndexSafe(idx);
          }
        }
      }
      else
      {
        // use general accessor
        mitk::ImageReadAccessor *iRA = new mitk::ImageReadAccessor(im, iDi);
        delete iRA;
      }
    }
    else
    {
      testMutex.Lock();
      mitk::ImageDataItem *iDi = im->GetSliceData(rand() % nrSlices);
      testMutex.Unlock();
      while (!iDi->IsComplete())
      {
      }

      if ((im->GetPixelType().GetComponentTypeAsString() == "short") && (im->GetDimension() == 3))
      {
        // Use pixeltype&dimension specific read accessor

        int xlength = im->GetDimension(0);
        int ylength = im->GetDimension(1);

        mitk::ImagePixelWriteAccessor<short, 2> writeAccessor(im, iDi);

        itk::Index<2> idx;
        for (int i = 0; i < xlength; ++i)
        {
          for (int j = 0; j < ylength; ++j)
          {
            idx[0] = i;
            idx[1] = j;
            short newVal = rand() % 16000;
            writeAccessor.SetPixelByIndexSafe(idx, newVal);
            short val = writeAccessor.GetPixelByIndexSafe(idx);
            if (val != newVal)
            {
              threadData->m_Successful = false;
            }
          }
        }
      }
      else
      {
        // use general accessor
        mitk::ImageWriteAccessor iB(im, iDi);
        void *pointer = iB.GetData();
        *((char *)pointer) = 0;
      }
    }
  }
  catch ( const mitk::MemoryIsLockedException &e )
  {
    threadData->m_Successful = false;
    e.Print(std::cout);
  }
  catch ( const mitk::Exception &e )
  {
    threadData->m_Successful = false;
    e.Print(std::cout);
  }

  // data processing end!
  threadData->m_Barrier->Wait();
  return ITK_THREAD_RETURN_VALUE;
}

int mitkImageAccessorTest(int argc, char *argv[])
{
  MITK_TEST_BEGIN("mitkImageAccessorTest");

  std::cout << "Loading file: ";
  if (argc == 0)
  {
    std::cout << "no file specified [FAILED]" << std::endl;
    return EXIT_FAILURE;
  }
  mitk::Image::Pointer image = nullptr;
  try
  {
    image = mitk::IOUtil::Load<mitk::Image>(std::string(argv[1]));

    if (image.IsNull())
    {
      MITK_TEST_FAILED_MSG(<< "file could not be loaded [FAILED]")
    }
  }
  catch ( const itk::ExceptionObject &ex )
  {
    MITK_TEST_FAILED_MSG(<< "Exception: " << ex.GetDescription() << "[FAILED]")
  }

  // CHECK INAPPROPRIATE AND SPECIAL USAGE

  // recursive mutex lock
  MITK_TEST_OUTPUT(<< "Testing a recursive mutex lock attempt, should end in an exception ...");

  MITK_TEST_FOR_EXCEPTION_BEGIN(mitk::Exception)
  mitk::ImageWriteAccessor first(image);
  mitk::ImageReadAccessor second(image);
  MITK_TEST_FOR_EXCEPTION_END(mitk::Exception)

  // ignore lock mechanism in read accessor
  try
  {
    mitk::ImageWriteAccessor first(image);
    mitk::ImageReadAccessor second(image, nullptr, mitk::ImageAccessorBase::IgnoreLock);
    MITK_TEST_CONDITION_REQUIRED(true, "Testing the option flag \"IgnoreLock\" in ReadAccessor");
  }
  catch (const mitk::Exception & /*e*/)
  {
    MITK_TEST_CONDITION_REQUIRED(false, "Ignoring the lock mechanism leads to exception.");
  }

  // CREATE THREADS

  image->GetGeometry()->Initialize();

  itk::MultiThreader::Pointer threader = itk::MultiThreader::New();
  unsigned int noOfThreads = 100;

  // initialize barrier
  itk::Barrier::Pointer barrier = itk::Barrier::New();
  barrier->Initialize(noOfThreads + 1); // add one for we stop the base thread when the worker threads are processing

  auto *threadData = new ThreadData;
  threadData->m_Barrier = barrier;
  threadData->m_NoOfThreads = noOfThreads;
  threadData->data = image;
  threadData->m_Successful = true;

  // spawn threads
  for (unsigned int i = 0; i < noOfThreads; ++i)
  {
    threader->SpawnThread(ThreadMethod, threadData);
  }
  // stop the base thread during worker thread execution
  barrier->Wait();

  // terminate threads
  for (unsigned int j = 0; j < noOfThreads; ++j)
  {
    threader->TerminateThread(j);
  }

  bool TestSuccessful = threadData->m_Successful;
  delete threadData;

  MITK_TEST_CONDITION_REQUIRED(TestSuccessful, "Testing image access from multiple threads");

  MITK_TEST_END();
}