Skip to main content

Abraia Python SDK

Project description

Build Status Python Package Coverage Status Package Downloads

Analytics

Abraia python API and CLI

Abraia Python package

The Abraia Python package provides and easy way to start analyzing images directly from your browser. You just need to click on the open in colab button to start with one of the available notebooks:

  • Simple image analysis with Abraia

  • Hyperspectral image analysis and classification

  • Hyperspectral image deep classification

classification

The multiple module extends the Abraia package to provide support for HyperSpectral Image (HSI) analysis.

MULTIPLE is result and it is being developed by ABRAIA in the Multiple project.

Configuration

Installed the package, you have to configure your ABRAIA KEY as environment variable:

export ABRAIA_KEY=api_key

On Windows you need to use set instead of export:

set ABRAIA_KEY=api_key

NOTE: To persist the configuration use your system options to set your ABRAIA_KEY environment variable and avoid to run the previous command every time you start a terminal/console session.

Image analysis

Abraia provides a direct interface to directly load and save images. You can easily load the image data and the file metadata, or save a new image.

from abraia import Abraia

abraia = Abraia()

img = abraia.load_image('test.jpg')
meta = abraia.load_metadata('test.jpg')
abraia.save_image('test.png', img)

You can directly visualize the image using Matplotlib.

import matplotlib.pyplot as plt

plt.figure()
plt.title('Image')
plt.imshow(img)
plt.axis('off')
plt.show()

List files

Return the list of files and folders on the specified cloud folder.

folder = ''
files, folders = abraia.list_files(folder)

Upload files

Upload a local (src) or a remote (url) file to the cloud.

src = 'images/test.png'
path = 'test/test.png'
abraia.upload_file(src, path)

Image detection

Detect labels, capture text, and detect faces in images (must be in JPEG format).

labels = abraia.detect_labels(path)
lines = abraia.capture_text(path)
faces = abraia.detect_faces(path)

Transform images

Transform and optimize images automatically choosing every compression parameter to provide the best result based on the perceived analysis of the original image.

path = 'test/birds.jpg'
dest = 'birds_o.jpg'
params = {'width': 300, 'height': 300, 'mode': 'pad'}
abraia.transform_image(path, dest, params)
Parameter Description
width Image width (original width by default)
height Image height (original height by default)
mode Resize and crop mode: crop, face, thumb, resize (smart crop by default)
background Change background color in padded mode (white by default)
action Path to the action file to be used as template
format Set the image format: jpeg, png, gif, webp (original format by default)
quality Set the image quality (auto by default)

Download files

Retrieve an stored file.

path = 'test/birds.jpg'
dest = 'images/birds.jpg'
abraia.download_file(path, dest)

Delete files

Delete a stored resource specified by its path.

abraia.delete(path)

HyperSpectral Image (HSI) analysis

MULTIPLE extends the ABRAIA Python API to provide seamless integration of multiple HyperSpectral Image (HSI) processing and analysis tools. This integrates state-of-the-art image manipulation libraries to provide ready to go scalable multispectral solutions.

MULTIPLE is result and it is being developed by ABRAIA in the Multiple project.

Usage

from abraia import Multiple

multiple = Multiple()
img = multiple.load_image('test.hdr')
meta = multiple.load_metadata('test.hdr')
multiple.save_image('test.hdr', img, metadata=meta)

Upload and load HSI data

To start with, we may upload some data directly using the graphical interface, or using the multiple api:

multiple.upload_file('PaviaU.mat')

Now, we can load the hyperspectral image data (HSI cube) directly from the cloud:

img = multiple.load_image('PaviaU.mat')

Basic HSI visualization

Hyperspectral images cannot be directly visualized, so we can get some random bands from our HSI cube, and visualize these bands as like any other monochannel image.

from multiple import hsi

imgs, indexes = hsi.random(img)

plt.figure()
fig, ax = plt.subplots(2, 3)
ax = ax.reshape(-1)
for i, im in enumerate(imgs):
    ax[i].imshow(im, cmap='jet')
    ax[i].axis('off')
plt.show()

Pseudocolor visualization

A common operation with spectral images is to reduce the dimensionality, applying principal components analysis (PCA). We can get the first three principal components into a three bands pseudoimage, and visualize this pseudoimage.

pc_img = hsi.principal_components(img)

plt.figure()
plt.title('Principal components')
plt.imshow(pc_img)
plt.axis('off')
plt.show()

Abraia command line

The Abraia CLI tool provides a simple way to bulk resize, convert, and optimize your images and photos for web. Enabling the conversion from different input formats to get images in the right formats to be used in the web - JPEG, WebP, or PNG -. Moreover, it supports a number of transformations that can be applied to image batches. So you can easily convert your images to be directly published on the web.

Installation

The Abraia CLI is a Python tool which can be installed on Windows, Mac, and Linux:

python -m pip install -U abraia

The first time you run Abraia CLI you need to configure your API key, just write the command bellow and paste your key.

abraia configure

Resize images

To compress an image you just need to specify the input and output paths for the image:

abraia convert images/birds.jpg images/birds_o.jpg

Image compressed from url

To resize and optimize and image maintaining the aspect ratio is enough to specify the width or the height of the new image:

abraia convert --width 500 images/usain-bolt.jpeg images/usaint-bolt_500.jpeg

Usain Bolt resized

You can also automatically change the aspect ratio specifying both width and height parameters and setting the resize mode (pad, crop, thumb):

abraia convert --width 333 --height 333 --mode pad images/lion.jpg images/lion_333x333.jpg
abraia convert --width 333 --height 333 images/lion.jpg images/lion_333x333.jpg

Image lion smart cropped Image lion smart cropped

So, you can automatically resize all the images in a specific folder preserving the aspect ration of each image just specifying the target width or height:

abraia convert --width 300 [path] [dest]

Or, automatically pad or crop all the images contained in the folder specifying both width and height:

abraia convert --width 300 --height 300 --mode crop [path] [dest]

beauty casual resized beauty casual smart cropped

Convert images

The JPEG image format is still the most common format to publish photos on the web. However, converting images to WebP provides a significant improvement for web publishing.

To convert images to a web format (JPEG, PNG, WebP) or between these formats you just need to change the filename extension for the destination file:

abraia convert garlic.jpg garlic.webp
garlic jpeg garlic webp

In addition, you can also convert SVG and PSD files. For instance, converting a SVG to PNG is so simple as to type the command bellow:

abraia convert bat.svg bat.png
bat svg bat png

The SVG vector image is rendered in a Chrome instance to provide maximum fidelity, and preserving the transparent background.

Moreover, you can easily convert a PSD file (the layered image file used in Adobe Photoshop for saving data) flattening all the visible layers with a command like bellow:

abraia convert strawberry.psd strawberry.jpg
abraia convert strawberry.psd strawberry.png
white background strawberry transparent strawberry

When the PSD file is converted to JPEG a white background is added automatically, because the JPEG format does not support transparency. Instead, using the PNG or the WebP format you can preserve the transparent background.

Or, convert a batch of Photoshop files with a simple command. Just copy your PSD files to a folder, for instance the photoshop folder, and convert all the files in that folder.

abraia convert photoshop

You can also take web from the command line just specifying and url to get the capture.

abraia convert https://abraia.me screenshot.jpg

License

This software is licensed under the MIT License. View the license.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

abraia-0.8.0.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

abraia-0.8.0-py2.py3-none-any.whl (13.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file abraia-0.8.0.tar.gz.

File metadata

  • Download URL: abraia-0.8.0.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for abraia-0.8.0.tar.gz
Algorithm Hash digest
SHA256 dcb496d8c18d02b52d11f130d5bd4880bd78a9f42acf831743641307a74569e0
MD5 c72d3e763a2c0595a619f4fc9b622d6e
BLAKE2b-256 c31a19c4e8e55d1ed1d67806ba47864a9df2dbdecd98c248b313c8dd2e125b96

See more details on using hashes here.

File details

Details for the file abraia-0.8.0-py2.py3-none-any.whl.

File metadata

  • Download URL: abraia-0.8.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for abraia-0.8.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ae65073dd9cbc35d9828b8c4a2c4fb7858916d4c3b6774d981594087a5391cf5
MD5 c168eee4e40ee076d49d36b21a4d97d0
BLAKE2b-256 6b09ae1089e7c5b6a587dd3c2a72cf5cd49bb6a73b8c4e43dba3d197ff210e01

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page