Go to file

nfnt f2d1b73023 Merge branch 'alpha_channel_fix' Colors in image.RGBA, image.RGBA64 and generic types with alpha channel should now resize correctly. There's a small performance hit for these image types even if they don't use alpha channels though. Fixes bug #26.		2015-05-12 16:00:13 +02:00
.travis.yml	Go >=1.1 is needed for this package.	2014-10-24 14:47:00 +02:00
converter_test.go	Add unit tests for converter.go	2014-07-19 13:31:16 +02:00
converter.go	Reverse alpha-premultiplication for image.RGBA, image.RGBA64 and generic images	2015-05-12 15:19:11 +02:00
filters.go	Dst pixel coordinate fix	2015-03-19 22:52:55 +03:00
LICENSE	Documentation updated	2012-08-03 17:39:38 +02:00
nearest_test.go	Optimize YCbCr image resize	2014-07-30 02:08:58 -04:00
nearest.go	Add functions for nearest-neighbor resize of NRGBA, NRGBA16.	2015-03-25 20:17:14 +01:00
README.md	Mention optimized access for image.NRGBA, image.NRGBA64 in README.	2015-05-12 15:47:43 +02:00
resize_test.go	Merge branch 'alpha_channel_fix'	2015-05-12 16:00:13 +02:00
resize.go	Fix compile error.	2015-03-25 20:23:07 +01:00
thumbnail_test.go	Add: thumbnail helper function	2013-11-27 22:40:16 +01:00
thumbnail.go	Add: thumbnail helper function	2013-11-27 22:40:16 +01:00
ycc_test.go	Fix error in YCC PixOffset and SubImage.	2014-08-12 14:22:06 -04:00
ycc.go	Fix YCC SubImage.	2014-08-12 14:41:20 -04:00

README.md

Resize

Image resizing for the Go programming language with common interpolation methods.

Installation

$ go get github.com/nfnt/resize

It's that easy!

Usage

This package needs at least Go 1.1. Import package with

import "github.com/nfnt/resize"

The resize package provides 2 functions:

resize.Resize creates a scaled image with new dimensions (width, height) using the interpolation function interp. If either width or height is set to 0, it will be set to an aspect ratio preserving value.
resize.Thumbnail downscales an image preserving its aspect ratio to the maximum dimensions (maxWidth, maxHeight). It will return the original image if original sizes are smaller than the provided dimensions.

resize.Resize(width, height uint, img image.Image, interp resize.InterpolationFunction) image.Image
resize.Thumbnail(maxWidth, maxHeight uint, img image.Image, interp resize.InterpolationFunction) image.Image

The provided interpolation functions are (from fast to slow execution time)

NearestNeighbor: Nearest-neighbor interpolation
Bilinear: Bilinear interpolation
Bicubic: Bicubic interpolation
MitchellNetravali: Mitchell-Netravali interpolation
Lanczos2: Lanczos resampling with a=2
Lanczos3: Lanczos resampling with a=3

Which of these methods gives the best results depends on your use case.

Sample usage:

package main

import (
	"github.com/nfnt/resize"
	"image/jpeg"
	"log"
	"os"
)

func main() {
	// open "test.jpg"
	file, err := os.Open("test.jpg")
	if err != nil {
		log.Fatal(err)
	}

	// decode jpeg into image.Image
	img, err := jpeg.Decode(file)
	if err != nil {
		log.Fatal(err)
	}
	file.Close()

	// resize to width 1000 using Lanczos resampling
	// and preserve aspect ratio
	m := resize.Resize(1000, 0, img, resize.Lanczos3)

	out, err := os.Create("test_resized.jpg")
	if err != nil {
		log.Fatal(err)
	}
	defer out.Close()

	// write new image to file
	jpeg.Encode(out, m, nil)
}

Caveats

Optimized access routines are used for image.RGBA, image.NRGBA, image.RGBA64, image.NRGBA64, image.YCbCr, image.Gray, and image.Gray16 types. All other image types are accessed in a generic way that will result in slow processing speed.
JPEG images are stored in image.YCbCr. This image format stores data in a way that will decrease processing speed. A resize may be up to 2 times slower than with image.RGBA.

Downsizing Samples

Downsizing is not as simple as it might look like. Images have to be filtered before they are scaled down, otherwise aliasing might occur. Filtering is highly subjective: Applying too much will blur the whole image, too little will make aliasing become apparent. Resize tries to provide sane defaults that should suffice in most cases.