setupimage: Image Setup for TIFF Export

View source: R/writetiff.R

setupimageR Documentation

Image Setup for TIFF Export

Description

Perpares image for TIFF export.

Usage

setupimage(image, what, compression, endianness = .Platform$endian)

Arguments

image

a matrix or array or representing the image:
-2D matrix [h,w] will be written as single grayscale [h,w] IFD (Image Field Directory),
-3D array [h,w,c] will be written as single IFD of multichannel [h,w,c],
-4D array [h,w,c,f] will be written as multiple (multiframe) IFDs of multichannel [h,w,c],
with h=height, w=width, c=channel, f=frame.
Eventually, a raw vector with 'dims', 'what' and 'comp' attributes can be directly passed asis (allowing the use compression other than deflate).

what

bits mode used to store image. Allowed are "uint8", "int8", "uint16", "int16", "uint32", "int32", "float" and "double".

compression

whether image should be lossless compressed with deflate algorithm. Default is FALSE.

endianness

The endian-ness ("big" or "little") of the return object. Default is .Platform$endian.

Value

It returns a raw vector with 'dims', 'what' and 'comp' attributes.


gitdemont/IFC documentation built on Feb. 20, 2025, 12:55 a.m.