README
¶
imgscan - fast scanning of rectangular regions of image.Image.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrUnsupportedType = errors.New("scanner: unsupported image type")
ErrUnsupportedType is returned by NewScanner when an implementation of imgscan.Scanner for the specific image type doesn't exist.
Functions ¶
This section is empty.
Types ¶
type Scanner ¶
type Scanner interface {
image.Image
// IsUniformColor indicates if the region r is only made of pixels of color c.
//
// The scan stops at the first pixel encountered that is different from c.
IsUniformColor(r image.Rectangle, c color.Color) bool
// IsUniform indicates if the region r is uniform. If that is the case, the
// uniform color is returned, otherwise the returned color is nil.
//
// The scan stops at the first pixel encountered that is different from the
// previous one.
IsUniform(r image.Rectangle) (bool, color.Color)
// AverageColor indicates wether the region is uniform and the average color
// of the region r. If all the pixels have the same color (i.e the region is
// uniform) then the average color is that color.
//
// A full scan of the region is performed in order to determine the average
// color.
AverageColor(r image.Rectangle) (bool, color.Color)
}
A Scanner behaves as an image.Image, with added color scanning capabilities.
For example, it can report wether a particular region of the image it embeds is uniform (i.e made of an unique color), what is this uniform color, or compute the average color.
func NewBinaryScanner ¶
NewBinaryScanner creates a binary scanner from a binary image.
func NewGrayScanner ¶
NewGrayScanner creates a gray scanner from a gray image.
func NewScanner ¶
NewScanner returns a new Scanner of the given image.Image.
The actual scanner implementation depends on the image bit depth and the availability of an implementation. If a specific implementation of Scanner doesn't exist for the type of img, err will be ErrUnsupportedType.
Source Files