Skip to main content

Tools to analyze scalar and vector fields

Project description

Build status Overall test coverage Documentation Status

This module has been written to carry out analysis and more specifically structure detection on PIV velocity fields. It is now more general and can handle different kind of data (point cloud, scalar and vector field, …) and perform classical and more advanced analysis on them (spectra, pod, post-processing, visualization, …).

Hosted on FramaGit.

Full documentation available on ReadTheDocs.

General data analysis

  1. Class representing 2D fields of 1 component (ScalarField)
  2. Class representing 2D fields of 2 components (VectorField)
  3. Classes representing sets of scalar fields vector fields (SpatialScalarFields, TemporalScalarFields, SpatialVectorFields and TemporalVectorFields)
  4. Class representing profiles (Profile)
  5. Class representing scatter points (Points)
  6. Module for modal decomposition (POD, DMD) and reconstruction (pod)
  7. Module to import/export data from/to Davis, matlab, ascii, pivmat and images files (file_operation)
  8. Functionalities to visualize those data (plotlib)

Flow analysis

  1. Module to create artificial vortices: Burger, Jill, Rankine, … and to simulate their motion in potential flows (vortex_creation)
  2. Module providing several vortex criterions computation (vortex_criterions)
  3. Module to automatically detect and track critical points (vortex_detection)
  4. Module to compute the evolution of some vortex properties (vortex_properties)
  5. Module to generate potential flows with arbitrary geometries (potential_flow)



  • numpy
  • matplotlib
  • scipy
  • unum
  • modred


  • sklearn (to work with point clustering)
  • networkx (to use force-directed algorithms to compare trajectories)
  • colorama (to have a nice interface when manipulating files)
  • h5py (allow to import data from pivmat files)


IMTreatment is now available on Pypi: pip install IMTreatment

Or if you prefer to install it manually from source: pip install 'git+'


IMTreatment is documented inline and in ReadTheDocs. you can also use to locally build the html doc.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for IMTreatment, version 1.3.0
Filename, size File type Python version Upload date Hashes
Filename, size IMTreatment-1.3.0-py3-none-any.whl (264.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size IMTreatment-1.3.0.tar.gz (214.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page