The LAMP Application

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

lamp_mac/

write_hdf.pro


Routines

result = HxF_OPEN(FileName, create=create)

result = HxF_SD_START(FileName, RDWR=RDWR)

HxF_SD_ATTRSET, sdid, name, P, dim, _extra=_extra

result = HxF_VG_ATTACH(fid, m1, WRITE=WRITE)

HxF_VG_SETINFO, vdid, name=name, class=class

HxF_VG_INSERT, vdid, vdat

result = HxF_SD_CREATE(sdid, name, sv, _extra=_extra)

HxF_SD_ADDDATA, sd0id, para

result = HxF_SD_IDTOREF(sd0id)

HxF_VG_ADDTR, vdat, sdtag, ref

HxF_SD_SETINFO, sdsid, FORMAT=FORMAT, LABEL=LABEL

result = HxF_SD_DIMGETID(sd0id, axe)

HxF_SD_DIMSET, sdxid, NAME=NAME, LABEL=LABEL, SCALE=SCALE, BW_INCOMP=BW_INCOMP

HxF_SD_ENDACCESS, sdsid

HxF_SD_SETCOMPRESS, sdsid, cps

HxF_VG_DETACH, gid

HxF_SD_END, sdid

HxF_CLOSE, fid

prepare_SD_H5, data

write_hdf, FileName, Data, XC=XC, YC=YC, ZC=ZC, E=E, N=N, PR=PR, PV=PV, P_TXT=P_TXT, W_tit=W_tit, X_tit=X_tit, Y_TIT=Y_TIT, Z_tit=Z_tit, OTHER_TIT=OTHER_TIT, SRC=SRC, HIST=HIST, PAR_TXT_ALL=PAR_TXT_ALL, LIM=LIM, MACH=MACH, DOE=DOE, SNAP=SNAP, DATE=DATE, FIFI=FIFI

Routine details

top HxF_OPEN

result = HxF_OPEN(FileName, create=create)

************************ ** part of hdf lamp api

Parameters

FileName

Keywords

create

top HxF_SD_START

result = HxF_SD_START(FileName, RDWR=RDWR)

************************ ** part of hdf lamp api

Parameters

FileName

Keywords

RDWR

top HxF_SD_ATTRSET

HxF_SD_ATTRSET, sdid, name, P, dim, _extra=_extra

************************ ** part of hdf lamp api

Parameters

sdid
name
P
dim

Keywords

_extra

top HxF_VG_ATTACH

result = HxF_VG_ATTACH(fid, m1, WRITE=WRITE)

************************ ** part of hdf lamp api

Parameters

fid
m1

Keywords

WRITE

top HxF_VG_SETINFO

HxF_VG_SETINFO, vdid, name=name, class=class

************************ ** part of hdf lamp api

Parameters

vdid

Keywords

name
class

top HxF_VG_INSERT

HxF_VG_INSERT, vdid, vdat

************************ ** part of hdf lamp api

Parameters

vdid
vdat

top HxF_SD_CREATE

result = HxF_SD_CREATE(sdid, name, sv, _extra=_extra)

************************ ** part of hdf lamp api

Parameters

sdid
name
sv

Keywords

_extra

top HxF_SD_ADDDATA

HxF_SD_ADDDATA, sd0id, para

************************ ** part of hdf lamp api

Parameters

sd0id
para

top HxF_SD_IDTOREF

result = HxF_SD_IDTOREF(sd0id)

************************ ** part of hdf lamp api

Parameters

sd0id

top HxF_VG_ADDTR

HxF_VG_ADDTR, vdat, sdtag, ref

************************ ** part of hdf lamp api

Parameters

vdat
sdtag
ref

top HxF_SD_SETINFO

HxF_SD_SETINFO, sdsid, FORMAT=FORMAT, LABEL=LABEL

************************ ** part of hdf lamp api

Parameters

sdsid

Keywords

FORMAT
LABEL

top HxF_SD_DIMGETID

result = HxF_SD_DIMGETID(sd0id, axe)

************************ ** part of hdf lamp api

Parameters

sd0id
axe

top HxF_SD_DIMSET

HxF_SD_DIMSET, sdxid, NAME=NAME, LABEL=LABEL, SCALE=SCALE, BW_INCOMP=BW_INCOMP

************************ ** part of hdf lamp api

Parameters

sdxid

Keywords

NAME
LABEL
SCALE
BW_INCOMP

top HxF_SD_ENDACCESS

HxF_SD_ENDACCESS, sdsid

************************ ** part of hdf lamp api

Parameters

sdsid

top HxF_SD_SETCOMPRESS

HxF_SD_SETCOMPRESS, sdsid, cps

************************ ** part of hdf lamp api

Parameters

sdsid
cps

top HxF_VG_DETACH

HxF_VG_DETACH, gid

************************ ** part of hdf lamp api

Parameters

gid

top HxF_SD_END

HxF_SD_END, sdid

************************ ** part of hdf lamp api

Parameters

sdid

top HxF_CLOSE

HxF_CLOSE, fid

************************ ** part of hdf lamp api

Parameters

fid

top prepare_SD_H5

prepare_SD_H5, data

************************ ** part of hdf lamp api

Parameters

data

top write_hdf

write_hdf, FileName, Data, XC=XC, YC=YC, ZC=ZC, E=E, N=N, PR=PR, PV=PV, P_TXT=P_TXT, W_tit=W_tit, X_tit=X_tit, Y_TIT=Y_TIT, Z_tit=Z_tit, OTHER_TIT=OTHER_TIT, SRC=SRC, HIST=HIST, PAR_TXT_ALL=PAR_TXT_ALL, LIM=LIM, MACH=MACH, DOE=DOE, SNAP=SNAP, DATE=DATE, FIFI=FIFI

** ********* ** ** Call for data-write HDF NeXus (called by LAMP). ** ** FileName: name of the output file (file.hdf) ** Data : the data of any dimension. ** Keywords: ** XC = vector of x coordinates. ** YC = vector of y coordinates. ** ZC = vector of z coordinates (or scalar). ** W_TIT = main title ** X_TIT = x axis title ** Y_TIT = y axis title ** Z_TIT = z axis title ** OTHER_TIT= sub title ** N = monitors (or scalar). ** PR = vector of float parameter values (or scalar). ** P_TXT = string array of text associated to PR (same size). ** PV = an array of any dimensions containing other parameter values (or 0). ** E = the errors associated to DATA (same size or 0). ** SRC = Instrument name. ** HIST = An history of the Data (string). ** Other Keywords: ** PAR_TXT_ALL(unnecessary) p_txt + '=' + string(p) (if "" write_hdf will do for you) ** LIM = (unnecessary) ** MACH = (unused) ** DOE = (unused) ** SNAP = (optional) a 192*192 bytarea image snapshot of the Data. ** DATE = (optional) date of experiment (string). ** FIFI = (unused)

Parameters

FileName
Data

Keywords

XC
YC
ZC
E
N
PR
PV
P_TXT
W_tit
X_tit
Y_TIT
Z_tit
OTHER_TIT
SRC
HIST
PAR_TXT_ALL
LIM
MACH
DOE
SNAP
DATE
FIFI

File attributes

Modification date: Tue Oct 1 14:36:01 2013
Lines: 501