ImportCactusHDF5

Category

Import and Export

Function

Imports datasets from an external HDF5 data file which was generated by Cactus' IOHDF5 output method.

Syntax

result, max_index = ImportCactusHDF5 (filename, origin, thickness, stride, index,
                                      reopen, single_precision);

Inputs

Name	Type	Default	Description
`filename`	string	(none)	filename or URL of the HDF5 file to import datasets from
`origin`	integer list or vector	NULL	lower-left corner grid point of the slab to read
`thickness`	integer list or vector	NULL	thickness in grid points of the slab to read
`stride`	integer list or vector	NULL	include every <stride>-th grid point in the slab to read
`index`	integer	0	index of the dataset to import
`reopen`	flag	0	reopen file on each execution
`single_precision`	flag	1	import double precision floating-point datasets as single precision
`user`	string	(none)	user name for standard Ftp authentification during remote file access
`password`	string	(none)	password for standard Ftp authentification during remote file access
`subject`	string	(none)	subject name for GSI authentification during remote file access
`num_streams`	integer	1	number of parallel streams to use during remote file access

Outputs

Name	Type	Description
`result`	field	the dataset imported as a field with regular positions and connections
`max_index`	integer	largest possible dataset index

Functional Details

The ImportCactusHDF5 module provides the same basic functionality as the ImportHDF5 module. Please refer to the user's reference of ImportHDF5 for a full description about the functional details.

In addition to ImportHDF5, the ImportCactusHDF5 module can also read data from distributed datasets contained in one or more chunked HDF5 datafiles (as are typically created during a multiprocessor Cactus simulation using parallel output). It is sufficient to supply any filename from the set of chunked files to the filename input of the module - it will then automatically detect the presence of chunked data and open all the chunked files accordingly.
Note: ImportCactusHDF5 can only open chunked datafiles which are located on a local filesystem. Access to streamed HDF5 files, or to remote HDF5 files located on a GridFtp server, is not implemented yet.

See Also

Import, Slab, ImportHDF5

Further Documentation

The ImportCactusHDF5 data import module is provided by the OpenDXutils package. More information about this package can be found on the Cactus Code visualization page for OpenDX.

Created by jeffd
Last modified 2006-06-30 01:15 PM

The Cactus Code

Sections

Personal tools

Navigation

ImportCactusHDF5

ImportCactusHDF5

News