[Top] [Prev] [Next] [Bottom]

SDsetcal/sfscal

intn SDsetcal(int32 sds_id, float64 cal, float64 cal_err, float64 offset, float64 offset_err, int32 data_type)
sds_id

IN:

Dataset identifier returned from SDselect

cal

IN:

Calibration factor

cal_err

IN:

Calibration error

offset

IN:

Uncalibrated offset

offset_err

IN:

Uncalibrated offset error

data_type

IN:

Data type of uncalibrated data

Purpose

Sets the calibration information.

Return value

Returns SUCCEED (or 0) if successful and FAIL (or -1) otherwise.

Description

SDsetcal stores the calibration record associated with a dataset. A calibration record contains the following information:

cal Calibration factor

cal_err Calibration error

offset Uncalibrated offset

offset_err Uncalibrated offset error

data_type Data type of uncalibrated data

The relationship between a value iy stored in a dataset and the actual value is defined as: y = cal * (iy - offset)

The variable offset_err contains a potential error of offset, and cal_err contains a potential error of cal. Currently the calibration record is provided for information only. The SD interface performs no operations on the data based on the calibration tag.

SDsetcal works like other SDset* routines, with one exception: the calibration information is automatically cleared after a call to SDreaddata or SDwritedata. Hence, SDsetcal must be called anew for each dataset that is to be written.

FORTRAN

integer function sfscal(sds_id, cal, cal_err, offset, offset_err, data_type)

integer sds_id, data_type

real*8 cal, cal_err, offset, offset_er

r



[Top] [Prev] [Next] [Bottom]

hdfhelp@ncsa.uiuc.edu
HDF User's Reference Manual, Draft 06/09/97, NCSA HDF Development Group.