File I/O » DIPjavaio module
#include "diplib/javaio.h"

An interface to Java file I/O functionality

Contents

Namespaces

namespace dip::javaio
Contains all functionality for DIPjavaio.

Functions

auto dip::javaio::ImageReadJavaIO(dip::Image& out, dip::String const& filename, dip::String const& interface = bioformatsInterface, dip::uint imageNumber = 0) -> dip::FileInformation
Reads the image in a file filename recognized by a Java interface and puts it in out.

Function documentation

dip::FileInformation dip::javaio::ImageReadJavaIO(dip::Image& out, dip::String const& filename, dip::String const& interface = bioformatsInterface, dip::uint imageNumber = 0)

Reads the image in a file filename recognized by a Java interface and puts it in out.

There is currently only one interface defined:

  • "org/diplib/BioFormatsInterface": The Bio-Formats package (default). Can read over 160 different image file formats. Limitation: each x-y plane of a (multi-dimensional) image must occupy no more than 2 GB when uncompressed, and each individual dimension must be smaller than 231-1. Metadata is currently not read.

If the file contains multiple images, select the desired one by setting imageNumber. Note that it is the interface that decides what an image is. For example, Bio-Formats will consider multi-page TIFF files to be either a single 3D image or a series of individual images depending on some internal logic.

Information about the file and all metadata are returned in the dip::FileInformation output argument.