ITK/Examples/Iterators/ConstNeighborhoodIterator

This example demonstrates how to traverse an itkImage with access to a rectangular neighborhood around the center pixel of the iterator (without write access to the pixels).

ConstNeighborhoodIterator.cxx

<source lang="cpp">

1. include "itkImage.h"
2. include "itkImageFileReader.h"
3. include "itkConstNeighborhoodIterator.h"

int main(int argc, char*argv[]) {

 if(argc < 2)
   {
   std::cerr << "Required: filename" << std::endl;
   return EXIT_FAILURE;
   }

 typedef itk::Image<unsigned char, 2>  ImageType;

 typedef itk::ImageFileReader<ImageType> ReaderType;
 ReaderType::Pointer reader = ReaderType::New();
 reader->SetFileName(argv[1]);
 reader->Update();

 ImageType::Pointer image = reader->GetOutput();
 
 ImageType::SizeType regionSize;
 regionSize[0] = 50;
 regionSize[1] = 1;

 ImageType::IndexType regionIndex;
 regionIndex[0] = 0;
 regionIndex[1] = 0;

 ImageType::RegionType region;
 region.SetSize(regionSize);
 region.SetIndex(regionIndex);

 ImageType::SizeType radius;
 radius[0] = 1;
 radius[1] = 1;

 itk::ConstNeighborhoodIterator<ImageType> iterator(radius, image,region);

 while(!iterator.IsAtEnd())
   {
   for(unsigned int i = 0; i < 9; i++)
     {
     ImageType::IndexType index = iterator.GetIndex(i);
     std::cout << index[0] << " " << index[1] << std::endl;

     bool IsInBounds;
     iterator.GetPixel(i, IsInBounds);

     }
   ++iterator;
   }

 return EXIT_SUCCESS;

}

</source>

CMakeLists.txt

<syntaxhighlight lang="cmake"> cmake_minimum_required(VERSION 3.9.5)

project(ConstNeighborhoodIterator)

find_package(ITK REQUIRED) include(${ITK_USE_FILE}) if (ITKVtkGlue_LOADED)

 find_package(VTK REQUIRED)
 include(${VTK_USE_FILE})

endif()

add_executable(ConstNeighborhoodIterator MACOSX_BUNDLE ConstNeighborhoodIterator.cxx)

if( "${ITK_VERSION_MAJOR}" LESS 4 )

 target_link_libraries(ConstNeighborhoodIterator ITKReview ${ITK_LIBRARIES})

else( "${ITK_VERSION_MAJOR}" LESS 4 )

 target_link_libraries(ConstNeighborhoodIterator ${ITK_LIBRARIES})

endif( "${ITK_VERSION_MAJOR}" LESS 4 )

</syntaxhighlight>

Download and Build ConstNeighborhoodIterator

Click here to download ConstNeighborhoodIterator and its CMakeLists.txt file. Once the tarball ConstNeighborhoodIterator.tar has been downloaded and extracted,

cd ConstNeighborhoodIterator/build

• If ITK is installed:

cmake ..

• If ITK is not installed but compiled on your system, you will need to specify the path to your ITK build:

cmake -DITK_DIR:PATH=/home/me/itk_build ..

Build the project:

make

and run it:

./ConstNeighborhoodIterator

WINDOWS USERS PLEASE NOTE: Be sure to add the ITK bin directory to your path. This will resolve the ITK dll's at run time.

Building All of the Examples

Many of the examples in the ITK Wiki Examples Collection require VTK. You can build all of the the examples by following these instructions. If you are a new VTK user, you may want to try the Superbuild which will build a proper ITK and VTK.

ItkVtkGlue

ITK >= 4

For examples that use QuickView (which depends on VTK), you must have built ITK with Module_ITKVtkGlue=ON.

ITK < 4

Some of the ITK Examples require VTK to display the images. If you download the entire ITK Wiki Examples Collection, the ItkVtkGlue directory will be included and configured. If you wish to just build a few examples, then you will need to download ItkVtkGlue and build it. When you run cmake it will ask you to specify the location of the ItkVtkGlue binary directory.