HDF5 Node Interface

• Home
• Documentation
• Install & Setup
• Tutorial
• Writing & Reading Subsets
• Metadata & Attributes
• Events in Packets
• Modify Tables
• Populate Tables
• Working with Images
• Making & Reading Datasets
• Reference
• References
• Library
• Filters
• Dimension Scales
• Globals
• File
• Groups
• Packet Tables
• Datasets
• Tables
• Images

var h5lt = require('hdf5').h5lt;

Attributes @deprecated

• rank - # of dimensions or order
• rows - # of rows
• columns - # of columns
• section - # of sections on the 3rd rank

Functions

h5lt.makeDataset(id, name, buffer [, options])

• id → the group or file id location. Every group and the file return with an id attribute
• name → a string naming the dataset.
• buffer → Typed array, string or a node::Buffer. The buffer can have attributes describing its shape. When using a node::Buffer the data is expected to be homogeneous and the type attribute set to choice in H5Type
• [options] → The shape propertes such as type, rank, rows,columns, sections and files. Currently has the option to set compression { compression: 6}. can be 0 through 9. For an Array of fixed width strings {fixed_width: maxLength} option sets the width. The Array can hold variable length strings and this call will make a fixed buffer and if any are actually greater than maxLength an exception is thrown.

h5lt.writeDataset(id, name, buffer [, options])

• id → the group or file id location. Every group and the file return with an id attribute
• name → a string naming the dataset.
• buffer → Typed array, string or a node::Buffer. The buffer can have attributes describing its shape. When using a node::Buffer the data is expected to be homogeneous and the type attribute set to choice in H5Type
• [options] → start, stride and count.

h5lt.readDataset(id, name [, options] [, function(options){}])

• id → the group or file id location. Every group and the file return with an id attribute
• name → a string naming the dataset.
• [options] → start, stride and count.
• a synchronous callback with the options properties of how e dataset is structured
• return ← A typed array or string

h5lt.readDatasetAsBuffer(id, name [, options] [, function(options){}])

• id → the group or file id location. Every group and the file return with an id attribute
• name → a string naming the dataset.
• [options] → start, stride and count.
• return ← A node::Buffer with the data and attributes for its shape and type.

Exceptions

• start and/or stride of a hyperslab read can not be set without the count property. Start defaults to the origin and the stride to 1 in all dimensions.