Skip to content

ImageConvolve

vtk-examples/Cxx/Images/ImageConvolve


Question

If you have a question about this example, please use the VTK Discourse Forum

Code

ImageConvolve.cxx

#include <vtkImageActor.h>
#include <vtkImageCast.h>
#include <vtkImageConvolve.h>
#include <vtkImageData.h>
#include <vtkImageMandelbrotSource.h>
#include <vtkImageMapper3D.h>
#include <vtkInteractorStyleImage.h>
#include <vtkNamedColors.h>
#include <vtkNew.h>
#include <vtkRenderWindow.h>
#include <vtkRenderWindowInteractor.h>
#include <vtkRenderer.h>

int main(int, char*[])
{
  vtkNew<vtkNamedColors> colors;

  // Create an image
  vtkNew<vtkImageMandelbrotSource> source;
  source->Update();

  vtkNew<vtkImageCast> originalCastFilter;
  originalCastFilter->SetInputConnection(source->GetOutputPort());
  originalCastFilter->SetOutputScalarTypeToUnsignedChar();
  originalCastFilter->Update();

  vtkNew<vtkImageConvolve> convolveFilter;
  convolveFilter->SetInputConnection(source->GetOutputPort());
  double kernel[9] = {1, 1, 1, 1, 1, 1, 1, 1, 1};
  convolveFilter->SetKernel3x3(kernel);
  convolveFilter->Update();

  vtkNew<vtkImageCast> convolvedCastFilter;
  convolvedCastFilter->SetInputConnection(convolveFilter->GetOutputPort());
  convolvedCastFilter->SetOutputScalarTypeToUnsignedChar();
  convolvedCastFilter->Update();

  // Create an actor
  vtkNew<vtkImageActor> originalActor;
  originalActor->GetMapper()->SetInputConnection(
      originalCastFilter->GetOutputPort());

  vtkNew<vtkImageActor> convolvedActor;
  convolvedActor->GetMapper()->SetInputConnection(
      convolvedCastFilter->GetOutputPort());

  // Define viewport ranges
  // (xmin, ymin, xmax, ymax)
  double leftViewport[4] = {0.0, 0.0, 0.5, 1.0};
  double rightViewport[4] = {0.5, 0.0, 1.0, 1.0};

  // Setup renderer
  vtkNew<vtkRenderer> originalRenderer;
  originalRenderer->SetViewport(leftViewport);
  originalRenderer->AddActor(originalActor);
  originalRenderer->SetBackground(colors->GetColor3d("Sienna").GetData());
  originalRenderer->ResetCamera();

  vtkNew<vtkRenderer> convolvedRenderer;
  convolvedRenderer->SetViewport(rightViewport);
  convolvedRenderer->AddActor(convolvedActor);
  convolvedRenderer->SetBackground(colors->GetColor3d("RoyalBlue").GetData());
  convolvedRenderer->ResetCamera();

  // Setup render window
  vtkNew<vtkRenderWindow> renderWindow;
  renderWindow->SetSize(600, 300);
  renderWindow->AddRenderer(originalRenderer);
  renderWindow->AddRenderer(convolvedRenderer);
  renderWindow->SetWindowName("ImageConvolve");

  // Setup render window interactor
  vtkNew<vtkRenderWindowInteractor> renderWindowInteractor;
  vtkNew<vtkInteractorStyleImage> style;

  renderWindowInteractor->SetInteractorStyle(style);

  // Render and start interaction
  renderWindowInteractor->SetRenderWindow(renderWindow);
  renderWindow->Render();
  renderWindowInteractor->Initialize();

  renderWindowInteractor->Start();

  return EXIT_SUCCESS;
}

CMakeLists.txt

cmake_minimum_required(VERSION 3.3 FATAL_ERROR)

project(ImageConvolve)

find_package(VTK COMPONENTS 
  vtkCommonColor
  vtkCommonCore
  vtkCommonDataModel
  vtkImagingCore
  vtkImagingGeneral
  vtkImagingSources
  vtkInteractionStyle
  vtkRenderingContextOpenGL2
  vtkRenderingCore
  vtkRenderingFreeType
  vtkRenderingGL2PSOpenGL2
  vtkRenderingOpenGL2
  QUIET
)

if (NOT VTK_FOUND)
  message("Skipping ImageConvolve: ${VTK_NOT_FOUND_MESSAGE}")
  return ()
endif()
message (STATUS "VTK_VERSION: ${VTK_VERSION}")
if (VTK_VERSION VERSION_LESS "8.90.0")
  # old system
  include(${VTK_USE_FILE})
  add_executable(ImageConvolve MACOSX_BUNDLE ImageConvolve.cxx )
  target_link_libraries(ImageConvolve PRIVATE ${VTK_LIBRARIES})
else ()
  # include all components
  add_executable(ImageConvolve MACOSX_BUNDLE ImageConvolve.cxx )
  target_link_libraries(ImageConvolve PRIVATE ${VTK_LIBRARIES})
  # vtk_module_autoinit is needed
  vtk_module_autoinit(
    TARGETS ImageConvolve
    MODULES ${VTK_LIBRARIES}
    )
endif ()

Download and Build ImageConvolve

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

cd ImageConvolve/build

If VTK is installed:

cmake ..

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

cmake -DVTK_DIR:PATH=/home/me/vtk_build ..

Build the project:

make

and run it:

./ImageConvolve

WINDOWS USERS

Be sure to add the VTK bin directory to your path. This will resolve the VTK dll's at run time.