Package xdp :: Package io :: Module xafs :: Class Xafs
[show private | hide private]
[frames | no frames]

Class Xafs


The contents of the header of an MR-CAT XAFS file.

Default field values:

To Do:

Method Summary
  __init__(self)
Create an empty XAFS header.
  write(self, data, stream)
Write a dataset to an output stream in the MR-CAT XAFS file format, using this header's fields.

Instance Variable Summary
string Comment1: comment line 1
string Comment2: comment line 2
string Comment3: comment line 3
float E0: edge energy
string FileInfo: description of the dataset
list of floats Gains: header field
int NumRegions: header field
list of floats Offsets: header field
2-tuple of the form energy, units RingEnergy: header field
float SettlingTime: header field
list of ints SPP: header field
list of ints SRB: header field
list of ints SRSS: header field

Method Details

__init__(self)
(Constructor)

Create an empty XAFS header.

write(self, data, stream)

Write a dataset to an output stream in the MR-CAT XAFS file format, using this header's fields.
Parameters:
data - dataset
           (type=Data)
stream - output stream
           (type=file)

Note: The output is written in the MRCAT XAFS format.

To Do: check values thoroughly while outputting them


Instance Variable Details

Comment1

comment line 1
Type:
string

Comment2

comment line 2
Type:
string

Comment3

comment line 3
Type:
string

E0

edge energy
Type:
float

FileInfo

description of the dataset
Type:
string

Gains

header field
Type:
list of floats

NumRegions

header field
Type:
int

Offsets

header field
Type:
list of floats

RingEnergy

header field
Type:
2-tuple of the form energy, units

SettlingTime

header field
Type:
float

SPP

header field
Type:
list of ints

SRB

header field
Type:
list of ints

SRSS

header field
Type:
list of ints

Generated by Epydoc 2.1 on Wed Jul 20 11:51:05 2005 http://epydoc.sf.net