Adding FinancialFieldData.py

src/Python.md

@@ -173,6 +173,7 @@ It would be appreciated if there are any Python VTK experts who could convert an
 [ExtractSelectionCells](/Python/PolyData/ExtractSelectionCells) | vtkExtractSelection | Extract cell, select cell.
 [FilledPolygon](/Python/PolyData/FilledPolygon) | vtkCutter |
 [Finance](/Python/Modelling/Finance) | vtkGaussianSplatter | Visualization of multidimensional financial data. The gray/wireframe surface represents the total data population. The red surface represents data points delinquent on loan payment.
+[FinanceFieldData](/Python/Modelling/FinanceFieldData) | vtkGaussianSplatter | Visualization of multidimensional financial data. The yellow surface represents the total data population. The red surface represents data points delinquent on loan payment.
 [ImplicitPolyDataDistance](/Python/PolyData/ImplicitPolyDataDistance) | vtkImplicitPolyDataDistance |
 [IterativeClosestPoints](/Python/Filtering/IterativeClosestPoints) | vtkIterativeClosestPointTransform |
 [LineOnMesh](/Python/DataManipulation/LineOnMesh) | vtkCellLocator vtkParametricSpline |

src/Python/Modelling/FinanceFieldData.md

+### Description
+This example is similar to [Finance](/Python/Modelling/Finance), but here we read a .vtk file with vtkDataObjectReader. The example uses the file [financial.vtk](https://raw.githubusercontent.com/lorensen/VTKExamples/master/src/Testing/Data/financial.vtk).
+
+The generated image is Figure 5 in [VTKFileFormats](/VTKFileFormats#legacy-file-examples).

src/Python/Modelling/FinanceFieldData.py

+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import vtk
+
+
+def main():
+    ifn = get_program_parameters()
+
+    colors = vtk.vtkNamedColors()
+
+    reader = vtk.vtkDataObjectReader()
+    reader.SetFileName(ifn)
+
+    size = 3187  # maximum number possible
+
+    xAxis = "INTEREST_RATE"
+    yAxis = "MONTHLY_PAYMENT"
+    zAxis = "MONTHLY_INCOME"
+    scalar = "TIME_LATE"
+
+    # Extract data from field as a polydata (just points), then extract scalars.
+    do2ds = vtk.vtkDataObjectToDataSetFilter()
+    do2ds.SetInputConnection(reader.GetOutputPort())
+    do2ds.SetDataSetTypeToPolyData()
+    # format: component#, arrayname, arraycomp, minArrayId, maxArrayId, normalize
+    do2ds.DefaultNormalizeOn()
+    do2ds.SetPointComponent(0, xAxis, 0)
+    do2ds.SetPointComponent(1, yAxis, 0, 0, size, 1)
+    do2ds.SetPointComponent(2, zAxis, 0)
+    do2ds.Update()
+    fd2ad = vtk.vtkFieldDataToAttributeDataFilter()
+    fd2ad.SetInputConnection(do2ds.GetOutputPort())
+    fd2ad.SetInputFieldToDataObjectField()
+    fd2ad.SetOutputAttributeDataToPointData()
+    fd2ad.DefaultNormalizeOn()
+    fd2ad.SetScalarComponent(0, scalar, 0)
+
+    # Construct the pipeline for the original population.
+    popSplatter = vtk.vtkGaussianSplatter()
+    popSplatter.SetInputConnection(fd2ad.GetOutputPort())
+    popSplatter.SetSampleDimensions(150, 150, 150)
+    popSplatter.SetRadius(0.05)
+    popSplatter.ScalarWarpingOff()
+
+    popSurface = vtk.vtkMarchingContourFilter()
+    popSurface.SetInputConnection(popSplatter.GetOutputPort())
+    popSurface.SetValue(0, 0.01)
+    popMapper = vtk.vtkPolyDataMapper()
+    popMapper.SetInputConnection(popSurface.GetOutputPort())
+    popMapper.ScalarVisibilityOff()
+    popActor = vtk.vtkActor()
+    popActor.SetMapper(popMapper)
+    popActor.GetProperty().SetOpacity(0.3)
+    popActor.GetProperty().SetColor(colors.GetColor3d("Gold"))
+
+    # Construct the pipeline for the delinquent population.
+    lateSplatter = vtk.vtkGaussianSplatter()
+    lateSplatter.SetInputConnection(fd2ad.GetOutputPort())
+    lateSplatter.SetSampleDimensions(150, 150, 150)
+    lateSplatter.SetRadius(0.05)
+    lateSplatter.SetScaleFactor(0.05)
+
+    lateSurface = vtk.vtkMarchingContourFilter()
+    lateSurface.SetInputConnection(lateSplatter.GetOutputPort())
+    lateSurface.SetValue(0, 0.01)
+    lateMapper = vtk.vtkPolyDataMapper()
+    lateMapper.SetInputConnection(lateSurface.GetOutputPort())
+    lateMapper.ScalarVisibilityOff()
+    lateActor = vtk.vtkActor()
+    lateActor.SetMapper(lateMapper)
+    lateActor.GetProperty().SetColor(colors.GetColor3d("Tomato"))
+
+    # Create the axes.
+    popSplatter.Update()
+    bounds = popSplatter.GetOutput().GetBounds()
+    axes = vtk.vtkAxes()
+    axes.SetOrigin(bounds[0], bounds[2], bounds[4])
+    axes.SetScaleFactor(popSplatter.GetOutput().GetLength() / 5.0)
+    axesTubes = vtk.vtkTubeFilter()
+    axesTubes.SetInputConnection(axes.GetOutputPort())
+    axesTubes.SetRadius(axes.GetScaleFactor() / 25.0)
+    axesTubes.SetNumberOfSides(6)
+    axesMapper = vtk.vtkPolyDataMapper()
+    axesMapper.SetInputConnection(axesTubes.GetOutputPort())
+    axesActor = vtk.vtkActor()
+    axesActor.SetMapper(axesMapper)
+
+    # Label the axes.
+    XText = vtk.vtkVectorText()
+    XText.SetText(xAxis)
+    XTextMapper = vtk.vtkPolyDataMapper()
+    XTextMapper.SetInputConnection(XText.GetOutputPort())
+
+    XActor = vtk.vtkFollower()
+    XActor.SetMapper(XTextMapper)
+    XActor.SetScale(0.02, .02, .02)
+    XActor.SetPosition(0.35, -0.05, -0.05)
+    XActor.GetProperty().SetColor(0, 0, 0)
+
+    YText = vtk.vtkVectorText()
+    YText.SetText(yAxis)
+
+    YTextMapper = vtk.vtkPolyDataMapper()
+    YTextMapper.SetInputConnection(YText.GetOutputPort())
+    YActor = vtk.vtkFollower()
+    YActor.SetMapper(YTextMapper)
+    YActor.SetScale(0.02, .02, .02)
+    YActor.SetPosition(-0.05, 0.35, -0.05)
+    YActor.GetProperty().SetColor(0, 0, 0)
+
+    ZText = vtk.vtkVectorText()
+    ZText.SetText(zAxis)
+    ZTextMapper = vtk.vtkPolyDataMapper()
+    ZTextMapper.SetInputConnection(ZText.GetOutputPort())
+    ZActor = vtk.vtkFollower()
+    ZActor.SetMapper(ZTextMapper)
+    ZActor.SetScale(0.02, .02, .02)
+    ZActor.SetPosition(-0.05, -0.05, 0.35)
+    ZActor.GetProperty().SetColor(0, 0, 0)
+
+    # Graphics stuff.
+    renderer = vtk.vtkRenderer()
+    renderWindow = vtk.vtkRenderWindow()
+    renderWindow.AddRenderer(renderer)
+    renderWindow.SetWindowName("vtk - Field.Data")
+
+    # Add the actors to the renderer, set the background and size.
+    renderer.AddActor(axesActor)
+    renderer.AddActor(lateActor)
+    renderer.AddActor(XActor)
+    renderer.AddActor(YActor)
+    renderer.AddActor(ZActor)
+    renderer.AddActor(popActor)
+    renderer.SetBackground(colors.GetColor3d("SlateGray"))
+    renderWindow.SetSize(650, 480)
+
+    camera = vtk.vtkCamera()
+    camera.SetClippingRange(.274, 13.72)
+    camera.SetFocalPoint(0.433816, 0.333131, 0.449)
+    camera.SetPosition(-1.96987, 1.15145, 1.49053)
+    camera.SetViewUp(0.378927, 0.911821, 0.158107)
+    renderer.SetActiveCamera(camera)
+    XActor.SetCamera(camera)
+    YActor.SetCamera(camera)
+    ZActor.SetCamera(camera)
+
+    # Render and interact with the data.
+
+    interactor = vtk.vtkRenderWindowInteractor()
+    interactor.SetRenderWindow(renderWindow)
+    renderWindow.Render()
+    interactor.Start()
+
+
+def get_program_parameters():
+    import argparse
+    description = 'Visualization of multidimensional financial data.'
+    epilogue = '''
+    This example is similar to /Python/Modelling/Finance.py, but here we read a .vtk file with vtkDataObjectReader.
+    '''
+    parser = argparse.ArgumentParser(description=description, epilog=epilogue,
+                                     formatter_class=argparse.RawTextHelpFormatter)
+    parser.add_argument('filename', help='financial.vtk.')
+
+    args = parser.parse_args()
+    return args.filename
+
+
+if __name__ == '__main__':
+    main()

src/VTKFileFormats.md

@@ -435,7 +435,7 @@ LOOKUP_TABLE CellColors 11
 ```
 
 The fourth and final example is data represented as a field. You may also wish to see “Working With Field Data” on [page 249](https://www.kitware.com/products/books/VTKUsersGuide.pdf#page=263) to see how to manipulate this data. The data file shown below can be found in its entirety [here](https://raw.githubusercontent.com/lorensen/VTKExamples/master/src/Testing/Data/financial.vtk).
-The example [FinanceFieldData(/Cxx/Modelling/FinanceFieldData) generated Figure 5.
+The example [FinanceFieldData](/Cxx/Modelling/FinanceFieldData) generated Figure 5.
 <figure>
   <img src="https://github.com/lorensen/VTKExamples/blob/master/src/Testing/Baseline/Cxx/Modelling/TestFinanceFieldData.png?raw=true" width="640" alt="FinanceFieldData">
   <figcaption>Figure 5. - Visualizing financial field data.</figcaption>