PNMImageHeader

from acron.core import PNMImageHeader

class PNMImageHeader

Bases:

Bases: MemoryBase

This is the base class of PNMImage, PNMReader, and PNMWriter. It encapsulates all the information associated with an image that describes its size, number of channels, etc; that is, all the information about the image except the image data itself. It’s the sort of information you typically read from the image file’s header.

Inheritance diagram

digraph inheritance85e1b001de { bgcolor=transparent; rankdir=BT; size="8.0, 12.0"; "DTOOL_SUPER_BASE" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style=""]; "PNMImageHeader" [URL="acron.core.PNMImageHeader.html#acron.core.PNMImageHeader",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "PNMImageHeader" [arrowsize=0.75,style=""]; }

enum ColorType

This enumerated type indicates the number of channels in the image, and also implies an image type. You can treat it either as an integer number of channels or as an enumerated image type.

enumerator CT_invalid = 0

enumerator CT_grayscale = 1

enumerator CT_two_channel = 2

enumerator CT_color = 3

enumerator CT_four_channel = 4

class HistMap

Bases:

alias of map_PixelSpec_int

class Histogram

Bases:

Used to return a pixel histogram in PNMImage::get_histogram().

__init__()

get_count()

Returns the number of occurrences in the image of the nth unique pixel color in the histogram.

Returns the number of occurrences in the image of the indicated pixel color.

get_num_pixels()

Returns the number of unique pixel colors in the histogram.

get_pixel()

Returns the nth unique pixel color in the histogram. These are ordered by default from most common to least common.

get_pixels() → list

write()

class Palette

Bases:

alias of pvector_PixelSpec

class PixelCount

Bases:

alias of pvector_PixelSpecCount

class PixelSpec

Bases:

Contains a single pixel specification used in compute_histogram() and make_histogram(). Note that pixels are stored by integer value, not by floating-point scaled value.

__eq__()

__getitem__()

__init__()

__lt__()

__ne__()

compare_to()

get_alpha()

get_blue()

get_green()

get_red()

output()

set_alpha()

set_blue()

set_green()

set_red()

static size()

Specifies the number of components in the PixelSpec; this is always 4, regardless of the type of image it was taken from.

class PixelSpecCount

Bases:

Associates a pixel specification with an appearance count, for use in Histogram, below.

__init__()

__init__()

assign()

property color_space → ColorSpace

Returns the color space that the image is encoded in, or CS_unspecified if unknown.

property comment → string

Getter

Gets the user comment from the file.

Setter

Writes a user comment string to the image (header).

get_color_space()

Returns the color space that the image is encoded in, or CS_unspecified if unknown.

get_color_type()

Returns the image type of the image, as an enumerated value. This is really just the number of channels cast to the enumerated type.

get_comment()

Gets the user comment from the file.

get_maxval()

Returns the maximum channel value allowable for any pixel in this image; for instance, 255 for a typical 8-bit-per-channel image. A pixel with this value is full on.

get_num_channels()

Returns the number of channels in the image.

get_size()

Returns the number of pixels in each direction. This is one more than the largest allowable coordinates.

get_type()

If the file type is known (e.g. has_type() returns true), returns its PNMFileType pointer; otherwise, returns NULL.

get_x_size()

Returns the number of pixels in the X direction. This is one more than the largest allowable X coordinate.

get_y_size()

Returns the number of pixels in the Y direction. This is one more than the largest allowable Y coordinate.

has_alpha()

This static variant of has_alpha() returns true if the indicated image type includes an alpha channel, false otherwise.

Returns true if the image includes an alpha channel, false otherwise. Unlike is_grayscale(), if this returns false it is an error to call any of the functions accessing the alpha channel.

has_type()

Returns true if the PNMImageHeader knows what type it is, false otherwise.

is_grayscale()

This static variant of is_grayscale() returns true if the indicated image type represents a grayscale image, false otherwise.

Returns false if the image is a full-color image, and has red, green, and blue components; true if it is a grayscale image and has only a gray component. (The gray color is actually stored in the blue channel, and the red and green channels are ignored.)

make_reader()

Returns a newly-allocated PNMReader of the suitable type for reading from the indicated image filename, or NULL if the filename cannot be read for some reason. The filename “-” always stands for standard input. If type is specified, it is a suggestion for the file type to use.

The PNMReader should be deleted when it is no longer needed.

Returns a newly-allocated PNMReader of the suitable type for reading from the already-opened image file, or NULL if the file cannot be read for some reason.

owns_file should be set true if the PNMReader is to be considered the owner of the stream pointer (in which case the stream will be deleted on completion, whether successful or not), or false if it should not delete it.

The filename parameter is optional here, since the file has already been opened; it is only used to examine the extension and attempt to guess the file type.

If magic_number is nonempty, it is assumed to represent the first few bytes that have already been read from the file. Some file types may have difficulty if this is more than two bytes.

If type is non-NULL, it is a suggestion for the file type to use.

The PNMReader should be deleted when it is no longer needed.

make_writer()

Returns a newly-allocated PNMWriter of the suitable type for writing an image to the indicated filename, or NULL if the filename cannot be written for some reason. The filename “-” always stands for standard output. If type is specified, it is a suggestion for the file type to use.

The PNMWriter should be deleted when it is no longer needed.

Returns a newly-allocated PNMWriter of the suitable type for writing to the already-opened image file, or NULL if the file cannot be written for some reason.

owns_file should be set true if the PNMWriter is to be considered the owner of the stream pointer (in which case the stream will be deleted on completion, whether successful or not), or false if it should not delete it.

The filename parameter is optional here, since the file has already been opened; it is only used to examine the extension and attempt to guess the intended file type.

If type is non-NULL, it is a suggestion for the file type to use.

The PNMWriter should be deleted when it is no longer needed.

property maxval → int

Returns the maximum channel value allowable for any pixel in this image; for instance, 255 for a typical 8-bit-per-channel image. A pixel with this value is full on.

property num_channels → int

Returns the number of channels in the image.

output()

read_header()

Opens up the image file and tries to read its header information to determine its size, number of channels, etc. If successful, updates the header information and returns true; otherwise, returns false.

Reads the image header information only from the indicated stream.

The filename is advisory only, and may be used to suggest a type if it has a known extension.

If type is non-NULL, it is a suggestion for the type of file it is (and a non-NULL type will override any magic number test or filename extension lookup).

Returns true if successful, false on error.

static read_magic_number()

Ensures that the first n bytes of the file are read into magic_number. If magic_number is initially nonempty, assumes these represent the first few bytes already extracted. Returns true if successful, false if an end of file or error occurred before num_bytes could be read.

set_comment()

Writes a user comment string to the image (header).

set_type()

Sets the file type of this PNMImage. This will be the default type used when an image is read, if the type cannot be determined by magic number or inferred by extension, or the type used when the image is written, if the type cannot be inferred from the filename extension.

property size → LVecBase2i

Returns the number of pixels in each direction. This is one more than the largest allowable coordinates.

property type → PNMFileType

If the file type is known (e.g. has_type() returns true), returns its PNMFileType pointer; otherwise, returns NULL.