stfio Namespace Reference

The stfio namespace. More...

Classes
class	ProgressInfo
	ProgressInfo class. More...
class	StdoutProgressInfo
	StdoutProgressInfo class. More...
struct	txtImportSettings
	Text file import filter settings. More...
Enumerations
enum	filetype {   atf, abf, axg, ascii,   cfs, igor, son, hdf5,   heka, none }
	File types. More...
Functions
StfioDll Vector_double	vec_scal_plus (const Vector_double &vec, double scalar)
StfioDll Vector_double	vec_scal_minus (const Vector_double &vec, double scalar)
StfioDll Vector_double	vec_scal_mul (const Vector_double &vec, double scalar)
StfioDll Vector_double	vec_scal_div (const Vector_double &vec, double scalar)
StfioDll Vector_double	vec_vec_plus (const Vector_double &vec1, const Vector_double &vec2)
StfioDll Vector_double	vec_vec_minus (const Vector_double &vec1, const Vector_double &vec2)
StfioDll Vector_double	vec_vec_mul (const Vector_double &vec1, const Vector_double &vec2)
StfioDll Vector_double	vec_vec_div (const Vector_double &vec1, const Vector_double &vec2)
StfioDll stfio::filetype	findType (const std::string &ext)
	Attempts to determine the filetype from the filter extension.
StfioDll bool	importFile (const std::string &fName, stfio::filetype type, Recording &ReturnData, const stfio::txtImportSettings &txtImport, stfio::ProgressInfo &progDlg)
	Generic file import.
StfioDll bool	exportFile (const std::string &fName, stfio::filetype type, const Recording &Data, ProgressInfo &progDlg)
	Generic file export.
void	importABFFile (const std::string &fName, Recording &ReturnData, ProgressInfo &progDlg)
	Open an ABF file and store its contents to a Recording object. Attempts to identify the ABF version.
void	importABF1File (const std::string &fName, Recording &ReturnData, ProgressInfo &progDlg)
	Open an ABF1 file and store its contents to a Recording object.
void	importABF2File (const std::string &fName, Recording &ReturnData, ProgressInfo &progDlg)
	Open an ABF2 file and store its contents to a Recording object.
void	importASCIIFile (const std::string &fName, int hLinesToSkip, int nColumns, bool firstIsTime, bool toSection, Recording &ReturnRec, ProgressInfo &progDlg)
	Open an ASCII file and store its contents to a Recording object.
bool	exportASCIIFile (const std::string &fName, const Section &Export)
	Export a Section to a text file.
bool	exportASCIIFile (const std::string &fName, const Channel &Export)
	Export a Channel to a text file.
void	importATFFile (const std::string &fName, Recording &ReturnData, ProgressInfo &progDlg)
	Open an ATF file and store its contents to a Recording object.
StfioDll bool	exportATFFile (const std::string &fName, const Recording &WData)
	Export a Recording to an ATF file.
void	importAXGFile (const std::string &fName, Recording &ReturnData, ProgressInfo &progDlg)
	Open an AXG file and store its contents to a Recording object.
int	importCFSFile (const std::string &fName, Recording &ReturnData, ProgressInfo &progDlg)
	Open a CFS file and store its contents to a Recording object.
StfioDll bool	exportCFSFile (const std::string &fName, const Recording &WData, ProgressInfo &progDlg)
	Export a Recording to a CFS file.
void	importHDF5File (const std::string &fName, Recording &ReturnData, ProgressInfo &progDlg)
	Open a HDF5 file and store its contents to a Recording object.
StfioDll bool	exportHDF5File (const std::string &fName, const Recording &WData, ProgressInfo &progDlg)
	Export a Recording to a HDF5 file.
StfioDll bool	exportIGORFile (const std::string &fName, const Recording &WData, ProgressInfo &progDlg)
	Export a Recording to an Igor binary wave.

---

Detailed Description

The stfio namespace.

All essential core functions and classes are in this namespace. Its purpose is to reduce name mangling problems.

---

Function Documentation

bool stfio::exportASCIIFile	(	const std::string &	fName,
		const Section &	Export
	)

Export a Section to a text file.

Parameters:

fName	Full path to the file to be written.
Export	The section to be exported.

Returns:

true upon success, false otherwise.

bool stfio::exportASCIIFile	(	const std::string &	fName,
		const Channel &	Export
	)

Export a Channel to a text file.

Parameters:

fName	Full path to the file to be written.
Export	The channel to be exported.

Returns:

true upon success, false otherwise.

StfioDll bool stfio::exportATFFile	(	const std::string &	fName,
		const Recording &	WData
	)

Export a Recording to an ATF file.

Parameters:

fName	Full path to the file to be written.
WData	The data to be exported.

StfioDll bool stfio::exportCFSFile	(	const std::string &	fName,
		const Recording &	WData,
		ProgressInfo &	progDlg
	)

Export a Recording to a CFS file.

Parameters:

fName	Full path to the file to be written.
WData	The data to be exported.

Returns:

The CFS file handle.

StfioDll bool stfio::exportHDF5File	(	const std::string &	fName,
		const Recording &	WData,
		ProgressInfo &	progDlg
	)

Export a Recording to a HDF5 file.

Parameters:

fName	Full path to the file to be written.
WData	The data to be exported.

Returns:

The HDF5 file handle.

StfioDll bool stfio::exportIGORFile	(	const std::string &	fName,
		const Recording &	WData,
		ProgressInfo &	progDlg
	)

Export a Recording to an Igor binary wave.

Parameters:

fName	Full path to the file to be written.
WData	The data to be exported.

Returns:

At present, always returns 0.

void stfio::importABF1File	(	const std::string &	fName,
		Recording &	ReturnData,
		ProgressInfo &	progDlg
	)

Open an ABF1 file and store its contents to a Recording object.

Parameters:

fName	The full path to the file to be opened.
ReturnData	On entry, an empty Recording object. On exit, the data stored in fName.
progress	True if the progress dialog should be updated.

void stfio::importABF2File	(	const std::string &	fName,
		Recording &	ReturnData,
		ProgressInfo &	progDlg
	)

Open an ABF2 file and store its contents to a Recording object.

Parameters:

fName	The full path to the file to be opened.
ReturnData	On entry, an empty Recording object. On exit, the data stored in fName.
progress	True if the progress dialog should be updated.

void stfio::importABFFile	(	const std::string &	fName,
		Recording &	ReturnData,
		ProgressInfo &	progDlg
	)

Open an ABF file and store its contents to a Recording object. Attempts to identify the ABF version.

Parameters:

fName	The full path to the file to be opened.
ReturnData	On entry, an empty Recording object. On exit, the data stored in fName.
progress	True if the progress dialog should be updated.

void stfio::importASCIIFile	(	const std::string &	fName,
		int	hLinesToSkip,
		int	nColumns,
		bool	firstIsTime,
		bool	toSection,
		Recording &	ReturnRec,
		ProgressInfo &	progDlg
	)

Open an ASCII file and store its contents to a Recording object.

Parameters:

fName	Full path to the file to be read.
hLinesToSkip	Header lines to skip.
nColumns	Number of columns.
firstIsTime	true if the first column contains time values, false otherwise.
toSection	true if the columns should be put into different sections, false if they should be put into different channels.
ReturnRec	On entry, an empty Recording object. On exit, the data stored in fName.
progress	True if the progress dialog should be updated.

void stfio::importATFFile	(	const std::string &	fName,
		Recording &	ReturnData,
		ProgressInfo &	progDlg
	)

Open an ATF file and store its contents to a Recording object.

Parameters:

fName	Full path to the file to be read.
ReturnData	On entry, an empty Recording object. On exit, the data stored in fName.
progress	True if the progress dialog should be updated.

void stfio::importAXGFile	(	const std::string &	fName,
		Recording &	ReturnData,
		ProgressInfo &	progDlg
	)

Open an AXG file and store its contents to a Recording object.

Parameters:

fName	The full path to the file to be opened.
ReturnData	On entry, an empty Recording object. On exit, the data stored in fName.
progress	True if the progress dialog should be updated.

int stfio::importCFSFile	(	const std::string &	fName,
		Recording &	ReturnData,
		ProgressInfo &	progDlg
	)

Open a CFS file and store its contents to a Recording object.

Parameters:

fName	Full path to the file to be read.
ReturnData	On entry, an empty Recording object. On exit, the data stored in fName.
progress	Set to true if a progress dialog should be updated.

Returns:

0 upon success, a negative error code upon failure.

void stfio::importHDF5File	(	const std::string &	fName,
		Recording &	ReturnData,
		ProgressInfo &	progDlg
	)

Open a HDF5 file and store its contents to a Recording object.

Parameters:

fName	Full path to the file to be read.
ReturnData	On entry, an empty Recording object. On exit, the data stored in fName.
progress	True if the progress dialog should be updated.