openpiv.tools.Multiprocesser

class openpiv.tools.Multiprocesser(data_dir: pathlib.Path, pattern_a: str, pattern_b: Optional[str] = None)

__init__(data_dir: pathlib.Path, pattern_a: str, pattern_b: Optional[str] = None) → None

A class to handle and process large sets of images.

This class is responsible of loading image datasets and processing them. It has parallelization facilities to speed up the computation on multicore machines.

It currently support only image pair obtained from conventional double pulse piv acquisition. Support for continuos time resolved piv acquistion is in the future.

Parameters:

• data_dir (str) – the path where image files are located
• pattern_a (str) – a shell glob pattern to match the first (A) frames.
• pattern_b (str) – a shell glob pattern to match the second (B) frames.
• Options –

  pattern_a = ‘image_*_a.bmp’

  pattern_b = ‘image_*_b.bmp’

  or

  pattern_a = ‘000*.tif’ pattern_b = ‘(1+2),(2+3)’ will create PIV of these pairs: 0001.tif+0002.tif, 0002.tif+0003.tif …

  or

  pattern_a = ‘000*.tif’ pattern_b = ‘(1+3),(2+4)’ will create PIV of these pairs: 0001.tif+0003.tif, 0002.tif+0004.tif …

  or

  pattern_a = ‘000*.tif’ pattern_b = ‘(1+2),(3+4)’ will create PIV of these pairs: 0001.tif+0002.tif, 0003.tif+0004.tif …

Examples

>>> multi = openpiv.tools.Multiprocesser( '/home/user/images', 'image_*_a.bmp', 'image_*_b.bmp')

Methods