Main Page | Class Hierarchy | Class List | Directories | File List | Class Members | File Members

hdf_utils.h File Reference

#include "Hdf.hpp"

Functions

int hdf_create_empty_file (const char *file)
int hdf_add_empty_sds (const char *file, const char *sds_name, int32 sds_type, int32 rank, int32 *dimensions, const float64 cal=1., const float64 offset=0., const float64 cal_err=0., const float64 off_err=0.)

Function Documentation

int hdf_add_empty_sds const char *  file,
const char *  sds_name,
int32  sds_type,
int32  rank,
int32 *  dimensions,
const float64  cal = 1.,
const float64  offset = 0.,
const float64  cal_err = 0.,
const float64  off_err = 0.
 

creates a new dataset in an existing hdf file (will fail if a dataset with the same name already exists)

Parameters:
file the hdf file to update
sds_name the name of the new dataset (sds: scientific dataset) to add
sds_type the hdf type code of the new dataset, e.g. DFNT_UINT16, DFNT_FLOAT32... (see HDF documentation for valid type codes)
rank the rank (number of dimensions) of the new dataset to create
dimensions a pointer to the array of dimensions of the new dataset
cal the calibration factor linked to the new dataset (also named slope); relation between calibrated and uncalibrated data is: cal_data = cal*(uncal_data - offset)
offset the offset factor linked to the new dataset; relation between calibrated and uncalibrated data is: cal_data = cal*(uncal_data - offset)
cal_err error on the calibration factor (unused for the time being)
off_err error on the offset (unused for the time being)
Returns:
0 on success, -1 on failure

int hdf_create_empty_file const char *  file  ) 
 

creates a new (empty) hdf file

Parameters:
file the name of the file to create
Returns:
0 on success, -1 on failure


Generated on Wed Apr 19 17:05:06 2006 for Remap by  doxygen 1.3.9.1