junkie-rfglab 2023.7.0

junkie is a JUpyter NotebooK Image Explorer

JuNkIE (a JUpyter NotebooK Image Explorer)

Installing JuNkIE

To install JuNkIE, type:

$ python3 -m pip install --no-cache-dir -U junkie-rfglab

A note on the Python interpreter

JuNkIE requires that you have Python 3.10 or above installed.

Using JuNkIE

JuNkIE uses matplotlib and ipywidgets, so there is some boiler plate code that you need before importing JuNkIE:

import matplotlib
%matplotlib widgets

from junkie import junkie

There are a couple of ways to open an image with JuNkIE:

• You can open an image with some other package (e.g. scikit-image, opencv, PIL, etc.) and invoke JuNkIE with a numpy ndarray as the parameter:

• You can also specifiy the path to the image that you want to open:

• Or you can indicate a folder that contains an image sequence:

• If there are image channels split into different files, you can also specify a tuple of strings to distinguish which files in the folder belong to which channel:

JuNkIE has a couple of additional parameters:

• cmap (str) indicates the color map used to display the image. It defaults to 'gray'. Check here for a list of color maps.

• figsize (Tuple[int, int]) specifies the image panel size. The image aspect ratio is maintained. It defaults to (4, 4).

JuNkIE provides access to the standard matplotlib toolbar, and also includes a new one with additional functionality:

Citing JuNkIE

If you use JuNkIE, please cite this repository. We are working on the paper!

Sponsors

We are grateful for the generous support from the following agencies and institutions, which contribute to the development and maintenance of JuNkIE: