Welcome to imread’s documentation!

Imread is a very simple libray. It has three functions

imread

Reads an image from disk

imread_multi

Reads multiple images from disk (only for file formats that support multiple images)

imwrite

Save an image to disk

That’s it.

This needs to be used with a a computer vision & image processing packages:

• mahotas
• scikit-image
• OpenCV

This grew out of frustration at current image loading solutions in Python, in either my packages [mahotas] or packages from others [scikit-image, for example].

The relationship with numpy is very contained and this could be easily repurposed to load images in other frameworks, even other programming languages.

Citation

This package is an off-shoot of mahotas. As it, currently, does not have its own publication, so you are asked to cite the mother package: If you use imread-mahotas on a scientific publication, please cite:

Luis Pedro Coelho Mahotas: Open source software for scriptable computer vision in Journal of Open Research Software, vol 1, 2013. [DOI]

In Bibtex format:

@article{mahotas,
    author = {Luis Pedro Coelho},
    title = {Mahotas: Open source software for scriptable computer vision},
    journal = {Journal of Open Research Software},
    year = {2013},
    doi = {http://dx.doi.org/10.5334/jors.ac},
    month = {July},
    volume = {1}
}

INSTALL

On Windows, you can also just download a pre-built package from C. Gohlke’s repository

To compile on debian/ubuntu:

sudo apt-get install libpng12-dev libtiff4-dev libwebp-dev
sudo apt-get install xcftools

To compile on Mac:

sudo port install libpng tiff webp

Either way, you can then install:

pip install imread

Contents:

• IMREAD
• How To Install Mahotas-imread
  • From source
  • On Windows
• Formats Supported
  • Options
• Using imread outside of Python
  • The Image and the ImageFactory interfaces
• History
  • Version 0.6 (2016-09-21)
  • Version 0.5.1 (2014-11-06)
  • Version 0.5 (2014-10-16)
  • Version 0.4 (2014-07-21)
  • Version 0.3.2 (2013-10-06)
  • Version 0.3.1 (2013-06-20)
  • Version 0.3.0 (2013-07-29)
  • Version 0.2.6 (2013-06-19)
  • Version 0.2.5 (2012-10-29)
  • Version 0.2.4 (2012-06-26)
  • Version 0.2.3 (2012-06-8)
  • Version 0.2.2 (2012-06-5)
  • Version 0.2.1 (2012-02-11)
  • Version 0.2 (2012-03-19)
  • Version 0.1 (2012-02-28)

Bug Reports

Please report any bugs either on github or by email to luis@luispedro.org

If you have a test case where are not sure of whether imread is behaving correctly, you can discuss this on the pythonvision mailing list

If at all possible, include a small image as a test case.

Indices and tables

• Index
• Module Index
• Search Page