• Stars
    star
    1,782
  • Rank 25,053 (Top 0.6 %)
  • Language
    Go
  • License
    MIT License
  • Created about 10 years ago
  • Updated 10 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

smartcrop finds good image crops for arbitrary crop sizes

smartcrop

Latest Release Build Status Coverage Status Go ReportCard GoDoc

smartcrop finds good image crops for arbitrary sizes. It is a pure Go implementation, based on Jonas Wagner's smartcrop.js

Example Image: https://www.flickr.com/photos/usfwspacific/8182486789 by Washington Dept of Fish and Wildlife, originally licensed under CC-BY-2.0 when the image was imported back in September 2014

Example Image: https://www.flickr.com/photos/endogamia/5682480447 by Leon F. Cabeiro (N. Feans), licensed under CC-BY-2.0

Installation

Make sure you have a working Go environment (Go 1.12 or higher is required). See the install instructions.

To install smartcrop, simply run:

go get github.com/muesli/smartcrop

To compile it from source:

git clone https://github.com/muesli/smartcrop.git
cd smartcrop
go build

Example

package main

import (
	"fmt"
	"image"
	_ "image/png"
	"os"

	"github.com/muesli/smartcrop"
	"github.com/muesli/smartcrop/nfnt"
)

func main() {
	f, _ := os.Open("image.png")
	img, _, _ := image.Decode(f)

	analyzer := smartcrop.NewAnalyzer(nfnt.NewDefaultResizer())
	topCrop, _ := analyzer.FindBestCrop(img, 250, 250)

	// The crop will have the requested aspect ratio, but you need to copy/scale it yourself
	fmt.Printf("Top crop: %+v\n", topCrop)

	type SubImager interface {
		SubImage(r image.Rectangle) image.Image
	}
	croppedimg := img.(SubImager).SubImage(topCrop)
	// ...
}

Also see the test cases in smartcrop_test.go and cli application in cmd/smartcrop/ for further working examples.

Simple CLI application

go install github.com/muesli/smartcrop/cmd/smartcrop

Usage of smartcrop:
  -height int
        crop height
  -input string
        input filename
  -output string
        output filename
  -quality int
        jpeg quality (default 85)
  -resize
        resize after cropping (default true)
  -width int
        crop width

Example: smartcrop -input examples/gopher.jpg -output gopher_cropped.jpg -width 300 -height 150

Sample Data

You can find a bunch of test images for the algorithm here.

Feedback

Got some feedback or suggestions? Please open an issue or drop me a note!

More Repositories

1

duf

Disk Usage/Free Utility - a better 'df' alternative
Go
10,935
star
2

beehive

A flexible event/agent & automation system with lots of bees 🐝
Go
6,181
star
3

cache2go

Concurrency-safe Go caching library with expiration capabilities and access counters
Go
2,009
star
4

termenv

Advanced ANSI style & color support for your terminal applications
Go
1,619
star
5

gitomatic

A tool to monitor git repositories and automatically pull & push changes
Go
1,014
star
6

gamut

Go package to generate and manage color palettes & schemes 🎨
Go
510
star
7

reflow

A collection of (ANSI-sequence aware) text reflow operations & algorithms
Go
450
star
8

gitty

Contextual information about your git projects, right on the command-line
Go
447
star
9

kmeans

k-means clustering algorithm implementation written in Go
Go
418
star
10

readme-scribe

A GitHub Action that automatically generates & updates markdown content (like your README.md)
396
star
11

crunchy

Finds common flaws in passwords. Like cracklib, but written in Go.
Go
378
star
12

obs-cli

OBS-cli is a command-line remote control for OBS
Go
306
star
13

regommend

Recommendation engine for Go
Go
303
star
14

markscribe

Your personal markdown scribe with template-engine and Git(Hub) & RSS powers πŸ“œ
Go
286
star
15

mango

mango is a man-page generator for the Go flag, pflag, cobra, coral, and kong packages
Go
229
star
16

docker-backup

A tool to create & restore complete, self-contained backups of Docker containers
Go
201
star
17

telephant

A lightweight but modern Mastodon client for the desktop
QML
193
star
18

go-app-paths

Lets you retrieve platform-specific paths (like directories for app-data, cache, config, and logs)
Go
175
star
19

deckmaster

An application to control your Elgato Stream Deck on Linux
Go
169
star
20

prism

An RTMP stream recaster / splitter
Go
150
star
21

gitflux

Track your GitHub projects in InfluxDB and create beautiful graphs with Grafana
Go
117
star
22

asciicam

Displays your webcam... on the terminal
Go
116
star
23

cancelreader

A cancelable reader for Go
Go
102
star
24

service-tools

A growing collection of convenient little tools to work with systemd services
Go
91
star
25

mastotool

A collection of command-line tools to work with your Mastodon account
Go
89
star
26

thunder

BoltDB's Interactive Shell
Go
80
star
27

sticker

A Golang lib to generate placeholder images with text
Go
79
star
28

toktok

Typo/error resilient, human-readable token generator
Go
67
star
29

sasquatch

A simple data encryption library
Go
56
star
30

combinator

Generates a slice of all possible value combinations for any given struct and a set of its potential member values
Go
48
star
31

roff

roff lets you write roff documents in Go
Go
42
star
32

pam-beacon

PAM module for multi-factor authentication with Bluetooth Devices & Beacons
Go
41
star
33

streamdeck

An application and Go library to control your Elgato Stream Deck on Linux
Go
41
star
34

marky

Generate markdown programmatically
Go
40
star
35

sync3c

A little tool to sync/download media from https://media.ccc.de
Go
36
star
36

muesli

My secret muesli repo
33
star
37

huephp

PHP library to control the Philips Hue lighting system
PHP
33
star
38

obs-scene-switcher

Tracks your active window and switches OBS scenes accordingly
Go
32
star
39

mango-cobra

cobra adapter for mango
Go
31
star
40

lighthouse

A fully modular, parametric, and customizable case design. Built with OpenSCAD.
OpenSCAD
30
star
41

scratchy

Quickly bootstrap a Linux distro in a (non-Docker) container and interactively execute something in it
Go
27
star
42

gitcha

Go helpers to work with git repositories
Go
25
star
43

ansi

Raw ANSI sequence helpers
Go
19
star
44

goprogressbar

Print progress bars on the console with Go
Go
19
star
45

ircflu

ircflu is an IRC bot written in Go
Go
19
star
46

go-razer

Go library to control Razer (Chroma) devices
Go
18
star
47

magicwand

MagicWand makes your input devices context sensitive
Go
17
star
48

goefa

A Go client for EFA APIs (Elektronische Fahrplan Auskunft)
Go
15
star
49

xray

xray compares media files by their perceptual hash and identifies dupes
C++
15
star
50

gotable

Go helper to print a table of data to stdout
Go
15
star
51

ydl

A simple youtube-dl library for Go
Go
14
star
52

clusters

Data structs and algorithms for clustering data observations and basic computations in n-dimensional spaces
Go
14
star
53

dotfiles

My dotfiles
Shell
14
star
54

saloon

Saloon, an Arduino/ESP-based Information Monitor
C++
13
star
55

cap-generator

OpenSCAD cap with thread generator
OpenSCAD
13
star
56

elvish-libs

Libs / Themes for elvish
13
star
57

ms-pacman

Handy scripts for Arch Linux users
Shell
12
star
58

silhouette

Silhouette cluster analysis implementation in Go
Go
11
star
59

penpal

A Linux daemon to sync Wacom Bamboo devices
Go
10
star
60

code-server

My code-server Docker image
Dockerfile
10
star
61

beehive-admin

Admin interface to Beehive - https://github.com/muesli/beehive
JavaScript
9
star
62

smolder

smolder makes it easy to write restful Golang JSON APIs
Go
9
star
63

mango-coral

coral adapter for mango
Go
8
star
64

deckmaster-emojis

A deck of emojis for Deckmaster
8
star
65

configaro

The Marriage of (Con)Figaro - A small but flexible config system that's XDG-compliant
6
star
66

smartcrop-samples

Sample images to test the smartcrop algorithm with
6
star
67

gominatim

Go library to access nominatim geocoding services
Go
5
star
68

go-pkg-rss

go-pkg-rss
Go
5
star
69

go-crashcourse

A Crash-Course in Learning Go
Go
5
star
70

homebrew-tap

muesli's Homebrew tap
Ruby
4
star
71

bones

A Golang Code Doctor
Go
4
star
72

mango-pflag

pflag adapter for mango
Go
3
star
73

polly

Polly wants a cracker
Go
3
star
74

maker-coin

A simple Maker Coin designed in OpenSCAD
Python
3
star
75

quaint

Image & static content HTTP server written in Go
Go
3
star
76

videowall

An interactive wall of live videos
C++
2
star
77

filament-swatch

Parameterized Filament Swatch / Sample Tag in OpenSCAD
OpenSCAD
2
star
78

flipdots

Go library to access OpenLab's flipdot matrix
Go
2
star
79

pkgbuilds

My collection of Arch Linux PKGBUILDs
Shell
2
star
80

beehive-vendor

Vendor files for Beehive
Go
2
star
81

QtGaugeWidget

Gauge widget for Qt
C++
1
star
82

go-pkg-xmlx

go-pkg-xmlx
Go
1
star
83

jigo

A set of #golang jigs
1
star
84

nibbler

Network logging daemon written in Go
Go
1
star
85

comunit

PASCAL interface to access serial COM ports
Pascal
1
star
86

tomahawk-iOS

Tomahawk iOS Player
Objective-C
1
star