Welcome to spam’s documentation!

This is the documentation of the spam project.

Getting started

• Introduction
  • Welcome to spam
    • How to cite spam
    • Come and Chat!
    • Issues?
  • Tools provided
    • Image correlation/deformation toolkit
    • Label toolkit
    • Mesh tools
    • Plotting tools
    • Kalisphera
    • Helper tools
    • References
• Installation
  • Installation for users
  • How to use
    • Using spam in your scripts
    • Using existing spam scripts
  • Installation for developers
    • Cloning our repository
    • Installing system dependencies
    • Install spam from source
  • Install a spam jupyter kernel
  • Use the spam docker image
    • 1. Pull the image
    • 2. Input/output folder on the host
    • 3. Execute your script or a spam command
    • 4. Jupyter notebooks

Getting inspired

• Gallery of Tutorials
  • Tutorial: Refreshments in continuum mechanics
    • Objectives of this tutorial
    • From motion to deformation
    • Transformation Gradient Tensor Decomposition
  • Tutorial: Image correlation – Theory
    • Affine transformations with homogeneous coordinates
    • Differences between images
    • Image correlation – Finding Φ
    • References
  • Tutorial: Image correlation – Practice
    • Manipulating Φ
    • Applying a single Φ to an image
    • Before starting the correlation
    • Let’s measure a Φ field with spam-ldic
    • Computing strains from the displacement field
  • Tutorial: Strain calculation
    • Objectives of this tutorial
    • From a displacement field to a strain field
    • Example: Let’s calculate a strain field
    • References
  • Tutorial: Label Toolkit
    • Getting started
    • Binarisation
    • Watershed
    • Manipulating labelled images
    • Label-based measurements
    • Visualising label quantities
    • Discretising a labelled space
    • References
  • Tutorial: Contacts calculation
    • Objectives of this tutorial
    • Generating synthetic image
    • Detecting contacts
    • Measuring Orientations
    • Capturing fabric
    • References
  • Tutorial: Discrete Image correlation
    • Initial labelled image
    • Let’s correlate t=0→1
    • Let’s correlate t=0→2 using 0→1
    • Keep going with 0→3 based on 0→2
    • Spoiler alert: Step 0→5 has one particle which doesn’t converge
    • Tracking Summary
    • Towards strains
    • References
  • Tutorial: Projection of morphologies onto a FE mesh
    • Objectives of this tutorial
    • Step 1: Getting the repartition of phases
    • Step 2: Projection
    • Conclusion
    • References
  • Tutorial: Multimodal Registration
    • Objectives of this tutorial
    • Before you start
    • Using the graphical user interface
    • Moving to lower binning levels.
    • References
• Gallery of Examples
  • Digital Image Correlation examples
  • Image operations
  • Kalisphera sphere generation
  • LabelToolkit examples
  • Mesh
  • OrientationsToolkit examples
  • Random fields and excursion sets
• Scripts in spam
  • Image correlation script flowchart
  • Eye-registration script (spam-ereg)
    • Input:
    • Output:
  • Registration script (spam-reg)
    • Input:
    • Output:
  • Pixel search script (spam-pixelSearch)
    • Input:
    • Output:
  • Pixel search propagate script (spam-pixelSearchPropagate)
    • Input:
    • Output:
  • Regular grid local DIC script (spam-ldic)
    • Input:
    • Output:
  • Passing guess script (spam-passPhiField)
    • Input:
    • Output:
  • Filtering script (spam-filterPhiField)
    • Input:
    • Output:
  • Regular strain script (spam-regularStrain)
    • Input:
    • Output:
  • Deform image script (spam-deformImage)
    • Input:
    • Output:
    • A note on the correlation grid
  • Discrete local DIC script (spam-ddic)
    • Inputs
    • Outputs

Getting technical

• Conventions
• Tips & tricks
• Indices and tables
• Repository

Community

• List of publications
• How to Contribute
  • Conventions
  • Technical workflow
• Chat with us