Skip to content

ParticleReader

vtk-examples/Cxx/IO/ParticleReader


Description

This example reads ascii files where each line consists of points with its position (x,y,z) and (optionally) one scalar or binary files in RAW 3d file format.

Other languages

See (Java), (CSharp)

Question

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

Code

ParticleReader.cxx

//
// This example reads ascii files where each line consists of points with its
// position (x,y,z) and (optionally) one scalar or binary files in RAW 3d file
// format.
//
// some standard vtk headers
#include <vtkActor.h>
#include <vtkNamedColors.h>
#include <vtkNew.h>
#include <vtkParticleReader.h>
#include <vtkPolyDataMapper.h>
#include <vtkProperty.h>
#include <vtkRenderWindow.h>
#include <vtkRenderWindowInteractor.h>
#include <vtkRenderer.h>

// needed to easily convert int to std::string
int main(int argc, char* argv[])
{
  vtkNew<vtkNamedColors> colors;

  // Verify input arguments
  if (argc != 2)
  {
    std::cout << "Usage: " << argv[0] << " Filename(.raw) e.g. Particles.raw"
              << std::endl;
    return EXIT_FAILURE;
  }

  std::string filePath = argv[1];
  // Particles.raw supplied by VTK is big endian encoded
  // std::string filePath = "C:\\VTK\\vtkdata-5.8.0\\Data\\Particles.raw";
  // Read the file
  vtkNew<vtkParticleReader> reader;

  reader->SetFileName(filePath.c_str());
  // if nothing gets displayed or totally wrong, swap the endianness
  reader->SetDataByteOrderToBigEndian();
  reader->Update();

  // Visualize
  vtkNew<vtkPolyDataMapper> mapper;
  mapper->SetInputConnection(reader->GetOutputPort());
  std::cout << "number of pieces: " << mapper->GetNumberOfPieces() << std::endl;
  mapper->SetScalarRange(4, 9);

  vtkNew<vtkActor> actor;

  actor->SetMapper(mapper);
  actor->GetProperty()->SetPointSize(4);

  vtkNew<vtkRenderer> renderer;
  vtkNew<vtkRenderWindow> renderWindow;
  renderWindow->AddRenderer(renderer);
  renderWindow->SetWindowName("ParticleReader");

  vtkNew<vtkRenderWindowInteractor> renderWindowInteractor;
  renderWindowInteractor->SetRenderWindow(renderWindow);

  renderer->AddActor(actor);
  renderer->SetBackground(colors->GetColor3d("DarkSlateGray").GetData());

  renderWindow->Render();
  renderWindowInteractor->Start();

  return EXIT_SUCCESS;
}

CMakeLists.txt

cmake_minimum_required(VERSION 3.12 FATAL_ERROR)

project(ParticleReader)

find_package(VTK COMPONENTS 
  CommonColor
  CommonCore
  IOGeometry
  InteractionStyle
  RenderingContextOpenGL2
  RenderingCore
  RenderingFreeType
  RenderingGL2PSOpenGL2
  RenderingOpenGL2
)

if (NOT VTK_FOUND)
  message(FATAL_ERROR "ParticleReader: Unable to find the VTK build folder.")
endif()

# Prevent a "command line is too long" failure in Windows.
set(CMAKE_NINJA_FORCE_RESPONSE_FILE "ON" CACHE BOOL "Force Ninja to use response files.")
add_executable(ParticleReader MACOSX_BUNDLE ParticleReader.cxx )
  target_link_libraries(ParticleReader PRIVATE ${VTK_LIBRARIES}
)
# vtk_module_autoinit is needed
vtk_module_autoinit(
  TARGETS ParticleReader
  MODULES ${VTK_LIBRARIES}
)

Download and Build ParticleReader

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

cd ParticleReader/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:

./ParticleReader

WINDOWS USERS

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