Skip to content

FunctionalBagPlot

Repository source: FunctionalBagPlot

Description

This example illustrates how to use the vtkPlotFunctionalBag. This class, depending on the number of components in a column, will either draw a line plot (1 component) or, for two component columns, a filled polygonal band (the bag) going from the first to second component.

The example uses a qualitative color map selected from vtkColorSeries.

Other languages

See (PythonicAPI)

Question

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

Code

FunctionalBagPlot.cxx

#include <vtkChartLegend.h>
#include <vtkChartXY.h>
#include <vtkColorSeries.h>
#include <vtkContextView.h>
#include <vtkDoubleArray.h>
#include <vtkLookupTable.h>
#include <vtkMath.h>
#include <vtkNamedColors.h>
#include <vtkNew.h>
#include <vtkPen.h>
#include <vtkPlotFunctionalBag.h>
#include <vtkRenderWindow.h>
#include <vtkRenderWindowInteractor.h>
#include <vtkRenderer.h>
#include <vtkTable.h>
#include <vtkVersion.h>

#include <sstream>

#if VTK_VERSION_NUMBER >= 90220220630ULL
#define VTK_HAS_SETCOLORF 1
#endif

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

  // Creates an input table
  const int numCols = 7;
  const int numVals = 100;

  vtkNew<vtkTable> inputTable;

  vtkNew<vtkDoubleArray> arr[numCols];
  for (int i = 0; i < numCols; i++)
  {
    std::stringstream ss;
    ss << "Y" << i;
    arr[i]->SetName(ss.str().c_str());
    arr[i]->SetNumberOfValues(numVals);
    for (int j = 0; j < numVals; j++)
    {
      arr[i]->SetValue(j,
                       (i + 1) *
                               fabs(sin((j * 2.f * vtkMath::Pi()) /
                                        static_cast<float>(numVals))) *
                               j +
                           i * 20);
    }
    inputTable->AddColumn(arr[i]);
  }

  // Create a X-axis column
  vtkNew<vtkDoubleArray> xArr;
  xArr->SetName("X");
  xArr->SetNumberOfValues(numVals);
  for (int j = 0; j < numVals; j++)
  {
    xArr->SetValue(j, j * 2.0);
  }
  inputTable->AddColumn(xArr);

  // Create the bag columns
  vtkNew<vtkDoubleArray> q3Arr;
  q3Arr->SetName("Q3");
  q3Arr->SetNumberOfComponents(2);
  q3Arr->SetNumberOfTuples(numVals);
  vtkNew<vtkDoubleArray> q2Arr;
  q2Arr->SetName("Q2");
  q2Arr->SetNumberOfComponents(2);
  q2Arr->SetNumberOfTuples(numVals);

  for (int i = 0; i < numVals; i++)
  {
    double v0, v1;
    v0 = arr[1]->GetVariantValue(i).ToFloat();
    v1 = arr[5]->GetVariantValue(i).ToFloat();
    q3Arr->SetTuple2(i, v0, v1);

    v0 = arr[2]->GetVariantValue(i).ToFloat();
    v1 = arr[4]->GetVariantValue(i).ToFloat();
    q2Arr->SetTuple2(i, v0, v1);
  }

  inputTable->AddColumn(q3Arr);
  inputTable->AddColumn(q2Arr);

  // Set up a 2D scene and add an XY chart to it
  vtkNew<vtkContextView> view;
  view->GetRenderWindow()->SetSize(640, 480);
  view->GetRenderWindow()->SetMultiSamples(0);
  view->GetRenderWindow()->SetWindowName("FunctionalBagPlot");

  vtkNew<vtkChartXY> chart;
  chart->SetShowLegend(true);
  chart->GetLegend()->SetHorizontalAlignment(vtkChartLegend::LEFT);
  chart->GetLegend()->SetVerticalAlignment(vtkChartLegend::TOP);

  view->GetScene()->AddItem(chart);

  // Create the functional bag plots
  vtkColor3d color3d = colors->GetColor3d("Tomato");
  vtkNew<vtkPlotFunctionalBag> q3Plot;
#if VTK_HAS_SETCOLORF
  q3Plot->SetColorF(color3d.GetRed(), color3d.GetGreen(), color3d.GetBlue());
#else
  q3Plot->SetColor(color3d.GetRed(), color3d.GetGreen(), color3d.GetBlue());
#endif
  q3Plot->SetInputData(inputTable, "X", "Q3");
  chart->AddPlot(q3Plot);

  color3d = colors->GetColor3d("Banana");
  vtkNew<vtkPlotFunctionalBag> q2Plot;
#if VTK_HAS_SETCOLORF
  q2Plot->SetColorF(color3d.GetRed(), color3d.GetGreen(), color3d.GetBlue());
#else
  q2Plot->SetColor(color3d.GetRed(), color3d.GetGreen(), color3d.GetBlue());
#endif
  q2Plot->SetInputData(inputTable, "X", "Q2");
  chart->AddPlot(q2Plot);

  vtkNew<vtkColorSeries> colorSeries;
  colorSeries->SetColorScheme(vtkColorSeries::BREWER_QUALITATIVE_SET3);
  ;

  vtkNew<vtkLookupTable> lookup;
  lookup->SetNumberOfColors(numCols);
  lookup->SetRange(0, numCols - 1);
  for (int j = 0; j < numCols; j++)
  {
    vtkNew<vtkPlotFunctionalBag> plot;
    vtkColor3ub color = colorSeries->GetColorRepeating(j);
    lookup->SetTableValue(j, color.GetRed() / 255., color.GetGreen() / 255.,
                          color.GetBlue() / 255., 1.);
    double rgb[3];
    lookup->GetColor(j, rgb);
#if VTK_HAS_SETCOLORF
    plot->SetColorF(rgb[0], rgb[1], rgb[2]);
#else
    plot->SetColor(rgb[0], rgb[1], rgb[2]);
#endif
    plot->SetInputData(inputTable, "X", inputTable->GetColumn(j)->GetName());
    plot->GetPen()->SetWidth(3.0);
    chart->AddPlot(plot);
  }

  view->GetRenderer()->SetBackground(colors->GetColor3d("SlateGray").GetData());

  // Render the scene
  view->GetRenderWindow()->Render();
  view->GetInteractor()->Initialize();
  view->GetInteractor()->Start();

  return EXIT_SUCCESS;
}

CMakeLists.txt

cmake_minimum_required(VERSION 3.12 FATAL_ERROR)

project(FunctionalBagPlot)

find_package(VTK COMPONENTS 
  ChartsCore
  CommonColor
  CommonCore
  CommonDataModel
  InteractionStyle
  RenderingContext2D
  RenderingContextOpenGL2
  RenderingCore
  RenderingFreeType
  RenderingGL2PSOpenGL2
  RenderingOpenGL2
  ViewsContext2D
)

if (NOT VTK_FOUND)
  message(FATAL_ERROR "FunctionalBagPlot: 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(FunctionalBagPlot MACOSX_BUNDLE FunctionalBagPlot.cxx )
  target_link_libraries(FunctionalBagPlot PRIVATE ${VTK_LIBRARIES}
)
# vtk_module_autoinit is needed
vtk_module_autoinit(
  TARGETS FunctionalBagPlot
  MODULES ${VTK_LIBRARIES}
)

Download and Build FunctionalBagPlot

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

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

./FunctionalBagPlot

WINDOWS USERS

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