pnm

package module

v0.0.2 Latest Latest Go to latest Published: Jun 12, 2023 License: BSD-2-Clause Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/UNO-SOFT/gopnm

Links

Open Source Insights

README ¶

Package pnm

Package pnm implements a PBM, PGM and PPM image decoder and encoder.

This package is compatible with Go version 1.

Installation

	go install github.com/UNO-SOFT/gopnm

Limitations

Not implemented are:

Writing pnm files in raw format.
Writing images with 16 bits per channel.
Writing images with a custom Maxvalue.
Reading/and writing PAM images.

(I would be happy to accept patches for these.)

Documentation ¶

Overview ¶

Package pnm implements a PBM, PGM and PPM image decoder and encoder.

The decoder can read files in both plain and raw format with 8 or 16 bits per channel. The encoder can only write files in plain format with 8 bits per channel.

To only be able to load pnm images using image.Decode, use

import _ "github.com/UNO-SOFT/gopnm"

Not implemented are:

Writing pnm files in raw format.
Reading/and writing PAM images.

(I would be happy to accept patches for these.)

Specifications can be found at http://netpbm.sourceforge.net/doc/#formats.

Index ¶

Constants
func Decode(r io.Reader) (image.Image, error)
func DecodeConfig(r io.Reader) (image.Config, error)
func Encode(w io.Writer, m image.Image, pnmType int) error
type PNMConfig
- func DecodeConfigPNM(r *bufio.Reader) (c PNMConfig, err error)

Constants ¶

View Source

const (
	PBM int = 0
	PGM int = 1
	PPM int = 2
)

Variables ¶

This section is empty.

Functions ¶

func Decode ¶

func Decode(r io.Reader) (image.Image, error)

Decode reads a PNM image from r and returns it as an image.Image.

The type of Image returned depends on the PNM contents:

PBM: image.Gray with black = 0 and white = 255
PGM: image.Gray or image.Gray16, values as in the file
PPM: image.RGBA or image.RGBA64, values as in the file
PAM: not supported (yet)

func DecodeConfig ¶

func DecodeConfig(r io.Reader) (image.Config, error)

DecodeConfig returns the color model and dimensions of a PNM image without decoding the entire image.

func Encode ¶

func Encode(w io.Writer, m image.Image, pnmType int) error

Encode writes an image.Image m to io.Writer w in PNM format.

The specific format is determined by pnmType, this can be one of:

pnm.PBM (black/white)
pnm.PGM (grayscale)
pnm.PPM (RGB)

The image m is converted if necessary.

Types ¶

type PNMConfig ¶

type PNMConfig struct {
	Width  int
	Height int
	Maxval int
	// contains filtered or unexported fields
}

func DecodeConfigPNM ¶

func DecodeConfigPNM(r *bufio.Reader) (c PNMConfig, err error)

DecodeConfigPNM reads and returns header data of PNM files.

This may be useful to obtain the actual file type and for files that have a Maxval other than the maximum supported Maxval. To apply gamma correction this value is needed. Note that gamma correction is not performed by the decoder.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL