carputils.carpio.igb Namespace Reference

Provides a class for IGB IO to/from python numpy arrays. More...

Classes
class	IGBFile
	IGB format file IO class. More...

Functions
def	open (args, kwargs)
	Open an IGB file. More...
def	read (filename, reshape=True)
	Read an IGB file and return the reshaped data array plus header. More...

Variables
string	FORMFEED = b'\x0c'
int	MAXLENGTH = 128*1024
	fopen = open

Detailed Description

Provides a class for IGB IO to/from python numpy arrays.

Function Documentation

open()

def carputils.carpio.igb.open	(		args,
			kwargs
	)

Open an IGB file.

Convenience method to provide normal python style interface to create a file type object.

Parameters

filename	(str) The filename to open.
mode	(str) 'r' for read mode (default), 'w' for write mode

read()

def carputils.carpio.igb.read	(		filename,
			reshape = True
	)

Read an IGB file and return the reshaped data array plus header.

Parameters

filename	(str) The filename to open
reshape	(bool) Reshape the data array. Default: True. DOFs are stored in the lines, time in the columns.

Returns

data (numpy.ndarray) IGB data.

header (dict) Header information of IGB file.

t (numpy.ndarray) Vector with time values associated with data points.

Variable Documentation

fopen

carputils.carpio.igb.fopen = open

FORMFEED

string carputils.carpio.igb.FORMFEED = b'\x0c'

MAXLENGTH

int carputils.carpio.igb.MAXLENGTH = 128*1024