Coverage for src/dictk/__init__.py: 78%

1"""dictk: Digital Image Correlation Toolkit. 

2 

3CLI vs. API: the `dictk` command-line entry points (`dictk rosta`, 

4`dictk checkerboard`, `dictk astronaut`, ...) write image files to disk — 

5that's their whole job. The corresponding Python API functions 

6(`dictk.rosta`, `dictk.checkerboard`, `dictk.astronaut`, ...) do not 

7perform any file I/O; they return NumPy arrays only. This keeps the API 

8composable in a functional style — arrays 

9can be piped through further functions (e.g. `dictk.imaging.combine_images`) 

10before anything touches disk — and callers who do want a file call 

11`dictk.imaging.write_image` explicitly as a separate, deliberate step. 

12""" 

13 

14from importlib.metadata import PackageNotFoundError, version 

15 

16from dictk.core import zero_normalized_cross_correlation 

17from dictk.imaging import astronaut, checkerboard 

18from dictk.rosta import rosta 

19 

20try: 

21 __version__ = version("dictk") 

22except PackageNotFoundError: 

23 __version__ = "0.0.0+unknown" 

24 

25__all__ = [ 

26 "astronaut", 

27 "checkerboard", 

28 "rosta", 

29 "zero_normalized_cross_correlation", 

30 "__version__", 

31]