.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "VS 3pm" .TH VS 3pm 2024-04-25 "perl v5.38.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME PDL::IO::HDF::VS \- An interface library for HDF4 files. .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 2 \& use PDL; \& use PDL::IO::HDF::VS; \& \& #### no doc for now #### .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" This library provides functions to manipulate HDF4 files with VS and V interface (reading, writing, ...) .PP For more information on HDF4, see http://www.hdfgroup.org/products/hdf4/ .SH FUNCTIONS .IX Header "FUNCTIONS" .SS new .IX Subsection "new" .Vb 1 \& Open or create a new HDF object with VS and V interface. .Ve .PP .Vb 5 \& Arguments: \& 1 : The name of the HDF file. \& If you want to write to it, prepend the name with the \*(Aq+\*(Aq character : "+name.hdf" \& If you want to create it, prepend the name with the \*(Aq\-\*(Aq character : "\-name.hdf" \& Otherwise the file will be opened in read only mode. \& \& Returns the hdf object (die on error) .Ve .PP .Vb 1 \& my $hdf = PDL::IO::HDF::VS\->new("file.hdf"); .Ve .SS close .IX Subsection "close" .Vb 1 \& Close the VS interface. .Ve .PP .Vb 1 \& no arguments .Ve .PP .Vb 1 \& my $result = $hdf\->close(); .Ve .SH "CURRENT AUTHOR & MAINTAINER" .IX Header "CURRENT AUTHOR & MAINTAINER" Judd Taylor, Orbital Systems, Ltd. judd dot t at orbitalsystems dot com .SH "PREVIOUS AUTHORS" .IX Header "PREVIOUS AUTHORS" Olivier Archer olivier.archer@ifremer.fr contribs of Patrick Leilde patrick.leilde@ifremer.fr .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBperl\fR\|(1), \fBPDL\fR\|(1), \fBPDL::IO::HDF\fR\|(1).