Stfio

Classes
class	stfio::ProgressInfo
	ProgressInfo class. More...
class	stfio::StdoutProgressInfo
	StdoutProgressInfo class. More...
struct	stfio::txtImportSettings
	Text file import filter settings. More...
Enumerations
enum	stfio::filetype {   stfio::atf, stfio::abf, stfio::axg, stfio::ascii,   stfio::cfs, stfio::igor, stfio::son, stfio::hdf5,   stfio::heka, stfio::biosig, stfio::none }
	File types. More...
Functions
StfioDll Vector_double	stfio::vec_scal_plus (const Vector_double &vec, double scalar)
StfioDll Vector_double	stfio::vec_scal_minus (const Vector_double &vec, double scalar)
StfioDll Vector_double	stfio::vec_scal_mul (const Vector_double &vec, double scalar)
StfioDll Vector_double	stfio::vec_scal_div (const Vector_double &vec, double scalar)
StfioDll Vector_double	stfio::vec_vec_plus (const Vector_double &vec1, const Vector_double &vec2)
StfioDll Vector_double	stfio::vec_vec_minus (const Vector_double &vec1, const Vector_double &vec2)
StfioDll Vector_double	stfio::vec_vec_mul (const Vector_double &vec1, const Vector_double &vec2)
StfioDll Vector_double	stfio::vec_vec_div (const Vector_double &vec1, const Vector_double &vec2)
StfioDll stfio::filetype	stfio::findType (const std::string &ext)
	Attempts to determine the filetype from the filter extension.
StfioDll bool	stfio::importFile (const std::string &fName, stfio::filetype type, Recording &ReturnData, const stfio::txtImportSettings &txtImport, stfio::ProgressInfo &progDlg)
	Generic file import.
StfioDll bool	stfio::exportFile (const std::string &fName, stfio::filetype type, const Recording &Data, ProgressInfo &progDlg)
	Generic file export.
StfioDll Recording	stfio::concatenate (const Recording &src, const std::vector< std::size_t > &sections, ProgressInfo &progDlg)
	Produce new recording with concatenated sections.
StfioDll Recording	stfio::multiply (const Recording &src, const std::vector< std::size_t > &sections, std::size_t channel, double factor)
	Produce new recording with multiplied sections.

---

Enumeration Type Documentation

enum stfio::filetype

File types.

Enumerator:

atf	Axon text file.
abf	Axon binary file.
axg	Axograph binary file.
ascii	Generic text file.
cfs	CED filing system.
igor	Igor binary wave.
son	CED Son files.
hdf5	hdf5 files.
heka	heka files.
biosig	biosig files.
none	Undefined file type.

Definition at line 151 of file stfio.h.

---

Function Documentation

StfioDll Recording stfio::concatenate	(	const Recording &	src,
		const std::vector< std::size_t > &	sections,
		ProgressInfo &	progDlg
	)

Produce new recording with concatenated sections.

Parameters:

src	Source recording
sections	Indices of selected sections
ProgressInfo	Progress indicator

Returns:

New recording with concatenated selected sections

StfioDll bool stfio::exportFile	(	const std::string &	fName,
		stfio::filetype	type,
		const Recording &	Data,
		ProgressInfo &	progDlg
	)

Generic file export.

Parameters:

fName	The full path name of the file.
type	The file type.
Data	Data to be written
ProgressInfo	Progress indicator

Returns:

true if the file has successfully been written, false otherwise.

StfioDll stfio::filetype stfio::findType

(

const std::string &

ext

)

Attempts to determine the filetype from the filter extension.

Parameters:

ext	The filter extension to be tested (in the form wxT("*.ext")).

Returns:

The corresponding file type.

StfioDll bool stfio::importFile	(	const std::string &	fName,
		stfio::filetype	type,
		Recording &	ReturnData,
		const stfio::txtImportSettings &	txtImport,
		stfio::ProgressInfo &	progDlg
	)

Generic file import.

Parameters:

fName	The full path name of the file.
type	The file type.
ReturnData	Will contain the file data on return.
txtImport	The text import filter settings.
ProgressInfo	Progress indicator

Returns:

true if the file has successfully been read, false otherwise.

StfioDll Recording stfio::multiply	(	const Recording &	src,
		const std::vector< std::size_t > &	sections,
		std::size_t	channel,
		double	factor
	)

Produce new recording with multiplied sections.

Parameters:

src	Source recording
sections	Indices of selected sections
channel	Channel index
factor	Multiplication factor

Returns:

New recording with multiplied selected sections