The Open FUSION Toolkit 1.0.0-8905cc5
Modeling tools for plasma and fusion research and engineering
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | List of all members
histfile Class Reference

Detailed Description

Class for loading and analyzing a structured OFT binary file.

Public Member Functions

 __getitem__ (self, key)
 
 __init__ (self, filename)
 Load and parse binary file into Python representation.
 
 __iter__ (self)
 
 __repr__ (self)
 Print information about the file.
 
 get (self, keyname, value=None)
 
 items (self)
 
 keys (self)
 
 save_to_hdf5 (self, filename)
 Convert data to HDF5 format.
 
 save_to_matlab (self, filename)
 Convert data to MATLAB format.
 

Public Attributes

 content
 
 dim
 
 field_descriptions
 
 field_repeats
 
 field_sizes
 
 field_tags
 
 field_types
 
 header
 
 line_fmt
 
 line_length
 
 nfields
 
 nlines
 
 offset
 

Protected Attributes

 _data
 
 _filename
 

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self,
  filename 
)

Load and parse binary file into Python representation.

Member Function Documentation

◆ __getitem__()

__getitem__ (   self,
  key 
)

◆ __iter__()

__iter__ (   self)

◆ __repr__()

__repr__ (   self)

Print information about the file.

◆ get()

get (   self,
  keyname,
  value = None 
)

◆ items()

items (   self)

◆ keys()

keys (   self)

◆ save_to_hdf5()

save_to_hdf5 (   self,
  filename 
)

Convert data to HDF5 format.

◆ save_to_matlab()

save_to_matlab (   self,
  filename 
)

Convert data to MATLAB format.

Member Data Documentation

◆ _data

_data
protected

◆ _filename

_filename
protected

◆ content

content

◆ dim

dim

◆ field_descriptions

field_descriptions

◆ field_repeats

field_repeats

◆ field_sizes

field_sizes

◆ field_tags

field_tags

◆ field_types

field_types

◆ header

header

◆ line_fmt

line_fmt

◆ line_length

line_length

◆ nfields

nfields

◆ nlines

nlines

◆ offset

offset

The documentation for this class was generated from the following file: