Categorygithub.com/dreamcodeman/smartcrop
modulepackage
0.2.0
Repository: https://github.com/dreamcodeman/smartcrop.git
Documentation: pkg.go.dev

# README

smartcrop

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 CC BY U.S. Fish & Wildlife

Example Image: https://www.flickr.com/photos/endogamia/5682480447 by N. Feans

Installation

Make sure you have a working Go environment. See the install instructions.

To install smartcrop, simply run:

go get github.com/muesli/smartcrop

To compile it from source:

cd $GOPATH/src/github.com/muesli/smartcrop
go get -u -v
go build && go test -v

Example

package main

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

        "github.com/muesli/smartcrop"
)

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

        analyzer := smartcrop.NewAnalyzer()
        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 crop_test.go for further working examples.

Sample Data

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

Development

API docs can be found here.

Join us on IRC: irc.freenode.net/#smartcrop

Build Status Coverage Status Go ReportCard

# Functions

NewAnalyzer returns a new analyzer with default settings.
NewAnalyzerWithCropSettings returns a new analyzer with the given settings.
SmartCrop applies the smartcrop algorithms on the the given image and returns the top crop or an error if something went wrong.

# Variables

ErrInvalidDimensions gets returned when the supplied dimensions are invalid.

# Structs

Crop contains results.
CropSettings contains options to change cropping behaviour.
Score contains values that classify matches.

# Interfaces

Analyzer interface analyzes its struct and returns the best possible crop with the given width and height returns an error if invalid.