Skip to content

Load an image file into a numpy array with Exif orientation support. Prevents upside-down and sideways images!

License

Notifications You must be signed in to change notification settings

ageitgey/image_to_numpy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

image_to_numpy

Load an image file into a numpy array - while automatically rotating the image based on Exif orientation. Prevents upside-down and sideways images!

import image_to_numpy

img = image_to_numpy.load_image_file("my_file.jpg")

The image is automatically rotated into the correct orientation if the image contains Exif orientation metadata. Otherwise, it is loaded normally.

From there, you can pass the numpy array to any Python library that works with images in numpy array format, like face_recognition, Keras, etc.

Installation

You can install from PyPI:

pip install image_to_numpy

What is Exif Orientation data?

Most images captured by cell phones and consumer cameras aren't stored on disk in the same orientation they appear on screen. Exif Orientation data tells the program which way the image needs to be rotated to display correctly. Not handling Exif Orientation is a common source of bugs in Computer Vision and Machine Learning applications.

You can learn more about images and Exif Orientation data in my article here.

Usage

import image_to_numpy

img = image_to_numpy.load_image_file("my_file.jpg")

Your image is loaded - with the correct orientation!

By default, the image array is returned as a numpy array with 3-channels of 8-bit RGB data.

You can control the output format by passing in an optional mode parameter:

import image_to_numpy

img = image_to_numpy.load_image_file("my_file.jpg", mode="RGB")

# Supported modes:
#  1 (1-bit pixels, black and white, stored with one pixel per byte)
#  L (8-bit pixels, black and white)
#  RGB (3x8-bit pixels, true color)
#  RGBA (4x8-bit pixels, true color with transparency mask)
#  CMYK (4x8-bit pixels, color separation)
#  YCbCr (3x8-bit pixels, color video format)
#  I (32-bit signed integer pixels)
#  F (32-bit floating point pixels)

If you have matplotlib installed, here's a quick way to show your image on the screen:

import matplotlib.pyplot as plt
import image_to_numpy

img = image_to_numpy.load_image_file("my_file.jpg")

plt.imshow(img)
plt.show()

Thanks

About

Load an image file into a numpy array with Exif orientation support. Prevents upside-down and sideways images!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages