ThreeDViewer 0.2.1

Tool for visualising 3D vector and scalar fields

ThreeDViewer is a plotting tool for visualizing 3D scalar and vector fields in python.

Installation

ThreeDViewer can be installed through pip:

(.venv) $ pip install ThreeDViewer

Documentation

Comprehensive documentation is available online at readthedocs.

Quickstart

To view a 3D scalar, vector or orientation field and slice all axes interactively, use

ThreeDViewer.plot_3d(scalar_field)

For vector and orientation fields, each pixel will have a hue according to the vector’s direction and a lightness depending on the into-the-plane (bright) and out-of-plane (dark) components. This color adjusts according to the viewing axis, but can be kept constant across different axes by setting the argument const_color to True.

An example vector field is included in the package and the resulting plots are shown below