1HDF(3)                User Contributed Perl Documentation               HDF(3)
2
3
4

NAME

6       PDL::IO::HDF - A PDL interface to the HDF4 library.
7

SYNOPSIS

9         use PDL;
10         use PDL::IO::HDF;
11
12         # Open file 'foo.hdf' with all hdf interface:
13         my $HDF = PDL::IO::HDF->new("foo.hdf");
14
15         # You can call functions from either the SD or VS interfaces:
16         $HDF->{SD}->SDget("Foo_data");
17         $HDF->{VS}->VSgetnames();
18
19         # To close the file:
20         $HDF->close();
21

DESCRIPTION

23       This library provides functions to manipulate HDF files with the SD,
24       VS, and V HDF interfaces.
25
26       For more information on HDF, see http://hdf.ncsa.uiuc.edu/
27
28       The 'new' function of this package uses the 'new' functions for the
29       individual HDF interfaces. This allows you to use all of the interfaces
30       at one time (if you don't mind the extended syntax).
31
32       Actually using the HDF files comes down to using one of the particular
33       interfaces, for that see the docs on those modules.
34

CONSTANTS

36       These constants are now implented using the perl 'use constant' pragma.
37
38       Previously, they were just scalars that were changeable (which is a no-
39       no).
40
41       See constant(1) for more info on how to use these in your code.
42
43   Access Modes
44       DFACC_READ
45               Open the file in read-only mode.
46
47       DFACC_WRITE
48               Open the file in write-only mode.
49
50       DFACC_CREATE
51               Clobber the file (create it if it doesn't exist, and then open
52               with RW mode).
53
54       DFACC_ALL
55               Open the file in read-write mode.
56
57       DFACC_RDONLY
58               Same as DFACC_READ
59
60       DFACC_RDWR
61               Open the file in read-write mode.
62
63   VS Interface Interlacing Modes
64       FULL_INTERLACE
65       NO_INTERLACE
66
67   HDF4 Data Type Codes:
68       DFNT_UCHAR
69               HDF's unsigned char ~= PDL's byte
70
71       DFNT_CHAR
72               HDF's char ~= PDL's byte
73
74       DFNT_FLOAT32
75               HDF's 32-bit float ~= PDL's float
76
77       DFNT_FLOAT64
78               HDF's 64-bit float ~= PDL's double
79
80       DFNT_INT8
81               HDF's 8-bit integer ~= PDL's byte
82
83       DFNT_UINT8
84               HDF's 8-bit unsigned integer ~= PDL's byte
85
86       DFNT_INT16
87               HDF's 16-bit integer ~= PDL's short
88
89       DFNT_UINT16
90               HDF's 16-bit unsigned integer ~= PDL's ushort
91
92       DFNT_INT32
93               HDF's 32-bit integer ~= PDL's long
94
95       DFNT_INT64
96               HDF's 32-bit integer ~= PDL's long
97
98   Misc. HDF Library Constants:
99       MAX_NC_NAME
100               This is the max name length for SDS variables, attribtues, and
101               just about anything else.
102
103       MAX_VAR_DIMS
104               This is the max number of dims a HDF variable can have.
105
106       VNAMELENMAX
107               Max length of V interface names.
108

CURRENT AUTHOR & MAINTAINER

110       Judd Taylor, Orbital Systems, Ltd.  judd dot t at orbitalsystems dot
111       com
112

PREVIOUS AUTHORS

114       Patrick Leilde patrick.leilde@ifremer.fr contribs of Olivier Archer
115       olivier.archer@ifremer.fr
116

SEE ALSO

118       perl(1), PDL(1), PDL::IO::HDF::SD(1), PDL::IO::HDF::VS(1), constant(1).
119
120
121
122perl v5.28.0                      2018-05-05                            HDF(3)