caire README

The project's README from github.com/esimov/caire. As one markdown file: README.md.

Caire Logo

build Go Reference license release homebrew caire

Caire is a content aware image resize library based on Seam Carving for Content-Aware Image Resizing paper.

How does it work

The process illustrated:

Original image Energy map Seams applied
original sobel debug

Features

Key features which differentiates this library from the other existing open source solutions:

Install

First, install Go, set your GOPATH, and make sure $GOPATH/bin is on your PATH.

$ go install github.com/esimov/caire/cmd/caire@latest

MacOS (Brew) install

The library can also be installed via Homebrew.

$ brew install caire

Usage

$ caire -in input.jpg -out output.jpg

Supported commands:

$ caire --help

The following flags are supported:

Flag Default Description
in - Input file
out - Output file
width n/a New width
height n/a New height
preview true Show GUI window
perc false Reduce image by percentage
square false Reduce image to square dimensions
blur 4 Blur radius
sobel 2 Sobel filter threshold
debug false Use debugger
face false Use face detection
angle float Plane rotated faces angle
mask string Mask file path
rmask string Remove mask file path
color string Seam color (default #ff0000)
shape string Shape type used for debugging: circle,line (default circle)

Face detection

The library is capable of detecting human faces prior resizing the images by using the lightweight Pigo (https://github.com/esimov/pigo) face detection library.

The image below illustrates the application capabilities for human face detection prior resizing. It's clearly visible that with face detection activated the algorithm will avoid cropping pixels inside the detected faces, retaining the face zone unaltered.

Original image With face detection Without face detection
Original With Face Detection Without Face Detection

Sample image source

GUI progress indicator

GUI preview

A GUI preview mode is also incorporated into the library for in time process visualization. The Gio GUI library has been used because of its robustness and modern architecture. Prior running it please make sure that you have installed all the required dependencies noted in the installation section (https://gioui.org/#installation) .

The preview window is activated by default but you can deactivate it any time by setting the -preview flag to false. When the images are processed concurrently from a directory the preview mode is deactivated.

Face detection to avoid face deformation

In order to detect faces prior rescaling, use the -face flag. There is no need to provide a face classification file, since it's already embedded into the generated binary file. The sample code below will resize the provided image with 20%, but checks for human faces in order tot avoid face deformations.

For face detection related settings please check the Pigo documentation.

$ caire -in input.jpg -out output.jpg -face=1 -perc=1 -width=20

Support for stdin and stdout pipe commands

You can also use stdin and stdout with -:

$ cat input/source.jpg | caire -in - -out - >out.jpg

in and out default to - so you can also use:

$ cat input/source.jpg | caire >out.jpg
$ caire -out out.jpg < input/source.jpg

You can provide also an image URL for the -in flag or even use curl or wget as a pipe command in which case there is no need to use the -in flag.

$ caire -in <image_url> -out <output-folder>
$ curl -s <image_url> | caire > out.jpg

Process multiple images from a directory concurrently

The library can also process multiple images from a directory concurrently. You have to provide only the source and the destination folder and the new width or height in this case.

$ caire -in <input_folder> -out <output-folder>

Support for multiple output image type

There is no need to define the output file type, just use the correct extension and the library will encode the image to that specific type.

Other options

In case you wish to scale down the image by a specific percentage, it can be used the -perc boolean flag. In this case the values provided for the width and height are expressed in percentage and not pixel values. For example to reduce the image dimension by 20% both horizontally and vertically you can use the following command:

$ caire -in input/source.jpg -out ./out.jpg -perc=1 -width=20 -height=20 -debug=false

Also the library supports the -square option. When this option is used the image will be resized to a square, based on the shortest edge.

When an image is resized on both the X and Y axis, the algorithm will first try to rescale it prior resizing, but also will preserve the image aspect ratio. The seam carving algorithm is applied only to the remaining points. Ex. : given an image of dimensions 2048x1536 if we want to resize to the 1024x500, the tool first rescale the image to 1024x768 and then will remove only the remaining 268px.

Masks support:

Mask Mask removal

Caire integrations

snapcraft caire

Results

Shrunk images

Original Shrunk
broadway_tower_edit broadway_tower_edit
waterfall waterfall
dubai dubai
boat boat

Enlarged images

Original Extended
gasadalur gasadalur
dubai dubai

Useful resources

Author

License

Copyright © 2018 Endre Simo

This project is under the MIT License. See the LICENSE file for the full license text.

caire (esimov/caire)

Searching Database…

10.8K ·GitHub
Что это такое?Caire — это библиотека для интеллектуального изменения размера изображений на основе статьи Seam Carving for Content-Aware Image Resizing. Она распространяется и как библиотека для Go, и как утилита командной строки, которая умеет уменьшать и увеличивать картинки как по вертикали, так и по горизонтали.
Чем это отличается от того, чтобы просто сжать картинку, чтобы она стала меньше?При обычном изменении размера масштабируется каждый пиксель; Caire строит карту энергии с помощью выявления границ, затем методом динамического программирования находит «швы» из наименее важных пикселей с низкой энергией и удаляет их по одному, а при увеличении вставляет новые швы. Важные области имеют высокую стоимость энергии, поэтому их пропорции сохраняются.
Как её запустить?Установите Go, настройте GOPATH и убедитесь, что $GOPATH/bin есть в PATH, затем соберите caire из исходников. На macOS вместо этого можно установить её через Homebrew.
На что стоит обратить внимание перед тем, как прогонять через неё свои фото?Распознавание лиц по умолчанию выключено — без флага face швы могут проходить прямо сквозь людей. Кроме того, при каждом запуске появляется окно предпросмотра с графическим интерфейсом, если не отключить флаг preview.
Мне нужно знать Go, чтобы ей пользоваться?Нет — интерфейс командной строки управляется обычными флагами вроде in, out, width и height, так что с ней справится любой, кто умеет работать с терминалом. Писать на Go нужно только если вы хотите подключить caire как библиотеку в своих программах.
Как она защищает лица от искажения?Перед изменением размера caire запускает распознавание лиц с помощью легковесной библиотеки Pigo; пиксели внутри обнаруженных лиц исключаются из удаления швов, поэтому зона лица остаётся нетронутой. Флаг angle корректирует плоскость распознавания для повёрнутых лиц.
Могу ли я указать, какие части картинки защитить, а какие принудительно удалить?Да — защитная маска оберегает область от удаления, а маска удаления помечает участки, которые нужно убрать в первую очередь.
Что она умеет, кроме уменьшения фотографий?Она также увеличивает изображения и может сделать картинку квадратной или масштабировать её пропорционально одним флагом. Она записывает файлы jpg, jpeg, png и bmp, поддерживает пайпы stdin и stdout, а также обрабатывает целые каталоги рекурсивно и параллельно.
Можно ли встроить её в скрипты или serverless-пайплайн?Да — благодаря пайпам она встраивается в цепочки команд оболочки, работает как serverless-функция через OpenFaaS, а также распространяется в виде snap-пакета ($ snap run caire).
What are similar projects?usql, veet, hexyl, fx, spotify-tui, qrcp, noai-watermark, homebrew-cask
Creator
esimov
Size
90.2 MB
Stars
10.8K
Age
8y
Commits · 90 Days