Stimfit 0.12.7
Classes | Enumerations | Functions
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::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.

Enumeration Type Documentation

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.

none 

Undefined file type.


Function Documentation

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

Generic file export.

Parameters:
fNameThe full path name of the file.
typeThe file type.
DataData to be written
progressSet to true if a progress dialog should be shown.
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:
extThe 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:
fNameThe full path name of the file.
typeThe file type.
ReturnDataWill contain the file data on return.
txtImportThe text import filter settings.
progressSet to true if a progress dialog should be shown.
Returns:
true if the file has successfully been read, false otherwise.