Stimfit classes and functions derived from wxWidgets

Classes
class	wxStfApp
	The application, derived from wxApp. More...
class	wxStfChildFrame
	Provides the child frame for displaying documents on separate windows. More...
class	wxStfGrid
	Derived from wxGrid. Allows to copy cells to the clipboard. More...
class	wxStfConvertDlg
	Dialog for batch conversion of files.from cfs to atf. More...
class	wxStfCursorsDlg
	Cursor settings non-modal dialog. More...
class	wxStfEventDlg
	Dialog for event-detection settings. More...
class	wxStfFitSelDlg
	Non-linear regression settings dialog. More...
class	wxStfFileInfoDlg
	Dialog showing file information. More...
class	wxStfChannelSelDlg
	Dialog for selecting channels. More...
class	wxStfAlignDlg
	Dialog for selecting alignment mode. More...
class	wxStfFilterSelDlg
	Dialog for selecting a filter function. More...
class	wxStfTransformDlg
	Dialog for selecting a transform function. More...
class	wxStfFitInfoDlg
	Dialog showing information about a fit. More...
struct	BatchOption
	small struct representing a batch dialog option More...
class	wxStfBatchDlg
	Dialog for batch analysis settings. More...
class	wxStfPreprintDlg
	Dialog for setting printout options. More...
class	wxStfGaussianDlg
	Dialog for setting the parameters of a Gaussian function. More...
class	wxStfTextImportDlg
	Dialog for text import filter settings. More...
class	wxStfOrderChannelsDlg
	Dialog for re-ordering channels before saving to file. More...
class	wxStfDoc
	The document class, derived from both wxDocument and Recording. More...
class	wxStfGraph
	Handles drawing of traces and keyboard or mouse input. More...
struct	new_wxwindow
class	wxStfParentFrame
	Provides the top-level frame. More...
class	wxStfPrintout
	Handles printing of traces. More...
class	wxStfTable
	Adapts stfnum::Table to be used by wxStfGrid. More...
class	wxStfUsrDlg
	A user-defined dialog for entering floating-point numbers. More...
class	wxStfView
	The view class, derived from wxView. More...

Typedefs
typedef wxAuiToolBar	wxStfToolBar

Enumerations
enum	{   ID_TOOL_FIRST = wxID_HIGHEST+1 , ID_TOOL_NEXT , ID_TOOL_PREVIOUS , ID_TOOL_LAST ,   ID_TOOL_XENL , ID_TOOL_XSHRINK , ID_TOOL_YENL , ID_TOOL_YSHRINK ,   ID_TOOL_UP , ID_TOOL_DOWN , ID_TOOL_FIT , ID_TOOL_LEFT ,   ID_TOOL_RIGHT , ID_TOOL_SELECT , ID_TOOL_REMOVE , ID_TOOL_MEASURE ,   ID_TOOL_PEAK , ID_TOOL_BASE , ID_TOOL_DECAY , ID_TOOL_LATENCY ,   ID_TOOL_ZOOM , ID_TOOL_EVENT , ID_TOOL_CH1 , ID_TOOL_CH2 ,   ID_TOOL_SNAPSHOT , ID_TOOL_ANNOTATION , ID_TOOL_SNAPSHOT_WMF , ID_TOOL_FITDECAY ,   ID_IMPORTPYTHON , ID_VIEW_RESULTS , ID_VIEW_MEASURE , ID_VIEW_BASELINE ,   ID_VIEW_BASESD , ID_VIEW_THRESHOLD , ID_VIEW_PEAKZERO , ID_VIEW_PEAKBASE ,   ID_VIEW_PEAKTHRESHOLD , ID_VIEW_RTLOHI , ID_VIEW_INNERRISETIME , ID_VIEW_OUTERRISETIME ,   ID_VIEW_T50 , ID_VIEW_RD , ID_VIEW_SLOPERISE , ID_VIEW_SLOPEDECAY ,   ID_VIEW_LATENCY , ID_VIEW_CURSORS , ID_VIEW_SHELL , ID_FILEINFO ,   ID_EXPORTIMAGE , ID_EXPORTPS , ID_EXPORTLATEX , ID_EXPORTSVG ,   ID_TRACES , ID_PLOTSELECTED , ID_SHOWSECOND , ID_CURSORS ,   ID_AVERAGE , ID_ALIGNEDAVERAGE , ID_FIT , ID_LFIT ,   ID_LOG , ID_VIEWTABLE , ID_BATCH , ID_INTEGRATE ,   ID_DIFFERENTIATE , ID_CH2BASE , ID_CH2POS , ID_CH2ZOOM ,   ID_CH2BASEZOOM , ID_SWAPCHANNELS , ID_SCALE , ID_ZOOMHV ,   ID_ZOOMH , ID_ZOOMV , ID_EVENTADD , ID_EVENTEXTRACT ,   ID_APPLYTOALL , ID_UPDATE , ID_CONVERT , ID_PRINT_PRINT ,   ID_MPL , ID_MPL_SPECTRUM , ID_PRINT_PAGE_SETUP , ID_PRINT_PREVIEW ,   ID_COPYINTABLE , ID_MULTIPLY , ID_SELECTSOME , ID_UNSELECTSOME ,   ID_MYSELECTALL , ID_UNSELECTALL , ID_SELECT_AND_ADD , ID_SELECT_AND_REMOVE ,   ID_NEWFROMSELECTED , ID_NEWFROMSELECTEDTHIS , ID_NEWFROMALL , ID_CONCATENATE_MULTICHANNEL ,   ID_SUBTRACTBASE , ID_FILTER , ID_POVERN , ID_PLOTCRITERION ,   ID_PLOTCORRELATION , ID_PLOTDECONVOLUTION , ID_EXTRACT , ID_THRESHOLD ,   ID_LOADPERSPECTIVE , ID_SAVEPERSPECTIVE , ID_RESTOREPERSPECTIVE , ID_STFCHECKBOX ,   ID_EVENT_ADDEVENT , ID_EVENT_EXTRACT , ID_EVENT_ERASE , ID_ANNOTATION_ADDANNOTATION ,   ID_ANNOTATION_REMOVEANNOTATION , ID_ANNOTATION_ERASEALLANNOTATIONS , ID_ANNOTATION_EXPORTANNOTATIONS , ID_ANNOTATION_IMPORTANNOTATIONS ,   ID_ANNOTATION_DetectEvents , ID_COMBOTRACES , ID_SPINCTRLTRACES , ID_ZERO_INDEX ,   ID_COMBOACTCHANNEL , ID_COMBOINACTCHANNEL , ID_USERDEF }
	Event ids. More...
enum	plottype { active , reference , background }

Functions
	wxStfApp::wxStfApp ()
	Constructor.
virtual bool	wxStfApp::OnInit ()
	Initialise the application.
virtual int	wxStfApp::OnExit ()
	Exit the application.
wxStfChildFrame *	wxStfApp::CreateChildFrame (wxDocument *doc, wxView *view)
	Creates a new child frame.
wxStfDoc *	wxStfApp::GetActiveDoc () const
	Retrieves the currently active document.
wxStfView *	wxStfApp::GetActiveView () const
	Retrieves the currently active view.
void	wxStfApp::ErrorMsg (const wxString &msg) const
	Displays a message box when an error has occured.
void	wxStfApp::ExceptMsg (const wxString &msg) const
	Displays a message box when an exception has occured.
void	wxStfApp::InfoMsg (const wxString &msg) const
	Displays a message box with information.
bool	wxStfApp::get_directTxtImport () const
	Indicates whether text files should be imported directly without showing an import settings dialog.
void	wxStfApp::set_directTxtImport (bool directTxtImport_)
	Determines whether text files should be imported directly without showing an import filter settings dialog.
const stfio::txtImportSettings &	wxStfApp::GetTxtImport () const
	Retrieves the text import filter settings.
void	wxStfApp::set_txtImportSettings (const stfio::txtImportSettings &txtImport_)
	Sets the text import filter settings.
const std::vector< stfnum::storedFunc > &	wxStfApp::GetFuncLib () const
	Retrieves the functions that are available for least-squares minimisation.
stfnum::storedFunc *	wxStfApp::GetFuncLibPtr (std::size_t at)
	Retrieves a pointer to a function for least-squares minimisation.
stfnum::storedFunc *	wxStfApp::GetLinFuncPtr ()
	Retrieves a pointer to a function for least-squares minimisation.
const std::vector< stf::Extension > &	wxStfApp::GetExtensionLib () const
	Retrieves the user-defined extension functions.
wxStfCursorsDlg *	wxStfApp::GetCursorsDialog () const
	Retrieves the cursor settings dialog.
std::vector< stf::SectionPointer >	wxStfApp::GetSectionsWithFits () const
	Retrieves all sections with fits.
void	wxStfApp::wxWriteProfileInt (const wxString &main, const wxString &sub, int value) const
	Writes an integer value to the configuration.
int	wxStfApp::wxGetProfileInt (const wxString &main, const wxString &sub, int default_) const
	Retrieves an integer value from the configuration.
void	wxStfApp::wxWriteProfileString (const wxString &main, const wxString &sub, const wxString &value) const
	Writes a string to the configuration.
wxString	wxStfApp::wxGetProfileString (const wxString &main, const wxString &sub, const wxString &default_) const
	Retrieves a string from the configuration.
wxStfDoc *	wxStfApp::NewChild (const Recording &NewData, const wxStfDoc *Sender, const wxString &title=wxT("\0"))
	Creates a new child window showing a new document.
void	wxStfApp::OnPeakcalcexecMsg (wxStfDoc *actDoc=0)
	Execute all pending calculations.
void	wxStfApp::SetMRActiveDoc (wxStfDoc *pDoc)
	Sets the currently active document.
void	wxStfApp::CleanupDocument (wxStfDoc *pDoc)
	Destroys the last cursor settings dialog when the last document is closed.
bool	wxStfApp::CloseAll ()
	Closes all documents.
bool	wxStfApp::OpenFileSeries (const wxArrayString &fNameArray)
	Opens a series of files. Optionally, files can be put into a single window.
int	wxStfApp::GetDocCount ()
	Returns the number of currently opened documents.
void	wxStfApp::set_isBars (bool value)
	Determine whether scale bars or coordinates should be shown.
bool	wxStfApp::get_isBars () const
	Indicates whether scale bars or coordinates are shown.
wxString	wxStfApp::GetVersionString () const
	Get a formatted version string.
void	wxStfApp::OnNewfromselected (wxCommandEvent &event)
	Open a new window showing all selected traces from all open files.
wxDocManager *	wxStfApp::GetDocManager () const
	Access the document manager.
wxStfParentFrame *	wxStfApp::GetMainFrame ()
virtual void	wxStfApp::OnInitCmdLine (wxCmdLineParser &parser)
virtual bool	wxStfApp::OnCmdLineParsed (wxCmdLineParser &parser)
bool	wxStfApp::OpenFilePy (const wxString &fNameArray)
	Opens a file in a new window, to be called from Python.
void	wxStfApp::OnPythonImport (wxCommandEvent &event)
	Opens a dialog to import a Python module.
StfDll wxStfApp &	wxGetApp ()
	Returns a reference to the application.
	wxStfChildFrame::wxStfChildFrame (wxDocument *doc, wxView *view, wxStfParentType *parent, wxWindowID id, const wxString &title, const wxPoint &pos=wxPoint(48, 48), const wxSize &size=wxDefaultSize, long style=wxDEFAULT_FRAME_STYLE, const wxString &name=wxT("frame"))
	Constructor.
	wxStfChildFrame::~wxStfChildFrame ()
	Destructor.
void	wxStfChildFrame::ShowTable (const stfnum::Table &table, const wxString &caption)
	Adds a table to the results notebook.
std::size_t	wxStfChildFrame::GetCurTrace () const
	Retrieves the current trace from the trace selection combo box.
void	wxStfChildFrame::SetCurTrace (std::size_t)
	Sets the current trace from the trace selection combo box.
void	wxStfChildFrame::CreateMenuTraces (std::size_t value)
	Creates the trace selection menu.
void	wxStfChildFrame::CreateComboChannels (const wxArrayString &channelNames)
	Creates the channel selection combo boxes.
void	wxStfChildFrame::SetSelected (std::size_t value)
	Refreshes the trace selection string.
void	wxStfChildFrame::SetChannels (std::size_t act, std::size_t inact)
	Sets the channels in the combo boxes. Checks and corrects equal channels in both boxes.
void	wxStfChildFrame::UpdateChannels ()
	Updates the channels according to the current combo boy selection.
void	wxStfChildFrame::UpdateResults ()
	Updates the results table.
wxAuiManager *	wxStfChildFrame::GetMgr ()
	Retrieve the wxAuiManager.
wxStfGrid *	wxStfChildFrame::GetCopyGrid ()
	Retrieve the wxStfGrid that contains the results table.
void	wxStfChildFrame::Saveperspective ()
	Write the current AUI perspective to the configuration.
void	wxStfChildFrame::Loadperspective ()
	Load the saved AUI perspective from the configuration.
void	wxStfChildFrame::Restoreperspective ()
	Restore the default AUI perspective.
bool	wxStfChildFrame::ShowSelected () const
	Indicates whether all selected traces should be plotted.
bool	wxStfChildFrame::ShowSecond ()
	Indicates whether the second channel should be plotted.
bool	wxStfChildFrame::ShowAll () const
	Indicates whether all channels should be plotted.
void	wxStfChildFrame::ActivateGraph ()
	Activated the current graph.
void	wxStfChildFrame::OnActivate (wxActivateEvent &event)
virtual wxMenuBar *	wxStfChildFrame::GetMenuBar () const
	Override default GetMenuBar.
	wxStfGrid::wxStfGrid (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxWANTS_CHARS, const wxString &name=wxGridNameStr)
	Constructor.
wxString	wxStfGrid::GetSelection () const
	Get the selection.
wxMenu *	wxStfGrid::get_labelMenu ()
void	wxStfGrid::ViewResults ()
	Updates the context menu.
	wxStfConvertDlg::wxStfConvertDlg (wxWindow *parent, int id=wxID_ANY, wxString title=wxT("Convert file series"), wxPoint pos=wxDefaultPosition, wxSize size=wxDefaultSize, int style=wxCAPTION)
	Constructor.
wxString	wxStfConvertDlg::GetSrcDir () const
	Get the source directory.
wxString	wxStfConvertDlg::GetDestDir () const
	Get the destination directory.
wxString	wxStfConvertDlg::GetSrcFilter () const
	Get the source extension filter.
stfio::filetype	wxStfConvertDlg::GetSrcFileExt () const
	Get the source extension as stfio::filetype.
stfio::filetype	wxStfConvertDlg::GetDestFileExt () const
	Get the destination extension as stfio::filetype.
wxArrayString	wxStfConvertDlg::GetSrcFileNames () const
	Get the list of file names.
virtual void	wxStfConvertDlg::EndModal (int retCode)
	Called upon ending a modal dialog.
	wxStfCursorsDlg::wxStfCursorsDlg (wxWindow *parent, wxStfDoc *initDoc, int id=wxID_ANY, wxString title=wxT("Cursor settings"), wxPoint pos=wxDefaultPosition, wxSize size=wxDefaultSize, int style=wxCAPTION)
	Constructor.
virtual void	wxStfCursorsDlg::EndModal (int retCode)
	Called upon ending a modal dialog.
virtual bool	wxStfCursorsDlg::TransferDataFromWindow ()
	Called when data should be transferred from the non-modal dialog (e.g. when OK is pressed)
int	wxStfCursorsDlg::GetCursorM () const
	Get the measurement cursor x-position.
int	wxStfCursorsDlg::GetCursor1P () const
	Get the left peak cursor x-position.
int	wxStfCursorsDlg::GetCursor2P () const
	Get the right peak cursor x-position.
int	wxStfCursorsDlg::GetCursor1B () const
	Get the left base cursor x-position.
int	wxStfCursorsDlg::GetCursor2B () const
	Get the right base cursor x-position.
int	wxStfCursorsDlg::GetCursor1D () const
	Get the left fit cursor x-position.
int	wxStfCursorsDlg::GetCursor2D () const
	Get the right fit cursor x-position.
int	wxStfCursorsDlg::GetCursor1L () const
	Get the left latency cursor x-position.
int	wxStfCursorsDlg::GetCursor2L () const
	Get the right latency cursor x-position.
int	wxStfCursorsDlg::GetPeakPoints () const
	Gets the number of points used for the binned average during peak detection.
int	wxStfCursorsDlg::GetRTFactor () const
	Gets the lower factor (e.g 20) used to calculate the rise time.
void	wxStfCursorsDlg::SetPeakAtEnd (bool is_end)
	Sets whether the right peak cursor should be at the end of the trace.
void	wxStfCursorsDlg::SetPeakPoints (int peakPoints)
	Sets the number of points used for the binned average during peak detection.
void	wxStfCursorsDlg::SetRTFactor (int RTFactor)
	Set the lower value (e.g 20) to compute the rise-time. The high value is simply 100-lower value.
int	wxStfCursorsDlg::GetDeltaT () const
	Gets the distance to the first PSlope cursor in number of points.
void	wxStfCursorsDlg::SetDeltaT (int DeltaT)
	Sets the number of points used for the distance from the first PSlope cursor.
void	wxStfCursorsDlg::SetStartFitAtPeak (bool is_peak)
	Sets whether the left decay cursor should be at the peak of the trace.
stfnum::direction	wxStfCursorsDlg::GetDirection () const
	Gets the direction of peak calculations.
stf::latency_mode	wxStfCursorsDlg::GetLatencyStartMode () const
	Gets the mode of Latency for the beginning of the latency cursor.
stf::latency_mode	wxStfCursorsDlg::GetLatencyEndMode () const
	Gets the mode of Latency of the last latency cursor.
void	wxStfCursorsDlg::SetLatencyStartMode (stf::latency_mode latencyBegMode)
	Sets the latency mode of the left latency cursor.
void	wxStfCursorsDlg::SetLatencyEndMode (stf::latency_mode latencyEndMode)
	Sets the latency mode of the right latency cursor.
bool	wxStfCursorsDlg::GetFromBase () const
	Indicates whether to use the baseline as a reference for AP kinetics.
void	wxStfCursorsDlg::SetDirection (stfnum::direction direction)
	Sets the direction of peak calculations.
void	wxStfCursorsDlg::SetFromBase (bool frombase)
	Sets the reference for AP kinetics measurements.
void	wxStfCursorsDlg::SetBaselineMethod (enum stfnum::baseline_method)
	Sets the reference for baseline measurement.
enum stfnum::baseline_method	wxStfCursorsDlg::GetBaselineMethod () const
	Indiates whether baseline is computed as mean or as median.
bool	wxStfCursorsDlg::GetPeakAtEnd () const
	Indicates whether the right peak cursor should always be at the end of the trace.
bool	wxStfCursorsDlg::GetStartFitAtPeak () const
	Indicates whether to always start a fit at the current peak position.
void	wxStfCursorsDlg::UpdateCursors ()
	Updates the cursor entries in the Cursors Settings menu.
stf::cursor_type	wxStfCursorsDlg::CurrentCursor () const
	Retrieve the current cursor notebook page.
double	wxStfCursorsDlg::GetSlope () const
	Get the slope at which the baseline should be fixed.
void	wxStfCursorsDlg::SetSlope (double slope)
	Set the threshold slope.
void	wxStfCursorsDlg::SetSlopeUnits (const wxString &units)
	Set the units of the slope.
bool	wxStfCursorsDlg::GetBaseToSlope () const
	Indicates whether the baseline should be fixed to a certain slope.
bool	wxStfCursorsDlg::GetRuler () const
	Indicates whether an additional vertical ruler is drawn through the measurement cursor.
void	wxStfCursorsDlg::SetRuler (bool value)
	Sets whether an additional vertical ruler should be drawn through the measurement cursor.
bool	wxStfCursorsDlg::LoadCursorConf (const wxString &filepath)
	Load a cursor configuration file (*csr) in the Cursor Settings menu.
bool	wxStfCursorsDlg::SaveCursorConf (const wxString &filepath)
	Save a cursor configuration file (*csr) from the Cursor Settings menu.
void	wxStfCursorsDlg::SetActiveDoc (wxStfDoc *actDoc_)
	Sets the currently active document.
	wxStfEventDlg::wxStfEventDlg (wxWindow *parent, const std::vector< stf::SectionPointer > &templateSections, bool isExtract, int id=wxID_ANY, wxString title=wxT("Event detection settings"), wxPoint pos=wxDefaultPosition, wxSize size=wxDefaultSize, int style=wxCAPTION)
	Constructor.
double	wxStfEventDlg::GetThreshold () const
	Get the event detection threshold.
stf::extraction_mode	wxStfEventDlg::GetMode () const
	Indicates the selected extraction algorithm.
int	wxStfEventDlg::GetMinDistance () const
	Get the minimal distance between events.
int	wxStfEventDlg::GetTemplate () const
	Get the selected template.
virtual void	wxStfEventDlg::EndModal (int retCode)
	Called upon ending a modal dialog.
	wxStfFitSelDlg::wxStfFitSelDlg (wxWindow *parent, wxStfDoc *doc, int id=wxID_ANY, wxString title=wxT("Non-linear regression"), wxPoint pos=wxDefaultPosition, wxSize size=wxDefaultSize, int style=wxCAPTION)
	Constructor.
virtual void	wxStfFitSelDlg::EndModal (int retCode)
	Called upon ending a modal dialog.
int	wxStfFitSelDlg::GetFSelect () const
	Get the selected fit function.
Vector_double	wxStfFitSelDlg::GetInitP () const
	Get the initial parameters.
Vector_double	wxStfFitSelDlg::GetOpts () const
	Get options for the algorithm.
bool	wxStfFitSelDlg::UseScaling () const
	Scale x- and y-amplitudes to 1.0 before fit.
void	wxStfFitSelDlg::SetNoInput (bool noInput_)
	Determines whether user-defined initial parameters are allowed.
	wxStfFileInfoDlg::wxStfFileInfoDlg (wxWindow *parent, const std::string &szGeneral, const std::string &szFile, const std::string &szSection, int id=wxID_ANY, wxString title=wxT("File information"), wxPoint pos=wxDefaultPosition, wxSize size=wxDefaultSize, int style=wxCAPTION)
	Constructor.
	wxStfChannelSelDlg::wxStfChannelSelDlg (wxWindow *parent, const std::vector< wxString > &channelNames=std::vector< wxString >(0), int id=wxID_ANY, wxString title=wxT("Select channels"), wxPoint pos=wxDefaultPosition, wxSize size=wxDefaultSize, int style=wxCAPTION)
	Constructor.
virtual void	wxStfChannelSelDlg::EndModal (int retCode)
	Called upon ending a modal dialog.
int	wxStfChannelSelDlg::GetSelCh1 () const
	Get selection for channel 1.
int	wxStfChannelSelDlg::GetSelCh2 () const
	Get selection for channel 2.
	wxStfAlignDlg::wxStfAlignDlg (wxWindow *parent, bool hasReference, int id=wxID_ANY, wxString title=wxT("Alignment mode"), wxPoint pos=wxDefaultPosition, wxSize size=wxDefaultSize, int style=wxCAPTION)
	Constructor.
int	wxStfAlignDlg::AlignRise () const
	Indicates whether the average should be aligned to the steepest rise.
bool	wxStfAlignDlg::UseReference () const
	Indicates whether the reference channel should be used for alignment.
virtual void	wxStfAlignDlg::EndModal (int retCode)
	Called upon ending a modal dialog.
	wxStfFilterSelDlg::wxStfFilterSelDlg (wxWindow *parent, int id=wxID_ANY, wxString title=wxT("Filter function"), wxPoint pos=wxDefaultPosition, wxSize size=wxDefaultSize, int style=wxCAPTION)
	Constructor.
int	wxStfFilterSelDlg::GetFilterSelect () const
	Get the selected filter function.
virtual void	wxStfFilterSelDlg::EndModal (int retCode)
	Called upon ending a modal dialog.
	wxStfTransformDlg::wxStfTransformDlg (wxWindow *parent, int id=wxID_ANY, wxString title=wxT("Choose function"), wxPoint pos=wxDefaultPosition, wxSize size=wxDefaultSize, int style=wxCAPTION)
	Constructor.
int	wxStfTransformDlg::GetFSelect () const
	Get the selected transform function.
virtual void	wxStfTransformDlg::EndModal (int retCode)
	Called upon ending a modal dialog.
	wxStfFitInfoDlg::wxStfFitInfoDlg (wxWindow *parent, const wxString &info, int id=wxID_ANY, wxString title=wxT("Fit information"), wxPoint pos=wxDefaultPosition, wxSize size=wxDefaultSize, int style=wxCAPTION)
	Constructor.
	BatchOption::BatchOption ()
	Default constructor.
	BatchOption::BatchOption (const wxString &lab, bool sel, int id)
	wxStfBatchDlg::wxStfBatchDlg (wxWindow *parent, int id=wxID_ANY, wxString title=wxT("Choose values"), wxPoint pos=wxDefaultPosition, wxSize size=wxDefaultSize, int style=wxCAPTION)
	Constructor.
bool	wxStfBatchDlg::PrintBase () const
	Indicates whether the baseline should be printed in the batch analysis table.
bool	wxStfBatchDlg::PrintBaseSD () const
	Indicates whether the standard deviation of the baseline should be printed in the batch analysis table.
bool	wxStfBatchDlg::PrintThreshold () const
	Indicates whether the threshold should be printed in the batch analysis table.
bool	wxStfBatchDlg::PrintSlopeThresholdTime () const
	Indicates whether the time of slope threshold crossing should be printed in the batch analysis table.
bool	wxStfBatchDlg::PrintPeakZero () const
	Indicates whether the peak (from 0) value should be printed in the batch analysis table.
bool	wxStfBatchDlg::PrintPeakBase () const
	Indicates whether the peak (from baseline) value should be printed in the batch analysis table.
bool	wxStfBatchDlg::PrintPeakThreshold () const
	Indicates whether the peak value (from threshold) should be printed in the batch analysis table.
bool	wxStfBatchDlg::PrintPeakTime () const
	Indicates whether the peak value (from threshold) should be printed in the batch analysis table.
bool	wxStfBatchDlg::PrintRTLoHi () const
	Indicates whether the Lo-Hi% rise time should be printed in the batch analysis table.
bool	wxStfBatchDlg::PrintInnerRTLoHi () const
	Indicates whether the Lo-Hi% inner rise time should be printed in the batch analysis table.
bool	wxStfBatchDlg::PrintOuterRTLoHi () const
	Indicates whether the Lo-Hi% inner rise time should be printed in the batch analysis table.
bool	wxStfBatchDlg::PrintT50 () const
	Indicates whether the half amplitude duration should be printed in the batch analysis table.
bool	wxStfBatchDlg::PrintT50SE () const
	Indicates whether the start and end time for half amplitude should be printed in the batch analysis table.
bool	wxStfBatchDlg::PrintSlopes () const
	Indicates whether the maximal slopes should be printed in the batch analysis table.
bool	wxStfBatchDlg::PrintSlopeTimes () const
	Indicates whether the peak value (from threshold) should be printed in the batch analysis table.
bool	wxStfBatchDlg::PrintThr () const
	Indicates whether a threshold crossing should be printed in the batch analysis table.
bool	wxStfBatchDlg::PrintLatencies () const
	Indicates whether the latency should be printed in the batch analysis table.
bool	wxStfBatchDlg::PrintFitResults () const
	Indicates whether the fit results should be printed in the batch analysis table.
virtual void	wxStfBatchDlg::EndModal (int retCode)
	Called upon ending a modal dialog.
	wxStfPreprintDlg::wxStfPreprintDlg (wxWindow *parent, bool isFile=false, int id=wxID_ANY, wxString title=wxT("Settings"), wxPoint pos=wxDefaultPosition, wxSize size=wxDefaultSize, int style=wxCAPTION)
	Constructor.
bool	wxStfPreprintDlg::GetGimmicks () const
	Indicates whether gimmicks (cursors, results table etc.) sould be printed.
int	wxStfPreprintDlg::GetDownSampling () const
	Prints every n-th point.
virtual void	wxStfPreprintDlg::EndModal (int retCode)
	Called upon ending a modal dialog.
	wxStfGaussianDlg::wxStfGaussianDlg (wxWindow *parent, int id=wxID_ANY, wxString title=wxT("Settings for Gaussian function"), wxPoint pos=wxDefaultPosition, wxSize size=wxDefaultSize, int style=wxCAPTION)
	Constructor.
double	wxStfGaussianDlg::Width () const
	Get the width of the Gaussian.
double	wxStfGaussianDlg::Center () const
	Get the center of the Gaussian.
double	wxStfGaussianDlg::Amp () const
	Get the amplitude of the Gaussian.
virtual void	wxStfGaussianDlg::EndModal (int retCode)
	Called upon ending a modal dialog.
	wxStfTextImportDlg::wxStfTextImportDlg (wxWindow *parent, const wxString &textPreview=wxT("\0"), int hLines_=1, bool isSeries=false, int id=wxID_ANY, wxString title=wxT("Text file import settings"), wxPoint pos=wxDefaultPosition, wxSize size=wxDefaultSize, int style=wxCAPTION)
	Constructor.
int	wxStfTextImportDlg::GetHLines () const
	Get the number of header lines.
bool	wxStfTextImportDlg::ToSection () const
	Indicates whether columns should be put into section or into channels.
bool	wxStfTextImportDlg::FirstIsTime () const
	Indicates whether the first column contains time values.
int	wxStfTextImportDlg::GetNColumns () const
	Get the number of columns.
double	wxStfTextImportDlg::GetSR () const
	Get the sampling rate.
const wxString &	wxStfTextImportDlg::GetYUnits () const
	Get the y units of the first channel.
const wxString &	wxStfTextImportDlg::GetYUnitsCh2 () const
	Get the y units of the second channel.
const wxString &	wxStfTextImportDlg::GetXUnits () const
	Get the x units.
bool	wxStfTextImportDlg::ApplyToAll () const
	Indicates whether the settings apply to all files in a series.
stfio::txtImportSettings	wxStfTextImportDlg::GetTxtImport () const
	Get the text import filter settings struct.
virtual void	wxStfTextImportDlg::EndModal (int retCode)
	Called upon ending a modal dialog.
	wxStfOrderChannelsDlg::wxStfOrderChannelsDlg (wxWindow *parent, const std::vector< wxString > &channelNames=std::vector< wxString >(0), int id=wxID_ANY, wxString title=wxT("Re-order channels"), wxPoint pos=wxDefaultPosition, wxSize size=wxDefaultSize, int style=wxCAPTION)
	Constructor.
std::vector< int >	wxStfOrderChannelsDlg::GetChannelOrder () const
	Get the new channel order.
virtual void	wxStfOrderChannelsDlg::EndModal (int retCode)
	Called upon ending a modal dialog.
	wxStfDoc::wxStfDoc ()
	Constructor.
	wxStfDoc::~wxStfDoc ()
	Destructor.
void	wxStfDoc::OnSwapChannels (wxCommandEvent &event)
	Swaps active and inactive channel.
virtual bool	wxStfDoc::OnOpenDocument (const wxString &filename)
	Override default file opening.
virtual bool	wxStfDoc::OnOpenPyDocument (const wxString &filename)
	Open document without progress dialog.
virtual bool	wxStfDoc::SaveAs ()
	Override default file saving.
virtual bool	wxStfDoc::DoSaveDocument (const wxString &filename)
	Override default file saving.
virtual bool	wxStfDoc::OnCloseDocument ()
	Override default file closing.
virtual bool	wxStfDoc::OnNewDocument ()
	Override default file creation.
void	wxStfDoc::SetData (const Recording &c_Data, const wxStfDoc *Sender, const wxString &title)
	Sets the content of a newly created file.
bool	wxStfDoc::GetIsAverage () const
	Indicates whether an average has been created.
bool	wxStfDoc::GetStartFitAtPeak () const
	Indicates whether the left decay cursor should always be at the peak of the trace.
bool	wxStfDoc::GetPeakAtEnd () const
	Indicates whether the right peak cursor should always be at the end of a trace.
bool	wxStfDoc::IsInitialized () const
	Indicates whether the the document is fully initialised.
void	wxStfDoc::SetPeakAtEnd (bool value)
	Sets the right peak cursor to the end of a trace.
void	wxStfDoc::SetStartFitAtPeak (bool value)
	Sets the left decay cursor to the peak of the trace.
const Recording &	wxStfDoc::GetAverage () const
	Retrieves the average trace(s).
void	wxStfDoc::CheckBoundaries ()
	Checks whether any cursor is reversed or out of range and corrects it if required.
bool	wxStfDoc::SetSection (std::size_t section)
	Sets the current section to the specified value.
bool	wxStfDoc::OnNewfromselectedThis ()
	Creates a new window containing the selected sections of this file.
void	wxStfDoc::Selectall (wxCommandEvent &event)
	Selects all sections.
void	wxStfDoc::Deleteselected (wxCommandEvent &event)
	Unselects all sections.
void	wxStfDoc::UpdateSelectedButton ()
	Updates the status of the selection button.
void	wxStfDoc::CreateAverage (bool calcSD, bool align)
	Creates an average trace from the selected sections.
void	wxStfDoc::ToggleSelect ()
	Toggles the selection status of the current section.
void	wxStfDoc::Select ()
	Selects the current section if previously unselected.
void	wxStfDoc::Remove ()
	Unselects the current section if previously selected.
void	wxStfDoc::Extract (wxCommandEvent &event)
	Creates a new document from the checked events.
void	wxStfDoc::InteractiveEraseEvents (wxCommandEvent &event)
	Erases all events, independent of whether they are checked or not.
void	wxStfDoc::AddEvent (wxCommandEvent &event)
	Adds an event at the current eventPos.
void	wxStfDoc::OnAddAnnotation (wxCommandEvent &WXUNUSED(event))
	Adds an annotation at the current eventPos.
void	wxStfDoc::OnRemoveAnnotation (wxCommandEvent &WXUNUSED(event))
	Removes an annotation at the current eventPos or a very close one to it.
void	wxStfDoc::OnEraseAllAnnotations (wxCommandEvent &WXUNUSED(event))
	Erase all annotations at the current channel and sweep.
void	wxStfDoc::OnExportAnnotations (wxCommandEvent &WXUNUSED(event))
	Export all annotations of current doc.
void	wxStfDoc::OnImportAnnotations (wxCommandEvent &WXUNUSED(event))
	Import all annotations of current doc.
void	wxStfDoc::OnExpertDetectEvents (wxCommandEvent &WXUNUSED(event))
	detects events based on the expert scoring using simple filter
bool	wxStfDoc::SubtractBase ()
	Subtracts the baseline of all selected traces.
void	wxStfDoc::FitDecay (wxCommandEvent &event)
	Fit a function to the data.
void	wxStfDoc::SetFileMenu (wxMenu *menu)
	Sets a pointer to the file menu attached to this document.
void	wxStfDoc::Measure ()
	Measure everything using functions defined in measlib.h.
stfnum::Table	wxStfDoc::CurResultsTable ()
	Put the current measurement results into a text table.
std::size_t	wxStfDoc::GetMeasCursor () const
	Retrieves the position of the measurement cursor (crosshair).
stfnum::baseline_method	wxStfDoc::GetBaselineMethod () const
	Retrieves the computation mode for baseline.
std::size_t	wxStfDoc::GetBaseBeg () const
	Retrieves the position of the left baseline cursor.
std::size_t	wxStfDoc::GetBaseEnd () const
	Retrieves the position of the right baseline cursor.
std::size_t	wxStfDoc::GetPeakBeg () const
	Retrieves the position of the left peak cursor.
std::size_t	wxStfDoc::GetPeakEnd () const
	Retrieves the position of the right peak cursor.
std::size_t	wxStfDoc::GetFitBeg () const
	Retrieves the position of the left fitting cursor.
std::size_t	wxStfDoc::GetFitEnd () const
	Retrieves the position of the right fitting cursor.
int	wxStfDoc::GetPM () const
	Retrieves the number of points used for averaging during peak calculation.
double	wxStfDoc::GetLatencyBeg () const
	Retrieves the position of the left latency cursor.
double	wxStfDoc::GetLatencyEnd () const
	Retrieves the position of the right latency cursor.
double	wxStfDoc::GetLatency () const
	Retrieves the latency.
double	wxStfDoc::GetTLoReal () const
	Retrieves the time point at which Lo% of the maximal amplitude have been reached.
double	wxStfDoc::GetTHiReal () const
	Retrieves the time point at which Hi% of the maximal amplitude have been reached.
double	wxStfDoc::GetInnerLoRT () const
	Retrieves the time point at which Lo% of the maximal amplitude have been reached.
double	wxStfDoc::GetInnerHiRT () const
	Retrieves the time point at which Hi% of the maximal amplitude have been reached.
double	wxStfDoc::GetOuterLoRT () const
	Retrieves the time point at which Lo% of the maximal amplitude have been reached.
double	wxStfDoc::GetOuterHiRT () const
	Retrieves the time point at which Hi% of the maximal amplitude have been reached.
double	wxStfDoc::GetT0Real () const
	Retrieves the extrapolated onset time point of an event in the active channel.
double	wxStfDoc::GetT50LeftReal () const
	Retrieves the time point at which 50% of the maximal amplitude have been reached from the left of the peak.
double	wxStfDoc::GetT50RightReal () const
	Retrieves the time point at which 50% of the maximal amplitude have been reached from the right of the peak.
double	wxStfDoc::GetT50Y () const
	Retrieves the y value at 50% of the maximal amplitude.
double	wxStfDoc::GetMaxRise () const
	Retrieves the maximal slope of the rising phase.
double	wxStfDoc::GetMaxDecay () const
	Retrieves the maximal slope of the decaying phase.
double	wxStfDoc::GetAPMaxRiseT () const
	Retrieves the time point of the maximal slope of the rising phase in the second channel.
double	wxStfDoc::GetAPMaxT () const
	Retrieves the time point of the peak in the second channel.
double	wxStfDoc::GetAPT50LeftReal () const
	Retrieves the time point at which 50% of the max. amplitude have been reached from the left of the peak in the reference channel.
double	wxStfDoc::GetAPT0Real () const
	Retrieves the extrapolated onset time point of an event in the reference channel.
double	wxStfDoc::GetMaxRiseT () const
	Retrieves the time point of the maximal slope during the rising phase.
double	wxStfDoc::GetMaxRiseY () const
	Retrieves the y-value at the time point of the maximal slope during the rising phase.
double	wxStfDoc::GetMaxDecayT () const
	Retrieves the time point of the maximal slope during the decaying phase.
double	wxStfDoc::GetMaxDecayY () const
	Retrieves the y-value at the time point of the maximal slope during the decaying phase.
double	wxStfDoc::GetMeasValue ()
	Retrieves the y-value at the measurement cursor (crosshair). Will update measCursor if out of range.
double	wxStfDoc::GetPeak () const
	Retrieves the peak value.
double	wxStfDoc::GetPeakTime () const
	Retrieves the peak time value.
double	wxStfDoc::GetBase () const
	Retrieves the baseline.
double	wxStfDoc::GetAPBase () const
	Retrieves the baseline in the second channel.
double	wxStfDoc::GetBaseSD () const
	Retrieves the standard deviation of the baseline.
double	wxStfDoc::GetThreshold () const
	Retrieves the value at which the threshold slope is crossed.
double	wxStfDoc::GetMaxT () const
	Retrieves the time point at which the peak is found.
double	wxStfDoc::GetThrT () const
	Retrieves the time point at which the threshold slope is crossed.
double	wxStfDoc::GetRTLoHi () const
	Retrieves the Lo to Hi% rise time.
double	wxStfDoc::GetInnerRiseTime () const
	Retrieves the inner rise time.
double	wxStfDoc::GetOuterRiseTime () const
	Retrieves the outer rise time.
double	wxStfDoc::GetHalfDuration () const
	Retrieves the full width at half-maximal amplitude ("half duration").
double	wxStfDoc::GetSlopeRatio () const
	Retrieves ratio of the maximal slopes during the rising and decaying phase.
int	wxStfDoc::GetRTFactor () const
	Retrieves lower factor (e.g 20) for the rise time calculation.
stf::latency_mode	wxStfDoc::GetLatencyStartMode () const
	Retrieves the mode of the latency start cursor.
stf::latency_mode	wxStfDoc::GetLatencyEndMode () const
	Retrieves the mode of the latency end cursor.
stf::latency_window_mode	wxStfDoc::GetLatencyWindowMode () const
	Retrieves the mode of the latency window.
stfnum::direction	wxStfDoc::GetDirection () const
	Retrieves the direction of peak calculations.
bool	wxStfDoc::GetFromBase () const
	Indicates whether to use the baseline as a reference for AP kinetics.
bool	wxStfDoc::GetViewCrosshair () const
	Indicates whether the measurement cursor (crosshair) value should be shown in the results table.
bool	wxStfDoc::GetViewBaseline () const
	Indicates whether the baseline value should be shown in the results table.
bool	wxStfDoc::GetViewBaseSD () const
	Indicates whether the baseline's standard deviation should be shown in the results table.
bool	wxStfDoc::GetViewThreshold () const
	Indicates whether the threshold should be shown in the results table.
bool	wxStfDoc::GetViewPeakZero () const
	Indicates whether the peak value (measured from zero) should be shown in the results table.
bool	wxStfDoc::GetViewPeakBase () const
	Indicates whether the peak value (measured from baseline) should be shown in the results table.
bool	wxStfDoc::GetViewPeakThreshold () const
	Indicates whether the peak value (measured from threshold) should be shown in the results table.
bool	wxStfDoc::GetViewRTLoHi () const
	Indicates whether the Lo to Hi% rise time should be shown in the results table.
bool	wxStfDoc::GetViewInnerRiseTime () const
	Indicates whether the inner rise time should be shown in the results table.
bool	wxStfDoc::GetViewOuterRiseTime () const
	Indicates whether the outer rise time should be shown in the results table.
bool	wxStfDoc::GetViewT50 () const
	Indicates whether the half duration should be shown in the results table.
bool	wxStfDoc::GetViewRD () const
	Indicates whether the ratio of the maximal slopes during rise and decay should be shown in the results table.
bool	wxStfDoc::GetViewSlopeRise () const
	Indicates whether the maximal slope during the rising phase should be shown in the results table.
bool	wxStfDoc::GetViewSlopeDecay () const
	Indicates whether the maximal slope during the decaying phase should be shown in the results table.
bool	wxStfDoc::GetViewLatency () const
	Indicates whether the latency should be shown in the results table.
bool	wxStfDoc::GetViewCursors () const
	Indicates whether two additional rows showing the positions of start and end cursors should be shown in the results table.
double	wxStfDoc::GetSlopeForThreshold () const
	Returns the slope for threshold detection.
const XZoom &	wxStfDoc::GetXZoom ()
	Returns the current zoom settings for this channel (read-only).
XZoom &	wxStfDoc::GetXZoomW ()
	Returns the current zoom settings for this channel (read & write).
const YZoom &	wxStfDoc::GetYZoom (int ch)
	Returns the current zoom settings for this channel (read-only).
YZoom &	wxStfDoc::GetYZoomW (int ch)
	Returns the current zoom settings for this channel (read & write).
void	wxStfDoc::SetMeasCursor (int value)
	Sets the position of the measurement cursor (crosshair).
void	wxStfDoc::SetMeasRuler (bool value)
	Sets whether the measurement cursor (crosshair) should be visible.
bool	wxStfDoc::GetMeasRuler () const
	Retrieves whether the measurement cursor (crosshair) is visible.
void	wxStfDoc::SetBaselineMethod (stfnum::baseline_method value)
	Sets the method to compute the baseline.
void	wxStfDoc::SetBaseBeg (int value)
	Sets the position of the left baseline cursor.
void	wxStfDoc::SetBaseEnd (int value)
	Sets the position of the right baseline cursor.
void	wxStfDoc::SetPeakBeg (int value)
	Sets the position of the left peak cursor.
void	wxStfDoc::SetPeakEnd (int value)
	Sets the position of the right peak cursor.
void	wxStfDoc::SetFitBeg (int value)
	Sets the position of the left fitting cursor.
void	wxStfDoc::SetFitEnd (int value)
	Sets the position of the right fitting cursor.
void	wxStfDoc::SetLatencyBeg (double value)
	Sets the position of the left latency cursor.
void	wxStfDoc::SetLatencyEnd (double value)
	Sets the position of the right latency cursor.
void	wxStfDoc::SetLatency (double value)
	Sets the latency.
void	wxStfDoc::SetPM (int value)
	Sets the number of points used for averaging during peak calculation.
void	wxStfDoc::SetRTFactor (int value)
	Sets the lower value (e.g 20) to calculate the rise time.
void	wxStfDoc::SetLatencyStartMode (stf::latency_mode value)
	Sets the mode of the latency start cursor.
void	wxStfDoc::SetLatencyEndMode (stf::latency_mode value)
	Sets the mode of the latency end cursor.
void	wxStfDoc::SetLatencyWindowMode (stf::latency_window_mode value)
	Sets the mode of the latency end cursor.
void	wxStfDoc::SetLatencyStartMode (int value)
	Sets the mode of the latency start cursor.
void	wxStfDoc::SetLatencyEndMode (int value)
	Sets the mode of the latency end cursor.
void	wxStfDoc::SetLatencyWindowMode (int value)
	Sets the mode of the latency end cursor.
void	wxStfDoc::SetDirection (stfnum::direction value)
	Sets the direction of peak calculations.
void	wxStfDoc::SetFromBase (bool frombase)
	Sets the reference for AP kinetics measurements.
void	wxStfDoc::SetViewCrosshair (bool value)
	Determines whether the measurement cursor (crosshair) value should be shown in the results table.
void	wxStfDoc::SetViewBaseline (bool value)
	Determines whether the baseline value should be shown in the results table.
void	wxStfDoc::SetViewBaseSD (bool value)
	Determines whether the baseline's standard deviation should be shown in the results table.
void	wxStfDoc::SetViewThreshold (bool value)
	Determines whether the threshold should be shown in the results table.
void	wxStfDoc::SetViewPeakZero (bool value)
	Determines whether the peak value (measured from zero) should be shown in the results table.
void	wxStfDoc::SetViewPeakBase (bool value)
	Determines whether the peak value (measured from baseline) should be shown in the results table.
void	wxStfDoc::SetViewPeakThreshold (bool value)
	Determines whether the peak value (measured from threshold) should be shown in the results table.
void	wxStfDoc::SetViewRTLoHi (bool value)
	Determines whether the Lo to Hi% rise time should be shown in the results table.
void	wxStfDoc::SetViewInnerRiseTime (bool value)
	Determines whether the inner rise time should be shown in the results table.
void	wxStfDoc::SetViewOuterRiseTime (bool value)
	Determines whether the outer rise time should be shown in the results table.
void	wxStfDoc::SetViewT50 (bool value)
	Determines whether the half duration should be shown in the results table.
void	wxStfDoc::SetViewRD (bool value)
	Determines whether the ratio of the maximal slopes during rise and decay should be shown in the results table.
void	wxStfDoc::SetViewSlopeRise (bool value)
	Determines whether the maximal slope during the rising phase should be shown in the results table.
void	wxStfDoc::SetViewSlopeDecay (bool value)
	Determines whether the maximal slope during the decaying phase should be shown in the results table.
void	wxStfDoc::SetViewLatency (bool value)
	Determines whether the latency should be shown in the results table.
void	wxStfDoc::SetViewCursors (bool value)
	Determines whether two additional rows showing the positions of start and end cursors should be shown in the results table.
void	wxStfDoc::SetSlopeForThreshold (double value)
	Sets the slope where the baseline should be set.
stfnum::Table	wxStfDoc::CurAsTable () const
	Put the current trace into a text table.
void	wxStfDoc::CopyCursors (const wxStfDoc &c_Recording)
	Copies the cursor positions from another Recording to this Recording.
virtual void	wxStfDoc::resize (std::size_t c_n_channels)
	Resize the Recording to a new number of channels.
virtual void	wxStfDoc::InsertChannel (Channel &c_Channel, std::size_t pos)
	Insert a Channel at a given position.
const stf::SectionAttributes &	wxStfDoc::GetSectionAttributes (std::size_t nchannel, std::size_t nsection) const
const stf::SectionAttributes &	wxStfDoc::GetCurrentSectionAttributes () const
stf::SectionAttributes &	wxStfDoc::GetCurrentSectionAttributesW ()
void	wxStfDoc::DeleteFit (std::size_t nchannel, std::size_t nsection)
	Deletes the current fit, sets isFitted to false;.
void	wxStfDoc::SetIsFitted (std::size_t nchannel, std::size_t nsection, const Vector_double &bestFitP_, stfnum::storedFunc *fitFunc_, double chisqr, std::size_t fitBeg_, std::size_t fitEnd_)
	Sets the best-fit parameters when a fit has been performed on this section.
void	wxStfDoc::SetIsIntegrated (std::size_t nchannel, std::size_t nsection, bool value, std::size_t begin, std::size_t end, const Vector_double &quad_p_)
	Determines whether an integral has been calculated in this section.
void	wxStfDoc::ClearEvents (std::size_t nchannel, std::size_t nsection)
	Erases all events.
void	wxStfDoc::correctRangeR (int &value)
void	wxStfDoc::correctRangeR (std::size_t &value)
bool	wxStfDoc::LoadTDMS (const std::string &filename, Recording &ReturnData)
std::vector< double >	wxStfDoc::CalcRawDetectionTrace (std::size_t filterOrder, std::size_t startPoint, std::size_t endPoint)
std::vector< int >	wxStfDoc::CalcScoringTrace (std::vector< Annotation > expertAnnotations, std::size_t startPoint, std::size_t endPoint)
double	wxStfDoc::CalcAreaUnderCurve (std::vector< double > d, std::vector< int > c)
std::pair< std::size_t, double >	wxStfDoc::CalcMaxKappa (std::vector< double > &sortedRawDetectionTrace, std::vector< int > &sortedScoringTrace)
std::vector< double >	wxStfDoc::SortScoringTraceByRawDetection (std::vector< double > &rawDetectionTrace, std::vector< int > &scoringTrace)
std::vector< stf::Event >	wxStfDoc::DetectEvents (double threshold_, std::vector< double > &rawDetectionTrace)
void	wxStfDoc::OnCalculatedThresholdExpertDetectEvents (double threshold, std::size_t filterOrder)
	wxStfGraph::wxStfGraph (wxView *v, wxStfChildFrame *frame, const wxPoint &pos, const wxSize &size, long style)
	Constructor.
virtual void	wxStfGraph::OnDraw (wxDC &dc)
	The central drawing function. Used for drawing to any output device, such as a printer or a screen.
void	wxStfGraph::Snapshotwmf ()
	Copies the drawing to the clipboard as a windows metafile.
void	wxStfGraph::OnMouseEvent (wxMouseEvent &event)
	Handles mouse events.
void	wxStfGraph::OnKeyDown (wxKeyEvent &event)
	Handles keyboard input.
void	wxStfGraph::ChangeTrace (std::size_t trace)
	Change trace.
void	wxStfGraph::OnNext ()
	Show and analyse next trace.
void	wxStfGraph::OnPrevious ()
	Show and analyse previous trace.
void	wxStfGraph::OnLast ()
	Show and analyse last trace.
void	wxStfGraph::OnFirst ()
	Show and analyse first trace.
void	wxStfGraph::OnUp ()
	Moves the traces up by 20 px.
void	wxStfGraph::OnDown ()
	Moves the traces down by 20 px.
void	wxStfGraph::OnRight ()
	Moves the traces right by 20 px.
void	wxStfGraph::OnLeft ()
	Moves the traces left by 20 px.
void	wxStfGraph::OnXenlhi ()
	Enlarges the x-scale by a factor of 2.
void	wxStfGraph::OnXenllo ()
	Enlarges the x-scale by a factor of 1.1.
void	wxStfGraph::OnXshrinklo ()
	Shrinks the x-scale by a factor of 1.1.
void	wxStfGraph::OnXshrinkhi ()
	Shrinks the x-scale by a factor of 2.
void	wxStfGraph::OnYenlhi ()
	Enlarges the y-scale by a factor of 2.
void	wxStfGraph::OnYenllo ()
	Enlarges the y-scale by a factor of 1.1.
void	wxStfGraph::OnYshrinklo ()
	Shrinks the y-scale by a factor of 1.1.
void	wxStfGraph::OnYshrinkhi ()
	Shrinks the y-scale by a factor of 2.
void	wxStfGraph::Ch2base ()
	Adjust y-positioning so that the baselines of channel 1 and 2 are at the same y-position.
void	wxStfGraph::Ch2pos ()
	Adjust y-positioning so that channel 1 and 2 are at the same absolute y-position.
void	wxStfGraph::Ch2zoom ()
	Adjust y-scale so that channel 1 and 2 have the same y-scale.
void	wxStfGraph::Ch2basezoom ()
	Combines Ch2zoom() and Ch2base().
void	wxStfGraph::ChanScroll (int direction)
	advance / decrement the active channel by one
void	wxStfGraph::Fittowindow (bool refresh)
	Fits the graph to the window.
void	wxStfGraph::ClearEvents ()
	Destroys all event check boxes.
void	wxStfGraph::set_isPrinted (bool value)
	Set to true if the graph is drawn on a printer.
void	wxStfGraph::set_printScale (double value)
	Sets the printing scale to the specified value.
void	wxStfGraph::set_printRect (wxRect value)
	Sets the size of the printout to the epcified rectangle.
void	wxStfGraph::set_noGimmicks (bool value)
	Set to true if the results table and the cursors should be printed.
void	wxStfGraph::set_downsampling (int value)
	Prints every n-th point.
bool	wxStfGraph::get_noGimmicks () const
	Indicates whether everything (cursors, results table, etc.) is printed out.
int	wxStfGraph::get_eventPos () const
	Returns the y-position of a right click when in event-detection mode.
double	wxStfGraph::get_plot_xmin () const
	Returns x value of the left screen border.
double	wxStfGraph::get_plot_xmax () const
	Returns x value of the right screen border.
double	wxStfGraph::get_plot_ymin () const
	Returns y value of the bottom screen border.
double	wxStfGraph::get_plot_ymax () const
	Returns y value of the top screen border.
double	wxStfGraph::get_plot_y2min () const
	Returns y value of the bottom screen border for the reference channel.
double	wxStfGraph::get_plot_y2max () const
	Returns y value of the top screen border for the reference channel.
	new_wxwindow::new_wxwindow (wxWindow *cppW=NULL, PyObject *pyW=NULL)
	wxStfParentFrame::wxStfParentFrame (wxDocManager *manager, wxFrame *frame, const wxString &title, const wxPoint &pos, const wxSize &size, long style)
	Constructor.
	wxStfParentFrame::~wxStfParentFrame ()
	Destructor.
void	wxStfParentFrame::OnAbout (wxCommandEvent &event)
	Shows the "About" dialog.
wxStfGraph *	wxStfParentFrame::CreateGraph (wxView *view, wxStfChildFrame *parent)
	Creates a new graph.
stf::cursor_type	wxStfParentFrame::GetMouseQual () const
	Retrieve the current mouse mode.
void	wxStfParentFrame::SetMouseQual (stf::cursor_type value)
	Sets the current mouse cursor mode.
void	wxStfParentFrame::SetSelectedButton (bool selected)
	Sets status of the toolbar's selection button.
stf::zoom_channels	wxStfParentFrame::GetZoomQual () const
	Retrieve which channels will be affected by scaling operations.
void	wxStfParentFrame::SetZoomQual (stf::zoom_channels value)
	Set the channels that will be affected by scaling operations.
void	wxStfParentFrame::SetSingleChannel (bool value)
	Set the zoom buttons to single- or multi-channel mode.
wxPrintData *	wxStfParentFrame::GetPrintData ()
	Retrieves the print data.
wxPageSetupDialogData *	wxStfParentFrame::GetPageSetup ()
	Retrieves the page setup.
wxAuiManager &	wxStfParentFrame::GetMgr ()
	Retrieve the wxAuiManager.
void	wxStfParentFrame::CheckUpdate (wxProgressDialog *progDlg=NULL) const
	Checks for updates.
new_wxwindow	wxStfParentFrame::MakePythonWindow (const std::string &windowFunc, const std::string &mgr_name="pythonShell", const std::string &caption="Python Shell", bool show=true, bool full=false, bool isfloat=true, int width=-1, int height=-1, double mpl_width=8.0, double mpl_height=6.0)
int	wxStfParentFrame::GetMplFigNo ()
	wxStfPrintout::wxStfPrintout (const wxChar *title=_T("Printout"))
	Constructor.
bool	wxStfPrintout::OnPrintPage (int page)
	Called by the framework when a page should be printed.
bool	wxStfPrintout::HasPage (int page)
	Checks whether a page exists.
bool	wxStfPrintout::OnBeginDocument (int startPage, int endPage)
	Called by the framework at the start of document printing.
void	wxStfPrintout::GetPageInfo (int *minPage, int *maxPage, int *selPageFrom, int *selPageTo)
	Retrieve information about the pages that will be printed.
void	wxStfPrintout::DrawPageOne ()
	Prints the first (and only) page.
	wxStfTable::wxStfTable (const stfnum::Table &table_)
	Constructor.
virtual int	wxStfTable::GetNumberRows ()
	Get the number of rows.
virtual int	wxStfTable::GetNumberCols ()
	Get the number of columns.
virtual bool	wxStfTable::IsEmptyCell (int row, int col)
	Check whether a cell is empty.
virtual wxString	wxStfTable::GetValue (int row, int col)
	Retrieve a cell entry.
virtual void	wxStfTable::SetValue (int row, int col, const wxString &value)
	Set a cell entry.
wxString	wxStfTable::GetSelection (const wxGridCellCoordsArray &selection)
	Retrieve values from selected cells.
	wxStfView::wxStfView ()
	Constructor.
	wxStfView::~wxStfView ()
	Destructor.
virtual bool	wxStfView::OnCreate (wxDocument *doc, long flags)
	Override default view creation.
virtual void	wxStfView::OnDraw (wxDC *dc)
	The drawing function (note that actual drawing happens in wxStfGraph::OnDraw())
virtual void	wxStfView::OnUpdate (wxView *sender, wxObject *hint=(wxObject *) NULL)
	Override default updating behaviour.
virtual bool	wxStfView::OnClose (bool deleteWindow=true)
	Override default file closing behaviour.
wxStfGraph *	wxStfView::GetGraph ()
	Retrieve the attached graph.
wxStfDoc *	wxStfView::Doc ()
	Retrieve the attached document.
wxStfDoc *	wxStfView::DocC () const
	Retrieve the attached document.
virtual void	wxStfView::OnActivateView (bool activate, wxView *activeView, wxView *deactiveView)
	Called when the view is activated; dialogs and menus are then updated.

Variables
bool	singleWindowMode
	true if in single-window mode
const wxString	defaultPersp
	Default perspective string.
wxString	BatchOption::label
bool	BatchOption::selection
	Checkbox label.
int	BatchOption::index
	Checkbox status.
wxStfView *	wxStfGraph::view
	Returns the current zoom struct.
wxWindow *	new_wxwindow::cppWindow
PyObject *	new_wxwindow::pyWindow

Detailed Description

Typedef Documentation

wxStfToolBar

typedef wxAuiToolBar wxStfToolBar

Definition at line 40 of file parentframe.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Event ids.

Enumerator
ID_TOOL_FIRST
ID_TOOL_NEXT
ID_TOOL_PREVIOUS
ID_TOOL_LAST
ID_TOOL_XENL
ID_TOOL_XSHRINK
ID_TOOL_YENL
ID_TOOL_YSHRINK
ID_TOOL_UP
ID_TOOL_DOWN
ID_TOOL_FIT
ID_TOOL_LEFT
ID_TOOL_RIGHT
ID_TOOL_SELECT
ID_TOOL_REMOVE
ID_TOOL_MEASURE
ID_TOOL_PEAK
ID_TOOL_BASE
ID_TOOL_DECAY
ID_TOOL_LATENCY
ID_TOOL_ZOOM
ID_TOOL_EVENT
ID_TOOL_CH1
ID_TOOL_CH2
ID_TOOL_SNAPSHOT
ID_TOOL_ANNOTATION
ID_TOOL_SNAPSHOT_WMF
ID_TOOL_FITDECAY
ID_IMPORTPYTHON
ID_VIEW_RESULTS
ID_VIEW_MEASURE
ID_VIEW_BASELINE
ID_VIEW_BASESD
ID_VIEW_THRESHOLD
ID_VIEW_PEAKZERO
ID_VIEW_PEAKBASE
ID_VIEW_PEAKTHRESHOLD
ID_VIEW_RTLOHI
ID_VIEW_INNERRISETIME
ID_VIEW_OUTERRISETIME
ID_VIEW_T50
ID_VIEW_RD
ID_VIEW_SLOPERISE
ID_VIEW_SLOPEDECAY
ID_VIEW_LATENCY
ID_VIEW_CURSORS
ID_VIEW_SHELL
ID_FILEINFO
ID_EXPORTIMAGE
ID_EXPORTPS
ID_EXPORTLATEX
ID_EXPORTSVG
ID_TRACES
ID_PLOTSELECTED
ID_SHOWSECOND
ID_CURSORS
ID_AVERAGE
ID_ALIGNEDAVERAGE
ID_FIT
ID_LFIT
ID_LOG
ID_VIEWTABLE
ID_BATCH
ID_INTEGRATE
ID_DIFFERENTIATE
ID_CH2BASE
ID_CH2POS
ID_CH2ZOOM
ID_CH2BASEZOOM
ID_SWAPCHANNELS
ID_SCALE
ID_ZOOMHV
ID_ZOOMH
ID_ZOOMV
ID_EVENTADD
ID_EVENTEXTRACT
ID_APPLYTOALL
ID_UPDATE
ID_CONVERT
ID_PRINT_PRINT
ID_MPL
ID_MPL_SPECTRUM
ID_PRINT_PAGE_SETUP
ID_PRINT_PREVIEW
ID_COPYINTABLE
ID_MULTIPLY
ID_SELECTSOME
ID_UNSELECTSOME
ID_MYSELECTALL
ID_UNSELECTALL
ID_SELECT_AND_ADD
ID_SELECT_AND_REMOVE
ID_NEWFROMSELECTED
ID_NEWFROMSELECTEDTHIS
ID_NEWFROMALL
ID_CONCATENATE_MULTICHANNEL
ID_SUBTRACTBASE
ID_FILTER
ID_POVERN
ID_PLOTCRITERION
ID_PLOTCORRELATION
ID_PLOTDECONVOLUTION
ID_EXTRACT
ID_THRESHOLD
ID_LOADPERSPECTIVE
ID_SAVEPERSPECTIVE
ID_RESTOREPERSPECTIVE
ID_STFCHECKBOX
ID_EVENT_ADDEVENT
ID_EVENT_EXTRACT
ID_EVENT_ERASE
ID_ANNOTATION_ADDANNOTATION
ID_ANNOTATION_REMOVEANNOTATION
ID_ANNOTATION_ERASEALLANNOTATIONS
ID_ANNOTATION_EXPORTANNOTATIONS
ID_ANNOTATION_IMPORTANNOTATIONS
ID_ANNOTATION_DetectEvents
ID_COMBOTRACES
ID_SPINCTRLTRACES
ID_ZERO_INDEX
ID_COMBOACTCHANNEL
ID_COMBOINACTCHANNEL
ID_USERDEF

Definition at line 28 of file app.h.

plottype

enum plottype

Enumerator
active
reference
background

Definition at line 37 of file graph.h.

Function Documentation

ActivateGraph()

void wxStfChildFrame::ActivateGraph

(

)

Activated the current graph.

AddEvent()

void wxStfDoc::AddEvent

(

wxCommandEvent &

event

)

Adds an event at the current eventPos.

Parameters

event

The menu event that made the call.

AlignRise()

int wxStfAlignDlg::AlignRise ( ) const

inline

Indicates whether the average should be aligned to the steepest rise.

Returns

true if it should be aligned to the steepest rise, false if it should be aligned to the peak.

Definition at line 163 of file smalldlgs.h.

Amp()

double wxStfGaussianDlg::Amp ( ) const

inline

Get the amplitude of the Gaussian.

Returns

The amplitude of the Gaussian.

Definition at line 579 of file smalldlgs.h.

ApplyToAll()

bool wxStfTextImportDlg::ApplyToAll ( ) const

inline

Indicates whether the settings apply to all files in a series.

Returns

true if the settings apply to all files.

Definition at line 689 of file smalldlgs.h.

BatchOption() [1/2]

BatchOption::BatchOption ( )

inline

Default constructor.

Definition at line 300 of file smalldlgs.h.

References index, label, and selection.

BatchOption() [2/2]

BatchOption::BatchOption ( const wxString & lab, bool sel, int id )

inline

Constructor

Parameters

lab	Checkbox label
sel	Checkbox status
id	Index in dialog

Definition at line 306 of file smalldlgs.h.

References index, label, and selection.

CalcAreaUnderCurve()

double wxStfDoc::CalcAreaUnderCurve	(	std::vector< double >	d,
		std::vector< int >	c )

CalcMaxKappa()

std::pair< std::size_t, double > wxStfDoc::CalcMaxKappa	(	std::vector< double > &	sortedRawDetectionTrace,
		std::vector< int > &	sortedScoringTrace )

CalcRawDetectionTrace()

std::vector< double > wxStfDoc::CalcRawDetectionTrace	(	std::size_t	filterOrder,
		std::size_t	startPoint,
		std::size_t	endPoint )

CalcScoringTrace()

std::vector< int > wxStfDoc::CalcScoringTrace	(	std::vector< Annotation >	expertAnnotations,
		std::size_t	startPoint,
		std::size_t	endPoint )

Center()

double wxStfGaussianDlg::Center ( ) const

inline

Get the center of the Gaussian.

Returns

The center of the Gaussian.

Definition at line 574 of file smalldlgs.h.

Ch2base()

void wxStfGraph::Ch2base

(

)

Adjust y-positioning so that the baselines of channel 1 and 2 are at the same y-position.

Ch2basezoom()

void wxStfGraph::Ch2basezoom

(

)

Combines Ch2zoom() and Ch2base().

This is a separate function so that the graph is not refreshed between adjusting the y-scale and the baseline.

Ch2pos()

void wxStfGraph::Ch2pos

(

)

Adjust y-positioning so that channel 1 and 2 are at the same absolute y-position.

Ch2zoom()

void wxStfGraph::Ch2zoom

(

)

Adjust y-scale so that channel 1 and 2 have the same y-scale.

ChangeTrace()

void wxStfGraph::ChangeTrace

(

std::size_t

trace

)

Change trace.

Takes care of refreshing everything when a new trace is shown

Parameters

trace

Index of next trace to be displayed

ChanScroll()

void wxStfGraph::ChanScroll

(

int

direction

)

advance / decrement the active channel by one

CheckBoundaries()

void wxStfDoc::CheckBoundaries

(

)

Checks whether any cursor is reversed or out of range and corrects it if required.

CheckUpdate()

void wxStfParentFrame::CheckUpdate

(

wxProgressDialog *

progDlg = NULL

)

const

Checks for updates.

Parameters

progDlg

An optional progress dialog

CleanupDocument()

void wxStfApp::CleanupDocument

(

wxStfDoc *

pDoc

)

Destroys the last cursor settings dialog when the last document is closed.

Do not use this function directly. It only needs to be called from wxStfDoc::OnCloseDocument().

Parameters

pDoc	Pointer to the document that is being closed.

ClearEvents() [1/2]

void wxStfDoc::ClearEvents	(	std::size_t	nchannel,
		std::size_t	nsection )

Erases all events.

ClearEvents() [2/2]

void wxStfGraph::ClearEvents

(

)

Destroys all event check boxes.

CloseAll()

bool wxStfApp::CloseAll ( )

inline

Closes all documents.

Definition at line 440 of file app.h.

References GetDocManager().

CopyCursors()

void wxStfDoc::CopyCursors

(

const wxStfDoc &

c_Recording

)

Copies the cursor positions from another Recording to this Recording.

This will copy the crosshair, base, peak and fit cursors positions as well as the number of points for peak averaging from another Recording and correct the new values if they are out of range. The latency cursors will not be copied.

Parameters

c_Recording

The Recording from which to copy the cursor positions.

References wxStfDoc().

correctRangeR() [1/2]

void wxStfDoc::correctRangeR

(

int &

value

)

correctRangeR() [2/2]

void wxStfDoc::correctRangeR

(

std::size_t &

value

)

CreateAverage()

void wxStfDoc::CreateAverage	(	bool	calcSD,
		bool	align )

Creates an average trace from the selected sections.

Parameters

calcSD	Set to true if the standard deviation should be calculated as well, false otherwise
align	Set to true if traces should be aligned to the point of steepest rise of the reference channel, false otherwise.

CreateChildFrame()

wxStfChildFrame * wxStfApp::CreateChildFrame	(	wxDocument *	doc,
		wxView *	view )

Creates a new child frame.

This is called from view.cpp whenever a child frame is created. If you want to pop up a new frame showing a new document, use NewChild() instead; this function will then be called by the newly created view.

Parameters

doc	A pointer to the document that the new child frame should contain.
view	A pointer to the view corresponding to the document.

Returns

A pointer to the newly created child frame.

CreateComboChannels()

void wxStfChildFrame::CreateComboChannels

(

const wxArrayString &

channelNames

)

Creates the channel selection combo boxes.

Parameters

channelNames

The channel names for the combo box drop-down list.

CreateGraph()

wxStfGraph * wxStfParentFrame::CreateGraph	(	wxView *	view,
		wxStfChildFrame *	parent )

Creates a new graph.

Called from view.cpp when a new drawing view is created.

Parameters

view	Pointer to the attached view.
parent	Pointer to the child frame that will serve as a parent for the new graph.

Returns

A pointer to the newly created graph.

CreateMenuTraces()

void wxStfChildFrame::CreateMenuTraces

(

std::size_t

value

)

Creates the trace selection menu.

Parameters

value

The number of traces.

CurAsTable()

stfnum::Table wxStfDoc::CurAsTable

(

)

const

Put the current trace into a text table.

CurrentCursor()

stf::cursor_type wxStfCursorsDlg::CurrentCursor

(

)

const

Retrieve the current cursor notebook page.

Returns

The cursor corresponding to the currently selected notebook page.

CurResultsTable()

stfnum::Table wxStfDoc::CurResultsTable

(

)

Put the current measurement results into a text table.

DeleteFit()

void wxStfDoc::DeleteFit	(	std::size_t	nchannel,
		std::size_t	nsection )

Deletes the current fit, sets isFitted to false;.

Deleteselected()

void wxStfDoc::Deleteselected

(

wxCommandEvent &

event

)

Unselects all sections.

Parameters

event

The menu event that made the call.

DetectEvents()

std::vector< stf::Event > wxStfDoc::DetectEvents	(	double	threshold_,
		std::vector< double > &	rawDetectionTrace )

Doc()

wxStfDoc * wxStfView::Doc

(

)

Retrieve the attached document.

Returns

A pointer to the attached document.

DocC()

wxStfDoc * wxStfView::DocC

(

)

const

Retrieve the attached document.

Returns

A pointer to the attached document.

DoSaveDocument()

virtual bool wxStfDoc::DoSaveDocument ( const wxString & filename )

virtual

Override default file saving.

Parameters

filename

Full path of the file.

Returns

true if successfully saved, false otherwise.

DrawPageOne()

void wxStfPrintout::DrawPageOne

(

)

Prints the first (and only) page.

EndModal() [1/13]

virtual void wxStfAlignDlg::EndModal ( int retCode )

virtual

Called upon ending a modal dialog.

Parameters

retCode

The dialog button id that ended the dialog (e.g. wxID_OK)

EndModal() [2/13]

virtual void wxStfBatchDlg::EndModal ( int retCode )

virtual

Called upon ending a modal dialog.

Parameters

retCode

The dialog button id that ended the dialog (e.g. wxID_OK)

EndModal() [3/13]

virtual void wxStfChannelSelDlg::EndModal ( int retCode )

virtual

Called upon ending a modal dialog.

Parameters

retCode

The dialog button id that ended the dialog (e.g. wxID_OK)

EndModal() [4/13]

virtual void wxStfConvertDlg::EndModal ( int retCode )

virtual

Called upon ending a modal dialog.

Parameters

retCode

The dialog button id that ended the dialog (e.g. wxID_OK)

EndModal() [5/13]

virtual void wxStfCursorsDlg::EndModal ( int retCode )

virtual

Called upon ending a modal dialog.

Parameters

retCode

The dialog button id that ended the dialog (e.g. wxID_OK)

EndModal() [6/13]

virtual void wxStfEventDlg::EndModal ( int retCode )

virtual

Called upon ending a modal dialog.

Parameters

retCode

The dialog button id that ended the dialog (e.g. wxID_OK)

EndModal() [7/13]

virtual void wxStfFilterSelDlg::EndModal ( int retCode )

virtual

Called upon ending a modal dialog.

Parameters

retCode

The dialog button id that ended the dialog (e.g. wxID_OK)

EndModal() [8/13]

virtual void wxStfFitSelDlg::EndModal ( int retCode )

virtual

Called upon ending a modal dialog.

Parameters

retCode

The dialog button id that ended the dialog (e.g. wxID_OK)

EndModal() [9/13]

virtual void wxStfGaussianDlg::EndModal ( int retCode )

virtual

Called upon ending a modal dialog.

Parameters

retCode

The dialog button id that ended the dialog (e.g. wxID_OK)

EndModal() [10/13]

virtual void wxStfOrderChannelsDlg::EndModal ( int retCode )

virtual

Called upon ending a modal dialog.

Parameters

retCode

The dialog button id that ended the dialog (e.g. wxID_OK)

EndModal() [11/13]

virtual void wxStfPreprintDlg::EndModal ( int retCode )

virtual

Called upon ending a modal dialog.

Parameters

retCode

The dialog button id that ended the dialog (e.g. wxID_OK)

EndModal() [12/13]

virtual void wxStfTextImportDlg::EndModal ( int retCode )

virtual

Called upon ending a modal dialog.

Parameters

retCode

The dialog button id that ended the dialog (e.g. wxID_OK)

EndModal() [13/13]

virtual void wxStfTransformDlg::EndModal ( int retCode )

virtual

Called upon ending a modal dialog.

Parameters

retCode

The dialog button id that ended the dialog (e.g. wxID_OK)

ErrorMsg()

void wxStfApp::ErrorMsg ( const wxString & msg ) const

inline

Displays a message box when an error has occured.

You can use this function from almost anywhere using wxGetApp().ErrorMsg( wxT( "Error abc: xyz" ) );

Parameters

msg	The message string to be shown.

Definition at line 293 of file app.h.

ExceptMsg()

void wxStfApp::ExceptMsg ( const wxString & msg ) const

inline

Displays a message box when an exception has occured.

You can use this function from almost anywhere using wxGetApp().ExceptMsg( wxT( "Exception description xyz" ) );

Parameters

msg	The message string to be shown.

Definition at line 302 of file app.h.

Extract()

void wxStfDoc::Extract

(

wxCommandEvent &

event

)

Creates a new document from the checked events.

Parameters

event

The menu event that made the call.

FirstIsTime()

bool wxStfTextImportDlg::FirstIsTime ( ) const

inline

Indicates whether the first column contains time values.

Returns

true is the first column contains time values.

Definition at line 659 of file smalldlgs.h.

FitDecay()

void wxStfDoc::FitDecay

(

wxCommandEvent &

event

)

Fit a function to the data.

Parameters

event

The menu event that made the call.

Fittowindow()

void wxStfGraph::Fittowindow

(

bool

refresh

)

Fits the graph to the window.

Fits the graph to 100% of the width and 50% of the height of the window and centers it.

Parameters

refresh

Set to true if the graph should be refreshed after fitting it to the window.

get_directTxtImport()

bool wxStfApp::get_directTxtImport ( ) const

inline

Indicates whether text files should be imported directly without showing an import settings dialog.

Returns

true if text files should be imported directly, false otherwise.

Definition at line 318 of file app.h.

get_eventPos()

int wxStfGraph::get_eventPos ( ) const

inline

Returns the y-position of a right click when in event-detection mode.

Returns

the index of the trace that the right-click position corresponds to.

Definition at line 249 of file graph.h.

get_isBars()

bool wxStfApp::get_isBars ( ) const

inline

Indicates whether scale bars or coordinates are shown.

Returns

true for scale bars, false for coordinates.

Definition at line 461 of file app.h.

get_labelMenu()

wxMenu * wxStfGrid::get_labelMenu ( )

inline

Returns

A pointer to the context menu.

Definition at line 57 of file copygrid.h.

get_noGimmicks()

bool wxStfGraph::get_noGimmicks ( ) const

inline

Indicates whether everything (cursors, results table, etc.) is printed out.

Returns

true if everything is printed out.

Definition at line 244 of file graph.h.

get_plot_xmax()

double wxStfGraph::get_plot_xmax

(

)

const

Returns x value of the right screen border.

Returns

x value of the right screen border

get_plot_xmin()

double wxStfGraph::get_plot_xmin

(

)

const

Returns x value of the left screen border.

Returns

x value of the left screen border

get_plot_y2max()

double wxStfGraph::get_plot_y2max

(

)

const

Returns y value of the top screen border for the reference channel.

Returns

y value of the top screen border for the reference channel

References active.

get_plot_y2min()

double wxStfGraph::get_plot_y2min

(

)

const

Returns y value of the bottom screen border for the reference channel.

Returns

y value of the bottom screen border for the reference channel

get_plot_ymax()

double wxStfGraph::get_plot_ymax

(

)

const

Returns y value of the top screen border.

Returns

y value of the top screen border

get_plot_ymin()

double wxStfGraph::get_plot_ymin

(

)

const

Returns y value of the bottom screen border.

Returns

y value of the bottom screen border

GetActiveDoc()

wxStfDoc * wxStfApp::GetActiveDoc

(

)

const

Retrieves the currently active document.

Returns

A pointer to the currently active document.

GetActiveView()

wxStfView * wxStfApp::GetActiveView

(

)

const

Retrieves the currently active view.

Returns

A pointer to the currently active view.

GetAPBase()

double wxStfDoc::GetAPBase ( ) const

inline

Retrieves the baseline in the second channel.

Returns

The baseline value in the second channel.

Definition at line 557 of file doc.h.

GetAPMaxRiseT()

double wxStfDoc::GetAPMaxRiseT ( ) const

inline

Retrieves the time point of the maximal slope of the rising phase in the second channel.

This time point is needed as a reference for the latency calculation and for aligned averages.

Returns

The time point at which the maximal slope of the rising phase is reached in the second channel, expressed in units of data points..

Definition at line 494 of file doc.h.

GetAPMaxT()

double wxStfDoc::GetAPMaxT ( ) const

inline

Retrieves the time point of the peak in the second channel.

Returns

The time point at which the peak is found in the second channel, expressed in units of data points.

Definition at line 500 of file doc.h.

GetAPT0Real()

double wxStfDoc::GetAPT0Real ( ) const

inline

Retrieves the extrapolated onset time point of an event in the reference channel.

Returns

The onset time point of an event, extrapolated from the crossing of a line through 20 and 80% of the event amplitude with the baseline. Expressed in units of data points.

Definition at line 512 of file doc.h.

GetAPT50LeftReal()

double wxStfDoc::GetAPT50LeftReal ( ) const

inline

Retrieves the time point at which 50% of the max. amplitude have been reached from the left of the peak in the reference channel.

Returns

The time point at which 50% of the maximal amplitude have been reached from the left of the peak in the reference channel, expressed in units of data points.

Definition at line 506 of file doc.h.

GetAverage()

const Recording & wxStfDoc::GetAverage ( ) const

inline

Retrieves the average trace(s).

Returns

The average trace as a Recording object.

Definition at line 214 of file doc.h.

References Recording::Recording().

GetBase()

double wxStfDoc::GetBase ( ) const

inline

Retrieves the baseline.

Returns

The baseline value.

Definition at line 552 of file doc.h.

GetBaseBeg()

std::size_t wxStfDoc::GetBaseBeg ( ) const

inline

Retrieves the position of the left baseline cursor.

Returns

The index of the left baseline cursor within the current section.

Definition at line 350 of file doc.h.

GetBaseEnd()

std::size_t wxStfDoc::GetBaseEnd ( ) const

inline

Retrieves the position of the right baseline cursor.

Returns

The index of the left baseline cursor within the current section.

Definition at line 355 of file doc.h.

GetBaselineMethod() [1/2]

enum stfnum::baseline_method wxStfCursorsDlg::GetBaselineMethod

(

)

const

Indiates whether baseline is computed as mean or as median.

Parameters

false

indicates computing average (mean & s.d.), 1 indicates median & iqr.

GetBaselineMethod() [2/2]

stfnum::baseline_method wxStfDoc::GetBaselineMethod ( ) const

inline

Retrieves the computation mode for baseline.

Returns

The current mode for computing the baseline.

Definition at line 345 of file doc.h.

GetBaseSD()

double wxStfDoc::GetBaseSD ( ) const

inline

Retrieves the standard deviation of the baseline.

Returns

The standard deviation of the baseline.

Definition at line 562 of file doc.h.

GetBaseToSlope()

bool wxStfCursorsDlg::GetBaseToSlope

(

)

const

Indicates whether the baseline should be fixed to a certain slope.

Returns

true if the baseline should be fixed, false otherwise.

GetChannelOrder()

std::vector< int > wxStfOrderChannelsDlg::GetChannelOrder ( ) const

inline

Get the new channel order.

Returns

A vector of newly ordered channel indices.

Definition at line 749 of file smalldlgs.h.

GetCopyGrid()

wxStfGrid * wxStfChildFrame::GetCopyGrid ( )

inline

Retrieve the wxStfGrid that contains the results table.

Returns

A pointer to the grid.

Definition at line 146 of file childframe.h.

GetCurrentSectionAttributes()

const stf::SectionAttributes & wxStfDoc::GetCurrentSectionAttributes

(

)

const

GetCurrentSectionAttributesW()

stf::SectionAttributes & wxStfDoc::GetCurrentSectionAttributesW

(

)

GetCursor1B()

int wxStfCursorsDlg::GetCursor1B

(

)

const

Get the left base cursor x-position.

Returns

The left base cursor x-position in units of sampling points.

GetCursor1D()

int wxStfCursorsDlg::GetCursor1D

(

)

const

Get the left fit cursor x-position.

Returns

The left fit cursor x-position in units of sampling points.

GetCursor1L()

int wxStfCursorsDlg::GetCursor1L

(

)

const

Get the left latency cursor x-position.

Returns

The left fit cursor x-position in units of sampling points.

GetCursor1P()

int wxStfCursorsDlg::GetCursor1P

(

)

const

Get the left peak cursor x-position.

Returns

The left peak cursor x-position in units of sampling points.

GetCursor2B()

int wxStfCursorsDlg::GetCursor2B

(

)

const

Get the right base cursor x-position.

Returns

The right base cursor x-position in units of sampling points.

GetCursor2D()

int wxStfCursorsDlg::GetCursor2D

(

)

const

Get the right fit cursor x-position.

Returns

The right fit cursor x-position in units of sampling points.

GetCursor2L()

int wxStfCursorsDlg::GetCursor2L

(

)

const

Get the right latency cursor x-position.

Returns

The right fit cursor x-position in units of sampling points.

GetCursor2P()

int wxStfCursorsDlg::GetCursor2P

(

)

const

Get the right peak cursor x-position.

Returns

The right peak cursor x-position in units of sampling points.

GetCursorM()

int wxStfCursorsDlg::GetCursorM

(

)

const

Get the measurement cursor x-position.

Returns

The measurement cursor x-position in units of sampling points.

GetCursorsDialog()

wxStfCursorsDlg * wxStfApp::GetCursorsDialog ( ) const

inline

Retrieves the cursor settings dialog.

Returns

A pointer to the cursor settings dialog.

Definition at line 368 of file app.h.

GetCurTrace()

std::size_t wxStfChildFrame::GetCurTrace

(

)

const

Retrieves the current trace from the trace selection combo box.

Returns

The 0-based index of the currently selected trace.

GetDeltaT()

int wxStfCursorsDlg::GetDeltaT

(

)

const

Gets the distance to the first PSlope cursor in number of points.

Returns

The distance to the first PSlope cursor in number of points.

GetDestDir()

wxString wxStfConvertDlg::GetDestDir ( ) const

inline

Get the destination directory.

Returns

The destination directory.

Definition at line 77 of file convertdlg.h.

GetDestFileExt()

stfio::filetype wxStfConvertDlg::GetDestFileExt ( ) const

inline

Get the destination extension as stfio::filetype.

Returns

The destination extension as stfio::filetype.

Definition at line 92 of file convertdlg.h.

GetDirection() [1/2]

stfnum::direction wxStfCursorsDlg::GetDirection

(

)

const

Gets the direction of peak calculations.

Returns

The current direction of peak calculations.

GetDirection() [2/2]

stfnum::direction wxStfDoc::GetDirection ( ) const

inline

Retrieves the direction of peak calculations.

Returns

The current direction of peak calculations.

Definition at line 636 of file doc.h.

GetDocCount()

int wxStfApp::GetDocCount ( )

inline

Returns the number of currently opened documents.

Returns

The number of currently opened documents.

Definition at line 451 of file app.h.

References GetDocManager().

GetDocManager()

wxDocManager * wxStfApp::GetDocManager ( ) const

inline

Access the document manager.

Returns

A pointer to the document manager.

Definition at line 476 of file app.h.

Referenced by CloseAll(), and GetDocCount().

GetDownSampling()

int wxStfPreprintDlg::GetDownSampling ( ) const

inline

Prints every n-th point.

Returns

If the return value n > 1, every n-th point will be printed.

Definition at line 521 of file smalldlgs.h.

GetExtensionLib()

const std::vector< stf::Extension > & wxStfApp::GetExtensionLib ( ) const

inline

Retrieves the user-defined extension functions.

Returns

A vector containing the user-defined functions.

Definition at line 362 of file app.h.

GetFilterSelect()

int wxStfFilterSelDlg::GetFilterSelect ( ) const

inline

Get the selected filter function.

Returns

The index of the selected filter function.

Definition at line 214 of file smalldlgs.h.

GetFitBeg()

std::size_t wxStfDoc::GetFitBeg ( ) const

inline

Retrieves the position of the left fitting cursor.

Returns

The index of the left fitting cursor within the current section.

Definition at line 370 of file doc.h.

GetFitEnd()

std::size_t wxStfDoc::GetFitEnd ( ) const

inline

Retrieves the position of the right fitting cursor.

Returns

The index of the right fitting cursor within the current section.

Definition at line 375 of file doc.h.

GetFromBase() [1/2]

bool wxStfCursorsDlg::GetFromBase

(

)

const

Indicates whether to use the baseline as a reference for AP kinetics.

Returns

true if the baseline should be used, false if the threshold should be used.

GetFromBase() [2/2]

bool wxStfDoc::GetFromBase ( ) const

inline

Indicates whether to use the baseline as a reference for AP kinetics.

Returns

true if the baseline should be used, false if the threshold should be used.

Definition at line 654 of file doc.h.

GetFSelect() [1/2]

int wxStfFitSelDlg::GetFSelect ( ) const

inline

Get the selected fit function.

Returns

The index of the selected fit function.

Definition at line 99 of file fitseldlg.h.

GetFSelect() [2/2]

int wxStfTransformDlg::GetFSelect ( ) const

inline

Get the selected transform function.

Returns

The index of the selected transform function.

Definition at line 259 of file smalldlgs.h.

GetFuncLib()

const std::vector< stfnum::storedFunc > & wxStfApp::GetFuncLib ( ) const

inline

Retrieves the functions that are available for least-squares minimisation.

Returns

A vector containing the available functions.

Definition at line 344 of file app.h.

GetFuncLibPtr()

stfnum::storedFunc * wxStfApp::GetFuncLibPtr ( std::size_t at )

inline

Retrieves a pointer to a function for least-squares minimisation.

Returns

A vector containing the available functions.

Definition at line 350 of file app.h.

GetGimmicks()

bool wxStfPreprintDlg::GetGimmicks ( ) const

inline

Indicates whether gimmicks (cursors, results table etc.) sould be printed.

Returns

true if gimmicks should be printed.

Definition at line 516 of file smalldlgs.h.

GetGraph()

wxStfGraph * wxStfView::GetGraph ( )

inline

Retrieve the attached graph.

Returns

A pointer to the attached graph.

Definition at line 76 of file view.h.

GetHalfDuration()

double wxStfDoc::GetHalfDuration ( ) const

inline

Retrieves the full width at half-maximal amplitude ("half duration").

Returns

The difference between GetT50RightReal() and GetT50LeftReal(), expressed in units of data points.

Definition at line 598 of file doc.h.

GetHLines()

int wxStfTextImportDlg::GetHLines ( ) const

inline

Get the number of header lines.

Returns

The number of header lines.

Definition at line 649 of file smalldlgs.h.

GetInitP()

Vector_double wxStfFitSelDlg::GetInitP ( ) const

inline

Get the initial parameters.

Returns

A valarray containing the initial parameter set to start the fit.

Definition at line 104 of file fitseldlg.h.

GetInnerHiRT()

double wxStfDoc::GetInnerHiRT ( ) const

inline

Retrieves the time point at which Hi% of the maximal amplitude have been reached.

Returns

The time point at which Hi% of the maximal amplitude have been reached, expressed in units of data points.

Definition at line 442 of file doc.h.

GetInnerLoRT()

double wxStfDoc::GetInnerLoRT ( ) const

inline

Retrieves the time point at which Lo% of the maximal amplitude have been reached.

Returns

The time point at which Lo% of the maximal amplitude have been reached, expressed in units of data points.

Definition at line 436 of file doc.h.

GetInnerRiseTime()

double wxStfDoc::GetInnerRiseTime ( ) const

inline

Retrieves the inner rise time.

expressed in units o data points.

Definition at line 588 of file doc.h.

GetIsAverage()

bool wxStfDoc::GetIsAverage ( ) const

inline

Indicates whether an average has been created.

Returns

true if an average has been created, false otherwise.

Definition at line 181 of file doc.h.

GetLatency()

double wxStfDoc::GetLatency ( ) const

inline

Retrieves the latency.

Returns

The latency, expressed in units of data points.

Definition at line 418 of file doc.h.

GetLatencyBeg()

double wxStfDoc::GetLatencyBeg ( ) const

inline

Retrieves the position of the left latency cursor.

Returns

The index of the left latency cursor within the current section. Note that by contrast to the other cursors, this is a double because the latency cursor may be set to an interpolated position between two data points.

Definition at line 406 of file doc.h.

GetLatencyEnd()

double wxStfDoc::GetLatencyEnd ( ) const

inline

Retrieves the position of the right latency cursor.

Returns

The interpolated index of the right latency cursor within the current section. Note that by contrast to the other cursors, this is a double because the latency cursor may be set to an interpolated position between two data points.

Definition at line 413 of file doc.h.

GetLatencyEndMode() [1/2]

stf::latency_mode wxStfCursorsDlg::GetLatencyEndMode

(

)

const

Gets the mode of Latency of the last latency cursor.

Returns

The current mode of the last latency cursor.

GetLatencyEndMode() [2/2]

stf::latency_mode wxStfDoc::GetLatencyEndMode ( ) const

inline

Retrieves the mode of the latency end cursor.

Returns

The current mode of the latency end cursor.

Definition at line 626 of file doc.h.

GetLatencyStartMode() [1/2]

stf::latency_mode wxStfCursorsDlg::GetLatencyStartMode

(

)

const

Gets the mode of Latency for the beginning of the latency cursor.

Returns

The current mode for the beginning latency cursor.

GetLatencyStartMode() [2/2]

stf::latency_mode wxStfDoc::GetLatencyStartMode ( ) const

inline

Retrieves the mode of the latency start cursor.

Returns

The current mode of the latency start cursor.

Definition at line 621 of file doc.h.

GetLatencyWindowMode()

stf::latency_window_mode wxStfDoc::GetLatencyWindowMode ( ) const

inline

Retrieves the mode of the latency window.

Returns

The current mode of the latency window.

Definition at line 631 of file doc.h.

GetLinFuncPtr()

stfnum::storedFunc * wxStfApp::GetLinFuncPtr ( )

inline

Retrieves a pointer to a function for least-squares minimisation.

Returns

A vector containing the available functions.

Definition at line 356 of file app.h.

GetMainFrame()

wxStfParentFrame * wxStfApp::GetMainFrame ( )

inline

Definition at line 478 of file app.h.

GetMaxDecay()

double wxStfDoc::GetMaxDecay ( ) const

inline

Retrieves the maximal slope of the decaying phase.

Returns

The maximal slope of rise.

Definition at line 487 of file doc.h.

GetMaxDecayT()

double wxStfDoc::GetMaxDecayT ( ) const

inline

Retrieves the time point of the maximal slope during the decaying phase.

Returns

The time point of the maximal slope during the decaying phase, expressed in units of data points.

Definition at line 527 of file doc.h.

GetMaxDecayY()

double wxStfDoc::GetMaxDecayY ( ) const

inline

Retrieves the y-value at the time point of the maximal slope during the decaying phase.

Returns

The y-value at the time point of the maximal slope during the decaying phase.

Definition at line 532 of file doc.h.

GetMaxRise()

double wxStfDoc::GetMaxRise ( ) const

inline

Retrieves the maximal slope of the rising phase.

Returns

The maximal slope during the rising phase.

Definition at line 482 of file doc.h.

GetMaxRiseT()

double wxStfDoc::GetMaxRiseT ( ) const

inline

Retrieves the time point of the maximal slope during the rising phase.

Returns

The time point of the maximal slope during the rising phase, expressed in units of data points.

Definition at line 517 of file doc.h.

GetMaxRiseY()

double wxStfDoc::GetMaxRiseY ( ) const

inline

Retrieves the y-value at the time point of the maximal slope during the rising phase.

Returns

The y-value at the time point of the maximal slope during the rising phase.

Definition at line 522 of file doc.h.

GetMaxT()

double wxStfDoc::GetMaxT ( ) const

inline

Retrieves the time point at which the peak is found.

Returns

The time point at which the peak is found, expressed in units of data points.

Definition at line 572 of file doc.h.

GetMeasCursor()

std::size_t wxStfDoc::GetMeasCursor ( ) const

inline

Retrieves the position of the measurement cursor (crosshair).

Returns

The index of the measurement cursor within the current section.

Definition at line 340 of file doc.h.

GetMeasRuler()

bool wxStfDoc::GetMeasRuler ( ) const

inline

Retrieves whether the measurement cursor (crosshair) is visible.

Parameters

true	if the ruler is visible, false otherwirse..

Definition at line 781 of file doc.h.

GetMeasValue()

double wxStfDoc::GetMeasValue

(

)

Retrieves the y-value at the measurement cursor (crosshair). Will update measCursor if out of range.

Returns

The y-value at the measurement cursor.

GetMenuBar()

virtual wxMenuBar * wxStfChildFrame::GetMenuBar ( ) const

virtual

Override default GetMenuBar.

Returns

the menu bar if non-NULL; otherwise, the parent's menu bar

GetMgr() [1/2]

wxAuiManager * wxStfChildFrame::GetMgr ( )

inline

Retrieve the wxAuiManager.

Returns

A pointer to the wxAuiManager.

Definition at line 141 of file childframe.h.

GetMgr() [2/2]

wxAuiManager & wxStfParentFrame::GetMgr ( )

inline

Retrieve the wxAuiManager.

Returns

A reference to the wxAuiManager.

Definition at line 138 of file parentframe.h.

GetMinDistance()

int wxStfEventDlg::GetMinDistance ( ) const

inline

Get the minimal distance between events.

Returns

The minimal distance between events in units of sampling points.

Definition at line 94 of file eventdlg.h.

GetMode()

stf::extraction_mode wxStfEventDlg::GetMode ( ) const

inline

Indicates the selected extraction algorithm.

Returns

The extraction algorithm.

Definition at line 89 of file eventdlg.h.

GetMouseQual()

stf::cursor_type wxStfParentFrame::GetMouseQual

(

)

const

Retrieve the current mouse mode.

Returns

The current mouse cursor mode.

GetMplFigNo()

int wxStfParentFrame::GetMplFigNo ( )

inline

Definition at line 151 of file parentframe.h.

GetNColumns()

int wxStfTextImportDlg::GetNColumns ( ) const

inline

Get the number of columns.

Returns

The number of columns.

Definition at line 664 of file smalldlgs.h.

GetNumberCols()

virtual int wxStfTable::GetNumberCols ( )

inlinevirtual

Get the number of columns.

Returns

The number of columns.

Definition at line 46 of file table.h.

GetNumberRows()

virtual int wxStfTable::GetNumberRows ( )

inlinevirtual

Get the number of rows.

Returns

The number of rows.

Definition at line 41 of file table.h.

GetOpts()

Vector_double wxStfFitSelDlg::GetOpts ( ) const

inline

Get options for the algorithm.

Returns

A valarray containing the initial parameters for the algorithm.

Definition at line 109 of file fitseldlg.h.

GetOuterHiRT()

double wxStfDoc::GetOuterHiRT ( ) const

inline

Retrieves the time point at which Hi% of the maximal amplitude have been reached.

Returns

The time point at which Hi% of the maximal amplitude have been reached, expressed in units of data points.

Definition at line 454 of file doc.h.

GetOuterLoRT()

double wxStfDoc::GetOuterLoRT ( ) const

inline

Retrieves the time point at which Lo% of the maximal amplitude have been reached.

Returns

The time point at which Lo% of the maximal amplitude have been reached, expressed in units of data points.

Definition at line 448 of file doc.h.

GetOuterRiseTime()

double wxStfDoc::GetOuterRiseTime ( ) const

inline

Retrieves the outer rise time.

expressed in units o data points.

Definition at line 593 of file doc.h.

GetPageInfo()

void wxStfPrintout::GetPageInfo	(	int *	minPage,
		int *	maxPage,
		int *	selPageFrom,
		int *	selPageTo )

Retrieve information about the pages that will be printed.

Parameters

minPage	On return, a pointer to the minimal page number allowed.
maxPage	On return, a pointer to the maximal page number allowed.
selPageFrom	On return, a pointer to the minimal selected page number allowed.
selPageTo	On return, a pointer to the maximal selected page number allowed.

GetPageSetup()

wxPageSetupDialogData * wxStfParentFrame::GetPageSetup ( )

inline

Retrieves the page setup.

Returns

Pointer to the page setup data.

Definition at line 133 of file parentframe.h.

GetPeak()

double wxStfDoc::GetPeak ( ) const

inline

Retrieves the peak value.

Returns

The peak value.

Definition at line 542 of file doc.h.

GetPeakAtEnd() [1/2]

bool wxStfCursorsDlg::GetPeakAtEnd

(

)

const

Indicates whether the right peak cursor should always be at the end of the trace.

Returns

true if the peak cursor should always be at the end of the trace.

GetPeakAtEnd() [2/2]

bool wxStfDoc::GetPeakAtEnd ( ) const

inline

Indicates whether the right peak cursor should always be at the end of a trace.

Returns

true if the right peak cursor should be at the end, false otherwise.

Definition at line 191 of file doc.h.

GetPeakBeg()

std::size_t wxStfDoc::GetPeakBeg ( ) const

inline

Retrieves the position of the left peak cursor.

Returns

The index of the left peak cursor within the current section.

Definition at line 360 of file doc.h.

GetPeakEnd()

std::size_t wxStfDoc::GetPeakEnd ( ) const

inline

Retrieves the position of the right peak cursor.

Returns

The index of the right peak cursor within the current section.

Definition at line 365 of file doc.h.

GetPeakPoints()

int wxStfCursorsDlg::GetPeakPoints

(

)

const

Gets the number of points used for the binned average during peak detection.

Returns

The number of points used for the binned average during peak detection.

GetPeakTime()

double wxStfDoc::GetPeakTime ( ) const

inline

Retrieves the peak time value.

Returns

The peak time value.

Definition at line 547 of file doc.h.

GetPM()

int wxStfDoc::GetPM ( ) const

inline

Retrieves the number of points used for averaging during peak calculation.

Returns

The number of points to be used.

Definition at line 392 of file doc.h.

GetPrintData()

wxPrintData * wxStfParentFrame::GetPrintData ( )

inline

Retrieves the print data.

Returns

Pointer to the stored print data.

Definition at line 128 of file parentframe.h.

GetRTFactor() [1/2]

int wxStfCursorsDlg::GetRTFactor

(

)

const

Gets the lower factor (e.g 20) used to calculate the rise time.

Returns

The lower value of the percentage (e.g 20) to calculate the rise time.

GetRTFactor() [2/2]

int wxStfDoc::GetRTFactor ( ) const

inline

Retrieves lower factor (e.g 20) for the rise time calculation.

Returns

lower factor value for rise time calculation expressed in percentage (e.g 20).

Definition at line 609 of file doc.h.

GetRTLoHi()

double wxStfDoc::GetRTLoHi ( ) const

inline

Retrieves the Lo to Hi% rise time.

Returns

The difference between GetTHiReal() and GetTLoReal(), expressed in units o data points.

Definition at line 583 of file doc.h.

GetRuler()

bool wxStfCursorsDlg::GetRuler

(

)

const

Indicates whether an additional vertical ruler is drawn through the measurement cursor.

Returns

true if an additional ruler should be drawn.

GetSectionAttributes()

const stf::SectionAttributes & wxStfDoc::GetSectionAttributes	(	std::size_t	nchannel,
		std::size_t	nsection ) const

GetSectionsWithFits()

std::vector< stf::SectionPointer > wxStfApp::GetSectionsWithFits

(

)

const

Retrieves all sections with fits.

Returns

A vector containing pointers to all sections in which fits have been performed

GetSelCh1()

int wxStfChannelSelDlg::GetSelCh1 ( ) const

inline

Get selection for channel 1.

Returns

The index of the first (active) channel

Definition at line 115 of file smalldlgs.h.

GetSelCh2()

int wxStfChannelSelDlg::GetSelCh2 ( ) const

inline

Get selection for channel 2.

Returns

The index of the second (reference) channel

Definition at line 120 of file smalldlgs.h.

GetSelection() [1/2]

wxString wxStfGrid::GetSelection ( ) const

inline

Get the selection.

Returns

The selected cells as a string.

Definition at line 52 of file copygrid.h.

GetSelection() [2/2]

wxString wxStfTable::GetSelection

(

const wxGridCellCoordsArray &

selection

)

Retrieve values from selected cells.

Parameters

selection

The selected cells.

Returns

The selection as a single string.

GetSlope()

double wxStfCursorsDlg::GetSlope

(

)

const

Get the slope at which the baseline should be fixed.

Returns

The slope at which the baseline should be fixed.

GetSlopeForThreshold()

double wxStfDoc::GetSlopeForThreshold ( ) const

inline

Returns the slope for threshold detection.

Returns

The slope value for threshold detection.

Definition at line 746 of file doc.h.

GetSlopeRatio()

double wxStfDoc::GetSlopeRatio ( ) const

inline

Retrieves ratio of the maximal slopes during the rising and decaying phase.

Returns

The ratio of GetMaxRise() and GetMaxDecay().

Definition at line 604 of file doc.h.

GetSR()

double wxStfTextImportDlg::GetSR ( ) const

inline

Get the sampling rate.

Returns

The sampling rate.

Definition at line 669 of file smalldlgs.h.

GetSrcDir()

wxString wxStfConvertDlg::GetSrcDir ( ) const

inline

Get the source directory.

Returns

The source directory.

Definition at line 72 of file convertdlg.h.

GetSrcFileExt()

stfio::filetype wxStfConvertDlg::GetSrcFileExt ( ) const

inline

Get the source extension as stfio::filetype.

Returns

The source extension as stfio::filetype.

Definition at line 87 of file convertdlg.h.

GetSrcFileNames()

wxArrayString wxStfConvertDlg::GetSrcFileNames ( ) const

inline

Get the list of file names.

Returns

A vector with source file names.

Definition at line 97 of file convertdlg.h.

GetSrcFilter()

wxString wxStfConvertDlg::GetSrcFilter ( ) const

inline

Get the source extension filter.

Returns

The source extension filter.

Definition at line 82 of file convertdlg.h.

GetStartFitAtPeak() [1/2]

bool wxStfCursorsDlg::GetStartFitAtPeak

(

)

const

Indicates whether to always start a fit at the current peak position.

Returns

true if the fit should always be started at the current peak position.

GetStartFitAtPeak() [2/2]

bool wxStfDoc::GetStartFitAtPeak ( ) const

inline

Indicates whether the left decay cursor should always be at the peak of the trace.

Returns

true if the left decay cursor should be at the end of the trace, false otherwise.

Definition at line 186 of file doc.h.

GetT0Real()

double wxStfDoc::GetT0Real ( ) const

inline

Retrieves the extrapolated onset time point of an event in the active channel.

Returns

The onset time point of an event, extrapolated from the crossing of a line through 20 and 80% of the event amplitude with the baseline. Expressed in units of data points.

Definition at line 460 of file doc.h.

GetT50LeftReal()

double wxStfDoc::GetT50LeftReal ( ) const

inline

Retrieves the time point at which 50% of the maximal amplitude have been reached from the left of the peak.

Returns

The time point at which 50% of the maximal amplitude have been reached from the left of the peak, expressed in units of data points.

Definition at line 466 of file doc.h.

GetT50RightReal()

double wxStfDoc::GetT50RightReal ( ) const

inline

Retrieves the time point at which 50% of the maximal amplitude have been reached from the right of the peak.

Returns

The time point at which 50% of the maximal amplitude have been reached from the right of the peak, expressed in units of data points.

Definition at line 472 of file doc.h.

GetT50Y()

double wxStfDoc::GetT50Y ( ) const

inline

Retrieves the y value at 50% of the maximal amplitude.

Returns

The y value at 50% of the maximal amplitude.

Definition at line 477 of file doc.h.

GetTemplate()

int wxStfEventDlg::GetTemplate ( ) const

inline

Get the selected template.

Returns

The index of the template fit to be used for event detection.

Definition at line 99 of file eventdlg.h.

GetTHiReal()

double wxStfDoc::GetTHiReal ( ) const

inline

Retrieves the time point at which Hi% of the maximal amplitude have been reached.

Returns

The time point at which Hi% of the maximal amplitude have been reached, expressed in units of data points.

Definition at line 430 of file doc.h.

GetThreshold() [1/2]

double wxStfDoc::GetThreshold ( ) const

inline

Retrieves the value at which the threshold slope is crossed.

Returns

The standard deviation of the baseline.

Definition at line 567 of file doc.h.

GetThreshold() [2/2]

double wxStfEventDlg::GetThreshold ( ) const

inline

Get the event detection threshold.

Returns

The event detection threshold.

Definition at line 84 of file eventdlg.h.

GetThrT()

double wxStfDoc::GetThrT ( ) const

inline

Retrieves the time point at which the threshold slope is crossed.

Returns

The time point at which the threshold slope is crossed, or a negative value if the threshold is not attained.

Definition at line 578 of file doc.h.

GetTLoReal()

double wxStfDoc::GetTLoReal ( ) const

inline

Retrieves the time point at which Lo% of the maximal amplitude have been reached.

Returns

The time point at which Lo% of the maximal amplitude have been reached, expressed in units of data points.

Definition at line 424 of file doc.h.

GetTxtImport() [1/2]

const stfio::txtImportSettings & wxStfApp::GetTxtImport ( ) const

inline

Retrieves the text import filter settings.

Returns

A struct with the current text import filter settings.

Definition at line 330 of file app.h.

GetTxtImport() [2/2]

stfio::txtImportSettings wxStfTextImportDlg::GetTxtImport

(

)

const

Get the text import filter settings struct.

Returns

The stf::txtImportSettings struct.

GetValue()

virtual wxString wxStfTable::GetValue ( int row, int col )

virtual

Retrieve a cell entry.

Parameters

row	The row number of the cell.
col	The column number of the cell.

Returns

The cell entry as a string.

GetVersionString()

wxString wxStfApp::GetVersionString

(

)

const

Get a formatted version string.

Returns

A version string (stimfit x.y.z, release/debug build, date).

GetViewBaseline()

bool wxStfDoc::GetViewBaseline ( ) const

inline

Indicates whether the baseline value should be shown in the results table.

Returns

true if it should be shown, false otherwise.

Definition at line 664 of file doc.h.

GetViewBaseSD()

bool wxStfDoc::GetViewBaseSD ( ) const

inline

Indicates whether the baseline's standard deviation should be shown in the results table.

Returns

true if it should be shown, false otherwise.

Definition at line 669 of file doc.h.

GetViewCrosshair()

bool wxStfDoc::GetViewCrosshair ( ) const

inline

Indicates whether the measurement cursor (crosshair) value should be shown in the results table.

Returns

true if it should be shown, false otherwise.

Definition at line 659 of file doc.h.

GetViewCursors()

bool wxStfDoc::GetViewCursors ( ) const

inline

Indicates whether two additional rows showing the positions of start and end cursors should be shown in the results table.

Returns

true if it should be shown, false otherwise.

Definition at line 741 of file doc.h.

GetViewInnerRiseTime()

bool wxStfDoc::GetViewInnerRiseTime ( ) const

inline

Indicates whether the inner rise time should be shown in the results table.

Returns

true if it should be shown, false otherwise.

Definition at line 699 of file doc.h.

GetViewLatency()

bool wxStfDoc::GetViewLatency ( ) const

inline

Indicates whether the latency should be shown in the results table.

Returns

true if it should be shown, false otherwise.

Definition at line 729 of file doc.h.

GetViewOuterRiseTime()

bool wxStfDoc::GetViewOuterRiseTime ( ) const

inline

Indicates whether the outer rise time should be shown in the results table.

Returns

true if it should be shown, false otherwise.

Definition at line 704 of file doc.h.

GetViewPeakBase()

bool wxStfDoc::GetViewPeakBase ( ) const

inline

Indicates whether the peak value (measured from baseline) should be shown in the results table.

Returns

true if it should be shown, false otherwise.

Definition at line 684 of file doc.h.

GetViewPeakThreshold()

bool wxStfDoc::GetViewPeakThreshold ( ) const

inline

Indicates whether the peak value (measured from threshold) should be shown in the results table.

Returns

true if it should be shown, false otherwise.

Definition at line 689 of file doc.h.

GetViewPeakZero()

bool wxStfDoc::GetViewPeakZero ( ) const

inline

Indicates whether the peak value (measured from zero) should be shown in the results table.

Returns

true if it should be shown, false otherwise.

Definition at line 679 of file doc.h.

GetViewRD()

bool wxStfDoc::GetViewRD ( ) const

inline

Indicates whether the ratio of the maximal slopes during rise and decay should be shown in the results table.

Returns

true if it should be shown, false otherwise.

Definition at line 714 of file doc.h.

GetViewRTLoHi()

bool wxStfDoc::GetViewRTLoHi ( ) const

inline

Indicates whether the Lo to Hi% rise time should be shown in the results table.

Returns

true if it should be shown, false otherwise.

Definition at line 694 of file doc.h.

GetViewSlopeDecay()

bool wxStfDoc::GetViewSlopeDecay ( ) const

inline

Indicates whether the maximal slope during the decaying phase should be shown in the results table.

Returns

true if it should be shown, false otherwise.

Definition at line 724 of file doc.h.

GetViewSlopeRise()

bool wxStfDoc::GetViewSlopeRise ( ) const

inline

Indicates whether the maximal slope during the rising phase should be shown in the results table.

Returns

true if it should be shown, false otherwise.

Definition at line 719 of file doc.h.

GetViewT50()

bool wxStfDoc::GetViewT50 ( ) const

inline

Indicates whether the half duration should be shown in the results table.

Returns

true if it should be shown, false otherwise.

Definition at line 709 of file doc.h.

GetViewThreshold()

bool wxStfDoc::GetViewThreshold ( ) const

inline

Indicates whether the threshold should be shown in the results table.

Returns

true if it should be shown, false otherwise.

Definition at line 674 of file doc.h.

GetXUnits()

const wxString & wxStfTextImportDlg::GetXUnits ( ) const

inline

Get the x units.

Returns

The x units.

Definition at line 684 of file smalldlgs.h.

GetXZoom()

const XZoom & wxStfDoc::GetXZoom ( )

inline

Returns the current zoom settings for this channel (read-only).

Returns

The current zoom settings.

Definition at line 751 of file doc.h.

GetXZoomW()

XZoom & wxStfDoc::GetXZoomW ( )

inline

Returns the current zoom settings for this channel (read & write).

Returns

The current zoom settings.

Definition at line 756 of file doc.h.

GetYUnits()

const wxString & wxStfTextImportDlg::GetYUnits ( ) const

inline

Get the y units of the first channel.

Returns

The y units of the first channel.

Definition at line 674 of file smalldlgs.h.

GetYUnitsCh2()

const wxString & wxStfTextImportDlg::GetYUnitsCh2 ( ) const

inline

Get the y units of the second channel.

Returns

The y units of the second channel.

Definition at line 679 of file smalldlgs.h.

GetYZoom()

const YZoom & wxStfDoc::GetYZoom ( int ch )

inline

Returns the current zoom settings for this channel (read-only).

Returns

The current zoom settings.

Definition at line 761 of file doc.h.

GetYZoomW()

YZoom & wxStfDoc::GetYZoomW ( int ch )

inline

Returns the current zoom settings for this channel (read & write).

Returns

The current zoom settings.

Definition at line 766 of file doc.h.

GetZoomQual()

stf::zoom_channels wxStfParentFrame::GetZoomQual

(

)

const

Retrieve which channels will be affected by scaling operations.

Returns

The channels affected by scaling operations.

HasPage()

bool wxStfPrintout::HasPage

(

int

page

)

Checks whether a page exists.

Parameters

page	The page number to be checked.

Returns

True if page exists.

InfoMsg()

void wxStfApp::InfoMsg ( const wxString & msg ) const

inline

Displays a message box with information.

You can use this function from almost anywhere using wxGetApp().InfoMsg( wxT( "Info xyz" ) );

Parameters

msg	The message string to be shown.

Definition at line 311 of file app.h.

InsertChannel()

virtual void wxStfDoc::InsertChannel ( Channel & c_Channel, std::size_t pos )

virtual

Insert a Channel at a given position.

Will throw std::out_of_range if range check fails.

Parameters

c_Channel	The Channel to be inserted.
pos	The position at which to insert the channel (0-based).

Reimplemented from Recording.

InteractiveEraseEvents()

void wxStfDoc::InteractiveEraseEvents

(

wxCommandEvent &

event

)

Erases all events, independent of whether they are checked or not.

Parameters

event

The menu event that made the call.

IsEmptyCell()

virtual bool wxStfTable::IsEmptyCell ( int row, int col )

virtual

Check whether a cell is empty.

Parameters

row	The row number of the cell.
col	The column number of the cell.

Returns

true if the cell is empty, false otherwise.

IsInitialized()

bool wxStfDoc::IsInitialized ( ) const

inline

Indicates whether the the document is fully initialised.

The document has to be fully initialized before other parts of the program start accessing it; for example, the graph might start reading out values before they exist.

Returns

true if the document is fully initialised, false otherwise.

Definition at line 199 of file doc.h.

LoadCursorConf()

bool wxStfCursorsDlg::LoadCursorConf

(

const wxString &

filepath

)

Load a cursor configuration file (*csr) in the Cursor Settings menu.

Parameters

filepath

The path where the csr file is located.

Loadperspective()

void wxStfChildFrame::Loadperspective

(

)

Load the saved AUI perspective from the configuration.

LoadTDMS()

bool wxStfDoc::LoadTDMS	(	const std::string &	filename,
		Recording &	ReturnData )

References Recording::Recording().

MakePythonWindow()

new_wxwindow wxStfParentFrame::MakePythonWindow	(	const std::string &	windowFunc,
		const std::string &	mgr_name = "pythonShell",
		const std::string &	caption = "Python Shell",
		bool	show = true,
		bool	full = false,
		bool	isfloat = true,
		int	width = -1,
		int	height = -1,
		double	mpl_width = 8.0,
		double	mpl_height = 6.0 )

Measure()

void wxStfDoc::Measure

(

)

Measure everything using functions defined in measlib.h.

This will measure the baseline, peak values, Lo to Hi% rise time, half duration, maximal slopes during rise and decay, the ratio of these slopes and the latency.

new_wxwindow()

new_wxwindow::new_wxwindow ( wxWindow * cppW = NULL, PyObject * pyW = NULL )

inline

Definition at line 44 of file parentframe.h.

References cppWindow, and pyWindow.

NewChild()

wxStfDoc * wxStfApp::NewChild	(	const Recording &	NewData,
		const wxStfDoc *	Sender,
		const wxString &	title = wxT("\0") )

Creates a new child window showing a new document.

Parameters

NewData	The new data to be shown in the new window.
Sender	The document that was at the origin of this new window.
title	A title for the new document.

Returns

A pointer to the newly created document.

OnAbout()

void wxStfParentFrame::OnAbout

(

wxCommandEvent &

event

)

Shows the "About" dialog.

Parameters

event

The menu event that made the call.

OnActivate()

void wxStfChildFrame::OnActivate

(

wxActivateEvent &

event

)

OnActivateView()

virtual void wxStfView::OnActivateView ( bool activate, wxView * activeView, wxView * deactiveView )

protectedvirtual

Called when the view is activated; dialogs and menus are then updated.

Parameters

activate	true if this view is being activated.
activeView	Pointer to the view that is now active.
deactiveView	Pointer to the view that has just been deactivated.

References wxStfView().

OnAddAnnotation()

void wxStfDoc::OnAddAnnotation

(

wxCommandEvent &

WXUNUSEDevent

)

Adds an annotation at the current eventPos.

Parameters

event

The menu event that made the call.

OnBeginDocument()

bool wxStfPrintout::OnBeginDocument	(	int	startPage,
		int	endPage )

Called by the framework at the start of document printing.

Parameters

startPage	Page from which to start printing.
endPage	Page at which to end printing.

Returns

false cancels the print job.

OnCalculatedThresholdExpertDetectEvents()

void wxStfDoc::OnCalculatedThresholdExpertDetectEvents	(	double	threshold,
		std::size_t	filterOrder )

OnClose()

virtual bool wxStfView::OnClose ( bool deleteWindow = true )

virtual

Override default file closing behaviour.

Parameters

deleteWindow

true if the child frame should be deleted.

Returns

true if file closing was successful.

OnCloseDocument()

virtual bool wxStfDoc::OnCloseDocument ( )

virtual

Override default file closing.

Writes settings to the config file or registry before closing.

Returns

true if successfully closed, false otherwise.

OnCmdLineParsed()

virtual bool wxStfApp::OnCmdLineParsed ( wxCmdLineParser & parser )

virtual

OnCreate()

virtual bool wxStfView::OnCreate ( wxDocument * doc, long flags )

virtual

Override default view creation.

Creates a child frame and a graph, sets the window title.

Parameters

doc	Pointer to the attached document.
flags	View creation flags.

Returns

true upon successful view creation, false otherwise.

OnDown()

void wxStfGraph::OnDown

(

)

Moves the traces down by 20 px.

Called when either the down arrow cursor key is pressed or the "Move traces down"-button is clicked.

OnDraw() [1/2]

virtual void wxStfGraph::OnDraw ( wxDC & dc )

virtual

The central drawing function. Used for drawing to any output device, such as a printer or a screen.

Parameters

dc	is the device context used for drawing (can be a printer, a screen or a file).

OnDraw() [2/2]

virtual void wxStfView::OnDraw ( wxDC * dc )

virtual

The drawing function (note that actual drawing happens in wxStfGraph::OnDraw())

Parameters

dc	Pointer to the device context.

See also

wxStfGraph::OnDraw()

OnEraseAllAnnotations()

void wxStfDoc::OnEraseAllAnnotations

(

wxCommandEvent &

WXUNUSEDevent

)

Erase all annotations at the current channel and sweep.

Parameters

event

The menu event that made the call.

OnExit()

virtual int wxStfApp::OnExit ( )

virtual

Exit the application.

Does nothing but calling the base class's wxApp::OnExit().

Returns

The return value of wxApp::OnExit().

OnExpertDetectEvents()

void wxStfDoc::OnExpertDetectEvents

(

wxCommandEvent &

WXUNUSEDevent

)

detects events based on the expert scoring using simple filter

Parameters

event

The menu event that made the call.

OnExportAnnotations()

void wxStfDoc::OnExportAnnotations

(

wxCommandEvent &

WXUNUSEDevent

)

Export all annotations of current doc.

Parameters

event

The menu event that made the call.

OnFirst()

void wxStfGraph::OnFirst

(

)

Show and analyse first trace.

Called when the "first trace"-button is clicked.

OnImportAnnotations()

void wxStfDoc::OnImportAnnotations

(

wxCommandEvent &

WXUNUSEDevent

)

Import all annotations of current doc.

Parameters

event

The menu event that made the call.

OnInit()

virtual bool wxStfApp::OnInit ( )

virtual

Initialise the application.

Initialises the document manager and the file-independent menu items, loads the user-defined extension library and the least-squares function library, parses the command line and attempts to open a file if one was given at program startup by either double-clicking it or as a command-line argument.

Returns

true upon successful initialisation, false otherwise.

OnInitCmdLine()

virtual void wxStfApp::OnInitCmdLine ( wxCmdLineParser & parser )

virtual

OnKeyDown()

void wxStfGraph::OnKeyDown

(

wxKeyEvent &

event

)

Handles keyboard input.

Key modifiers (e.g. Shift or Ctrl) ar handled within this function.

Parameters

event

The keyboard event. Contains information about the key that was pressed.

OnLast()

void wxStfGraph::OnLast

(

)

Show and analyse last trace.

Called when the "last trace"-button is clicked.

OnLeft()

void wxStfGraph::OnLeft

(

)

Moves the traces left by 20 px.

Called when either the left arrow cursor key and Ctrl are pressed at the same time or the "Move traces left"-button is clicked.

OnMouseEvent()

void wxStfGraph::OnMouseEvent

(

wxMouseEvent &

event

)

Handles mouse events.

The different possibilities (e.g. left or right click) split up within this function.

Parameters

event

The mouse event. Contains information such as whether the left or right button was clicked.

OnNewDocument()

virtual bool wxStfDoc::OnNewDocument ( )

virtual

Override default file creation.

Returns

true if successfully closed, false otherwise.

OnNewfromselected()

void wxStfApp::OnNewfromselected

(

wxCommandEvent &

event

)

Open a new window showing all selected traces from all open files.

Parameters

event

The associated menu event

OnNewfromselectedThis()

bool wxStfDoc::OnNewfromselectedThis

(

)

Creates a new window containing the selected sections of this file.

Returns

true upon success, false otherwise.

OnNext()

void wxStfGraph::OnNext

(

)

Show and analyse next trace.

Called when either the "next trace"-button is clicked or the right arrow cursor key is pressed. Wraps around when last trace is reached.

OnOpenDocument()

virtual bool wxStfDoc::OnOpenDocument ( const wxString & filename )

virtual

Override default file opening.

Attempts to identify the file type from the filter extension (such as "*.dat")

Parameters

filename

Full path of the file.

Returns

true if successfully opened, false otherwise.

OnOpenPyDocument()

virtual bool wxStfDoc::OnOpenPyDocument ( const wxString & filename )

virtual

Open document without progress dialog.

Attempts to identify the file type from the filter extension (such as "*.dat")

Parameters

filename

Full path of the file.

Returns

true if successfully opened, false otherwise.

OnPeakcalcexecMsg()

void wxStfApp::OnPeakcalcexecMsg

(

wxStfDoc *

actDoc = 0

)

Execute all pending calculations.

Whenever settings that have an effect on measurements, such as cursor positions or trace selections, are modified, this function needs to be called to update the results table.

OnPrevious()

void wxStfGraph::OnPrevious

(

)

Show and analyse previous trace.

Called when either the "previous trace"-button is clicked or the left arrow cursor key is pressed. Wraps around when first trace is reached.

OnPrintPage()

bool wxStfPrintout::OnPrintPage

(

int

page

)

Called by the framework when a page should be printed.

Parameters

page	The page number to be printed

Returns

false will cancel the print job.

OnPythonImport()

void wxStfApp::OnPythonImport

(

wxCommandEvent &

event

)

Opens a dialog to import a Python module.

Parameters

event

The associated menu event

OnRemoveAnnotation()

void wxStfDoc::OnRemoveAnnotation

(

wxCommandEvent &

WXUNUSEDevent

)

Removes an annotation at the current eventPos or a very close one to it.

Parameters

event

The menu event that made the call.

OnRight()

void wxStfGraph::OnRight

(

)

Moves the traces right by 20 px.

Called when either the right arrow cursor key and Ctrl are pressed at the same time or the "Move traces right"-button is clicked.

OnSwapChannels()

void wxStfDoc::OnSwapChannels

(

wxCommandEvent &

event

)

Swaps active and inactive channel.

Parameters

event

The menu event that made the call.

OnUp()

void wxStfGraph::OnUp

(

)

Moves the traces up by 20 px.

Called when either the up arrow cursor key is pressed or the "Move traces up"-button is clicked.

OnUpdate()

virtual void wxStfView::OnUpdate ( wxView * sender, wxObject * hint = (wxObject *) NULL )

virtual

Override default updating behaviour.

Called when the graph should be refreshed.

Parameters

sender	Pointer to the view that requested the update.
hint	Unused.

OnXenlhi()

void wxStfGraph::OnXenlhi

(

)

Enlarges the x-scale by a factor of 2.

This is currently never called and might be removed in the future.

OnXenllo()

void wxStfGraph::OnXenllo

(

)

Enlarges the x-scale by a factor of 1.1.

Called when either the "+" key and Ctrl are pressed at the same time or the "Enlarge x-scale"-button is clicked.

OnXshrinkhi()

void wxStfGraph::OnXshrinkhi

(

)

Shrinks the x-scale by a factor of 2.

This is currently never called and might be removed in the future.

OnXshrinklo()

void wxStfGraph::OnXshrinklo

(

)

Shrinks the x-scale by a factor of 1.1.

Called when either the "-" key and Ctrl are pressed at the same time or the "Shrink x-scale"-button is clicked.

OnYenlhi()

void wxStfGraph::OnYenlhi

(

)

Enlarges the y-scale by a factor of 2.

This is currently never called and might be removed in the future.

OnYenllo()

void wxStfGraph::OnYenllo

(

)

Enlarges the y-scale by a factor of 1.1.

Called when either the "+" key is pressed or the "Enlarge x-scale"-button is clicked.

OnYshrinkhi()

void wxStfGraph::OnYshrinkhi

(

)

Shrinks the y-scale by a factor of 2.

This is currently never called and might be removed in the future.

OnYshrinklo()

void wxStfGraph::OnYshrinklo

(

)

Shrinks the y-scale by a factor of 1.1.

Called when either the "-" key is pressed or the "Shrink x-scale"-button is clicked.

OpenFilePy()

bool wxStfApp::OpenFilePy

(

const wxString &

fNameArray

)

Opens a file in a new window, to be called from Python.

Parameters

fNameArray

An array of file names to be opened.

Returns

true upon successful opening, false otherwise.

OpenFileSeries()

bool wxStfApp::OpenFileSeries

(

const wxArrayString &

fNameArray

)

Opens a series of files. Optionally, files can be put into a single window.

Parameters

fNameArray

An array of file names to be opened.

Returns

true upon successful opening of all files, false otherwise.

PrintBase()

bool wxStfBatchDlg::PrintBase ( ) const

inline

Indicates whether the baseline should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 375 of file smalldlgs.h.

PrintBaseSD()

bool wxStfBatchDlg::PrintBaseSD ( ) const

inline

Indicates whether the standard deviation of the baseline should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 380 of file smalldlgs.h.

PrintFitResults()

bool wxStfBatchDlg::PrintFitResults ( ) const

inline

Indicates whether the fit results should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 467 of file smalldlgs.h.

PrintInnerRTLoHi()

bool wxStfBatchDlg::PrintInnerRTLoHi ( ) const

inline

Indicates whether the Lo-Hi% inner rise time should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 420 of file smalldlgs.h.

PrintLatencies()

bool wxStfBatchDlg::PrintLatencies ( ) const

inline

Indicates whether the latency should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 462 of file smalldlgs.h.

PrintOuterRTLoHi()

bool wxStfBatchDlg::PrintOuterRTLoHi ( ) const

inline

Indicates whether the Lo-Hi% inner rise time should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 425 of file smalldlgs.h.

PrintPeakBase()

bool wxStfBatchDlg::PrintPeakBase ( ) const

inline

Indicates whether the peak (from baseline) value should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 400 of file smalldlgs.h.

PrintPeakThreshold()

bool wxStfBatchDlg::PrintPeakThreshold ( ) const

inline

Indicates whether the peak value (from threshold) should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 405 of file smalldlgs.h.

PrintPeakTime()

bool wxStfBatchDlg::PrintPeakTime ( ) const

inline

Indicates whether the peak value (from threshold) should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 410 of file smalldlgs.h.

PrintPeakZero()

bool wxStfBatchDlg::PrintPeakZero ( ) const

inline

Indicates whether the peak (from 0) value should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 395 of file smalldlgs.h.

PrintRTLoHi()

bool wxStfBatchDlg::PrintRTLoHi ( ) const

inline

Indicates whether the Lo-Hi% rise time should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 415 of file smalldlgs.h.

PrintSlopes()

bool wxStfBatchDlg::PrintSlopes ( ) const

inline

Indicates whether the maximal slopes should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 440 of file smalldlgs.h.

PrintSlopeThresholdTime()

bool wxStfBatchDlg::PrintSlopeThresholdTime ( ) const

inline

Indicates whether the time of slope threshold crossing should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 390 of file smalldlgs.h.

PrintSlopeTimes()

bool wxStfBatchDlg::PrintSlopeTimes ( ) const

inline

Indicates whether the peak value (from threshold) should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 445 of file smalldlgs.h.

PrintT50()

bool wxStfBatchDlg::PrintT50 ( ) const

inline

Indicates whether the half amplitude duration should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 430 of file smalldlgs.h.

PrintT50SE()

bool wxStfBatchDlg::PrintT50SE ( ) const

inline

Indicates whether the start and end time for half amplitude should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 435 of file smalldlgs.h.

PrintThr()

bool wxStfBatchDlg::PrintThr ( ) const

inline

Indicates whether a threshold crossing should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 457 of file smalldlgs.h.

PrintThreshold()

bool wxStfBatchDlg::PrintThreshold ( ) const

inline

Indicates whether the threshold should be printed in the batch analysis table.

Returns

true if it should be printed, false otherwise.

Definition at line 385 of file smalldlgs.h.

Remove()

void wxStfDoc::Remove

(

)

Unselects the current section if previously selected.

resize()

virtual void wxStfDoc::resize ( std::size_t c_n_channels )

virtual

Resize the Recording to a new number of channels.

Resizes both the channel and the global y units arrays.

Parameters

c_n_channels

The new number of channels.

Reimplemented from Recording.

Restoreperspective()

void wxStfChildFrame::Restoreperspective

(

)

Restore the default AUI perspective.

SaveAs()

virtual bool wxStfDoc::SaveAs ( )

virtual

Override default file saving.

Returns

true if successfully saved, false otherwise.

SaveCursorConf()

bool wxStfCursorsDlg::SaveCursorConf

(

const wxString &

filepath

)

Save a cursor configuration file (*csr) from the Cursor Settings menu.

Parameters

filepath

The path where the csr file will be saved

Saveperspective()

void wxStfChildFrame::Saveperspective

(

)

Write the current AUI perspective to the configuration.

Select()

void wxStfDoc::Select

(

)

Selects the current section if previously unselected.

Selectall()

void wxStfDoc::Selectall

(

wxCommandEvent &

event

)

Selects all sections.

Parameters

event

The menu event that made the call.

set_directTxtImport()

void wxStfApp::set_directTxtImport ( bool directTxtImport_ )

inline

Determines whether text files should be imported directly without showing an import filter settings dialog.

Parameters

directTxtImport_

Set to true if text files should be imported directly, false otherwise.

Definition at line 323 of file app.h.

set_downsampling()

void wxStfGraph::set_downsampling ( int value )

inline

Prints every n-th point.

Parameters

value

Determines that every n-th point should be printed.

Definition at line 239 of file graph.h.

set_isBars()

void wxStfApp::set_isBars ( bool value )

inline

Determine whether scale bars or coordinates should be shown.

Parameters

value

Set to true for scale bars, false for coordinates.

Definition at line 456 of file app.h.

set_isPrinted()

void wxStfGraph::set_isPrinted

(

bool

value

)

Set to true if the graph is drawn on a printer.

Parameters

value

boolean determining whether the graph is printed.

set_noGimmicks()

void wxStfGraph::set_noGimmicks ( bool value )

inline

Set to true if the results table and the cursors should be printed.

Parameters

value

boolean determining whether everything should be printed.

Definition at line 234 of file graph.h.

set_printRect()

void wxStfGraph::set_printRect ( wxRect value )

inline

Sets the size of the printout to the epcified rectangle.

Parameters

value

The new printing rectangle.

Definition at line 229 of file graph.h.

set_printScale()

void wxStfGraph::set_printScale ( double value )

inline

Sets the printing scale to the specified value.

Parameters

value

The new printing scale.

Definition at line 224 of file graph.h.

set_txtImportSettings()

void wxStfApp::set_txtImportSettings ( const stfio::txtImportSettings & txtImport_ )

inline

Sets the text import filter settings.

Parameters

txtImport_

A struct with the new text import filter settings.

Definition at line 337 of file app.h.

SetActiveDoc()

void wxStfCursorsDlg::SetActiveDoc ( wxStfDoc * actDoc_ )

inline

Sets the currently active document.

Parameters

actDoc_

A pointer to the currently active document.

Definition at line 388 of file cursorsdlg.h.

SetBaseBeg()

void wxStfDoc::SetBaseBeg

(

int

value

)

Sets the position of the left baseline cursor.

Parameters

value

The index of the left baseline cursor within the current section.

SetBaseEnd()

void wxStfDoc::SetBaseEnd

(

int

value

)

Sets the position of the right baseline cursor.

Parameters

value

The index of the left baseline cursor within the current section.

SetBaselineMethod() [1/2]

void wxStfCursorsDlg::SetBaselineMethod

(

enum stfnum::baseline_method

)

Sets the reference for baseline measurement.

Parameters

median

true if the median should be used, false if the average is used.

SetBaselineMethod() [2/2]

void wxStfDoc::SetBaselineMethod ( stfnum::baseline_method value )

inline

Sets the method to compute the baseline.

Parameters

value

The new method to calculate the baseline.

Definition at line 786 of file doc.h.

SetChannels()

void wxStfChildFrame::SetChannels	(	std::size_t	act,
		std::size_t	inact )

Sets the channels in the combo boxes. Checks and corrects equal channels in both boxes.

Parameters

act	Index of the active channel.
inact	Index of the reference channel.

SetCurTrace()

void wxStfChildFrame::SetCurTrace

(

std::size_t

)

Sets the current trace from the trace selection combo box.

Returns

The 0-based index of the trace to be selected.

SetData()

void wxStfDoc::SetData	(	const Recording &	c_Data,
		const wxStfDoc *	Sender,
		const wxString &	title )

Sets the content of a newly created file.

Parameters

c_Data	The data that is used for the new file.
Sender	Pointer to the document that generated this file.
title	Title of the new document.

References Recording::Recording(), and wxStfDoc().

SetDeltaT()

void wxStfCursorsDlg::SetDeltaT

(

int

DeltaT

)

Sets the number of points used for the distance from the first PSlope cursor.

Parameters

peakPoints

The number of points used for the distance from the first PSlope cursor.

SetDirection() [1/2]

void wxStfCursorsDlg::SetDirection

(

stfnum::direction

direction

)

Sets the direction of peak calculations.

Parameters

direction

The new direction of peak calculations.

SetDirection() [2/2]

void wxStfDoc::SetDirection ( stfnum::direction value )

inline

Sets the direction of peak calculations.

Parameters

value

The new direction of peak calculations.

Definition at line 918 of file doc.h.

SetFileMenu()

void wxStfDoc::SetFileMenu ( wxMenu * menu )

inline

Sets a pointer to the file menu attached to this document.

Parameters

menu	The menu to be attached.

Definition at line 325 of file doc.h.

SetFitBeg()

void wxStfDoc::SetFitBeg

(

int

value

)

Sets the position of the left fitting cursor.

Parameters

value

The index of the left fitting cursor within the current section.

SetFitEnd()

void wxStfDoc::SetFitEnd

(

int

value

)

Sets the position of the right fitting cursor.

Parameters

value

The index of the right fitting cursor within the current section.

SetFromBase() [1/2]

void wxStfCursorsDlg::SetFromBase

(

bool

frombase

)

Sets the reference for AP kinetics measurements.

Parameters

frombase

true if the baseline should be used, false if the threshold should be used.

SetFromBase() [2/2]

void wxStfDoc::SetFromBase ( bool frombase )

inline

Sets the reference for AP kinetics measurements.

Parameters

frombase

true if the baseline should be used, false if the threshold should be used.

Definition at line 923 of file doc.h.

SetIsFitted()

void wxStfDoc::SetIsFitted	(	std::size_t	nchannel,
		std::size_t	nsection,
		const Vector_double &	bestFitP_,
		stfnum::storedFunc *	fitFunc_,
		double	chisqr,
		std::size_t	fitBeg_,
		std::size_t	fitEnd_ )

Sets the best-fit parameters when a fit has been performed on this section.

Parameters

bestFitP_	The best-fit parameters
fitFunc_	The function used for fitting
chisqr	The sum of squared errors
fitBeg	Sampling point index where the fit starts
fitEnd	Sampling point index where the fit ends

SetIsIntegrated()

void wxStfDoc::SetIsIntegrated	(	std::size_t	nchannel,
		std::size_t	nsection,
		bool	value,
		std::size_t	begin,
		std::size_t	end,
		const Vector_double &	quad_p_ )

Determines whether an integral has been calculated in this section.

Returns

true if an integral has been calculated, false otherwise.

SetLatency()

void wxStfDoc::SetLatency ( double value )

inline

Sets the latency.

Parameters

value

The latency, expressed in units of data points.

Definition at line 835 of file doc.h.

SetLatencyBeg()

void wxStfDoc::SetLatencyBeg

(

double

value

)

Sets the position of the left latency cursor.

Parameters

value

The index of the left latency cursor within the current section. Note that by contrast to the other cursors, this is a double because the latency cursor may be set to an interpolated position between two data points.

SetLatencyEnd()

void wxStfDoc::SetLatencyEnd

(

double

value

)

Sets the position of the right latency cursor.

Parameters

value

The index of the right latency cursor within the current section. Note that by contrast to the other cursors, this is a double because the latency cursor may be set to an interpolated position between two data points.

SetLatencyEndMode() [1/3]

void wxStfCursorsDlg::SetLatencyEndMode

(

stf::latency_mode

latencyEndMode

)

Sets the latency mode of the right latency cursor.

Parameters

latencyEndMode

the new mode for the right latency cursor.

SetLatencyEndMode() [2/3]

void wxStfDoc::SetLatencyEndMode

(

int

value

)

Sets the mode of the latency end cursor.

Parameters

value

The new mode of the latency end cursor..

SetLatencyEndMode() [3/3]

void wxStfDoc::SetLatencyEndMode ( stf::latency_mode value )

inline

Sets the mode of the latency end cursor.

Parameters

value

The new mode of the latency end cursor.

Definition at line 889 of file doc.h.

SetLatencyStartMode() [1/3]

void wxStfCursorsDlg::SetLatencyStartMode

(

stf::latency_mode

latencyBegMode

)

Sets the latency mode of the left latency cursor.

Parameters

latencyBegMode

the new mode for the left latency cursor.

SetLatencyStartMode() [2/3]

void wxStfDoc::SetLatencyStartMode

(

int

value

)

Sets the mode of the latency start cursor.

Parameters

value

The new mode of the latency start cursor..

SetLatencyStartMode() [3/3]

void wxStfDoc::SetLatencyStartMode ( stf::latency_mode value )

inline

Sets the mode of the latency start cursor.

Parameters

value

The new mode of the latency start cursor.

Definition at line 884 of file doc.h.

SetLatencyWindowMode() [1/2]

void wxStfDoc::SetLatencyWindowMode

(

int

value

)

Sets the mode of the latency end cursor.

Parameters

value

The new mode of the latency end cursor..

SetLatencyWindowMode() [2/2]

void wxStfDoc::SetLatencyWindowMode ( stf::latency_window_mode value )

inline

Sets the mode of the latency end cursor.

Parameters

value

The new mode of the latency end cursor..

Definition at line 896 of file doc.h.

SetMeasCursor()

void wxStfDoc::SetMeasCursor

(

int

value

)

Sets the position of the measurement cursor (crosshair).

Parameters

value

The index of the measurement cursor within the current section.

SetMeasRuler()

void wxStfDoc::SetMeasRuler ( bool value )

inline

Sets whether the measurement cursor (crosshair) should be visible.

Parameters

value

is true if the ruler will be visible, false otherwirse..

Definition at line 776 of file doc.h.

SetMouseQual()

void wxStfParentFrame::SetMouseQual

(

stf::cursor_type

value

)

Sets the current mouse cursor mode.

Parameters

value

The new mouse cursor mode.

SetMRActiveDoc()

void wxStfApp::SetMRActiveDoc ( wxStfDoc * pDoc )

inline

Sets the currently active document.

Parameters

pDoc	A pointer to the currently active document.

Definition at line 431 of file app.h.

SetNoInput()

void wxStfFitSelDlg::SetNoInput ( bool noInput_ )

inline

Determines whether user-defined initial parameters are allowed.

Parameters

noInput_

Set to true if the user may set the initial parameters, false otherwise. Needed for batch analysis.

Definition at line 120 of file fitseldlg.h.

SetPeakAtEnd() [1/2]

void wxStfCursorsDlg::SetPeakAtEnd

(

bool

is_end

)

Sets whether the right peak cursor should be at the end of the trace.

Parameters

is_end

true if the peak cursor is at the end of the trace, false otherwise.

SetPeakAtEnd() [2/2]

void wxStfDoc::SetPeakAtEnd ( bool value )

inline

Sets the right peak cursor to the end of a trace.

Parameters

value

determines whether the peak cursor should be at the end of a trace.

Definition at line 204 of file doc.h.

SetPeakBeg()

void wxStfDoc::SetPeakBeg

(

int

value

)

Sets the position of the left peak cursor.

Parameters

value

The index of the left peak cursor within the current section.

SetPeakEnd()

void wxStfDoc::SetPeakEnd

(

int

value

)

Sets the position of the right peak cursor.

Parameters

value

The index of the right peak cursor within the current section.

SetPeakPoints()

void wxStfCursorsDlg::SetPeakPoints

(

int

peakPoints

)

Sets the number of points used for the binned average during peak detection.

Parameters

peakPoints

The number of points used for the binned average during peak detection.

SetPM()

void wxStfDoc::SetPM ( int value )

inline

Sets the number of points used for averaging during peak calculation.

Parameters

value

The number of points to be used.

Definition at line 873 of file doc.h.

SetRTFactor() [1/2]

void wxStfCursorsDlg::SetRTFactor

(

int

RTFactor

)

Set the lower value (e.g 20) to compute the rise-time. The high value is simply 100-lower value.

Parameters

RTFactor

is the lower value (e.g 20) .

SetRTFactor() [2/2]

void wxStfDoc::SetRTFactor

(

int

value

)

Sets the lower value (e.g 20) to calculate the rise time.

Parameters

value

The lower percentage (e.g 20) to be used to c calculate the rise time.

SetRuler()

void wxStfCursorsDlg::SetRuler

(

bool

value

)

Sets whether an additional vertical ruler should be drawn through the measurement cursor.

Parameters

value

true if an additional ruler should be drawn, false otherwise.

SetSection()

bool wxStfDoc::SetSection

(

std::size_t

section

)

Sets the current section to the specified value.

Checks for out-of-range errors

Parameters

section

The 0-based index of the new section

SetSelected()

void wxStfChildFrame::SetSelected

(

std::size_t

value

)

Refreshes the trace selection string.

Parameters

value

The number of selected traces.

SetSelectedButton()

void wxStfParentFrame::SetSelectedButton

(

bool

selected

)

Sets status of the toolbar's selection button.

Parameters

selected

The desired toggle status of the selection button.

SetSingleChannel()

void wxStfParentFrame::SetSingleChannel

(

bool

value

)

Set the zoom buttons to single- or multi-channel mode.

Parameters

value

Set to true for single- or false for multi-channel mode.

SetSlope()

void wxStfCursorsDlg::SetSlope

(

double

slope

)

Set the threshold slope.

Parameters

slope

The new threshold slope.

SetSlopeForThreshold()

void wxStfDoc::SetSlopeForThreshold ( double value )

inline

Sets the slope where the baseline should be set.

Parameters

value

The slope value where the baseline shoudl be set.

Definition at line 1015 of file doc.h.

SetSlopeUnits()

void wxStfCursorsDlg::SetSlopeUnits

(

const wxString &

units

)

Set the units of the slope.

Parameters

units

The units of the slope.

References units.

SetStartFitAtPeak() [1/2]

void wxStfCursorsDlg::SetStartFitAtPeak

(

bool

is_peak

)

Sets whether the left decay cursor should be at the peak of the trace.

Parameters

is_peak

true if the decay cursor is at the peak of the trace, false otherwise.

SetStartFitAtPeak() [2/2]

void wxStfDoc::SetStartFitAtPeak ( bool value )

inline

Sets the left decay cursor to the peak of the trace.

Parameters

value

determines whether the left decay cursor should be at the peak of the trace.

Definition at line 209 of file doc.h.

SetValue()

virtual void wxStfTable::SetValue ( int row, int col, const wxString & value )

virtual

Set a cell entry.

Parameters

row	The row number of the cell.
col	The column number of the cell.
value	The new cell entry.

SetViewBaseline()

void wxStfDoc::SetViewBaseline ( bool value )

inline

Determines whether the baseline value should be shown in the results table.

Parameters

value

Set to true if it should be shown, false otherwise.

Definition at line 933 of file doc.h.

SetViewBaseSD()

void wxStfDoc::SetViewBaseSD ( bool value )

inline

Determines whether the baseline's standard deviation should be shown in the results table.

Parameters

value

Set to true if it should be shown, false otherwise.

Definition at line 938 of file doc.h.

SetViewCrosshair()

void wxStfDoc::SetViewCrosshair ( bool value )

inline

Determines whether the measurement cursor (crosshair) value should be shown in the results table.

Parameters

value

Set to true if it should be shown, false otherwise.

Definition at line 928 of file doc.h.

SetViewCursors()

void wxStfDoc::SetViewCursors ( bool value )

inline

Determines whether two additional rows showing the positions of start and end cursors should be shown in the results table.

Parameters

value

Set to true if they should be shown, false otherwise.

Definition at line 1010 of file doc.h.

SetViewInnerRiseTime()

void wxStfDoc::SetViewInnerRiseTime ( bool value )

inline

Determines whether the inner rise time should be shown in the results table.

Parameters

value

Set to true if it should be shown, false otherwise.

Definition at line 968 of file doc.h.

SetViewLatency()

void wxStfDoc::SetViewLatency ( bool value )

inline

Determines whether the latency should be shown in the results table.

Parameters

value

Set to true if it should be shown, false otherwise.

Definition at line 998 of file doc.h.

SetViewOuterRiseTime()

void wxStfDoc::SetViewOuterRiseTime ( bool value )

inline

Determines whether the outer rise time should be shown in the results table.

Parameters

value

Set to true if it should be shown, false otherwise.

Definition at line 973 of file doc.h.

SetViewPeakBase()

void wxStfDoc::SetViewPeakBase ( bool value )

inline

Determines whether the peak value (measured from baseline) should be shown in the results table.

Parameters

value

Set to true if it should be shown, false otherwise.

Definition at line 953 of file doc.h.

SetViewPeakThreshold()

void wxStfDoc::SetViewPeakThreshold ( bool value )

inline

Determines whether the peak value (measured from threshold) should be shown in the results table.

Parameters

value

Set to true if it should be shown, false otherwise.

Definition at line 958 of file doc.h.

SetViewPeakZero()

void wxStfDoc::SetViewPeakZero ( bool value )

inline

Determines whether the peak value (measured from zero) should be shown in the results table.

Parameters

value

Set to true if it should be shown, false otherwise.

Definition at line 948 of file doc.h.

SetViewRD()

void wxStfDoc::SetViewRD ( bool value )

inline

Determines whether the ratio of the maximal slopes during rise and decay should be shown in the results table.

Parameters

value

Set to true if it should be shown, false otherwise.

Definition at line 983 of file doc.h.

SetViewRTLoHi()

void wxStfDoc::SetViewRTLoHi ( bool value )

inline

Determines whether the Lo to Hi% rise time should be shown in the results table.

Parameters

value

Set to true if it should be shown, false otherwise.

Definition at line 963 of file doc.h.

SetViewSlopeDecay()

void wxStfDoc::SetViewSlopeDecay ( bool value )

inline

Determines whether the maximal slope during the decaying phase should be shown in the results table.

Parameters

value

Set to true if it should be shown, false otherwise.

Definition at line 993 of file doc.h.

SetViewSlopeRise()

void wxStfDoc::SetViewSlopeRise ( bool value )

inline

Determines whether the maximal slope during the rising phase should be shown in the results table.

Parameters

value

Set to true if it should be shown, false otherwise.

Definition at line 988 of file doc.h.

SetViewT50()

void wxStfDoc::SetViewT50 ( bool value )

inline

Determines whether the half duration should be shown in the results table.

Parameters

value

Set to true if it should be shown, false otherwise.

Definition at line 978 of file doc.h.

SetViewThreshold()

void wxStfDoc::SetViewThreshold ( bool value )

inline

Determines whether the threshold should be shown in the results table.

Parameters

value

Set to true if it should be shown, false otherwise.

Definition at line 943 of file doc.h.

SetZoomQual()

void wxStfParentFrame::SetZoomQual

(

stf::zoom_channels

value

)

Set the channels that will be affected by scaling operations.

Parameters

value

The channels affected by scaling operations.

ShowAll()

bool wxStfChildFrame::ShowAll ( ) const

inline

Indicates whether all channels should be plotted.

Returns

true if they should be plotted, false otherwise.

Definition at line 170 of file childframe.h.

ShowSecond()

bool wxStfChildFrame::ShowSecond

(

)

Indicates whether the second channel should be plotted.

Returns

true if it should be plotted, false otherwise.

ShowSelected()

bool wxStfChildFrame::ShowSelected ( ) const

inline

Indicates whether all selected traces should be plotted.

Returns

true if they should be plotted, false otherwise.

Definition at line 160 of file childframe.h.

ShowTable()

void wxStfChildFrame::ShowTable	(	const stfnum::Table &	table,
		const wxString &	caption )

Adds a table to the results notebook.

Parameters

table	The table to be added.
caption	The title of the new table in the notebook.

Snapshotwmf()

void wxStfGraph::Snapshotwmf

(

)

Copies the drawing to the clipboard as a windows metafile.

Metafiles are only implemented in Windows. Some applications allow you to paste as an enhanced metafile (usually through "Edit -> Paste special..."); choose this option for best results.

SortScoringTraceByRawDetection()

std::vector< double > wxStfDoc::SortScoringTraceByRawDetection	(	std::vector< double > &	rawDetectionTrace,
		std::vector< int > &	scoringTrace )

SubtractBase()

bool wxStfDoc::SubtractBase

(

)

Subtracts the baseline of all selected traces.

Returns

true upon success, false otherwise.

ToggleSelect()

void wxStfDoc::ToggleSelect

(

)

Toggles the selection status of the current section.

ToSection()

bool wxStfTextImportDlg::ToSection ( ) const

inline

Indicates whether columns should be put into section or into channels.

Returns

true if they should be put into sections.

Definition at line 654 of file smalldlgs.h.

TransferDataFromWindow()

virtual bool wxStfCursorsDlg::TransferDataFromWindow ( )

virtual

Called when data should be transferred from the non-modal dialog (e.g. when OK is pressed)

Note that a non-modal dialog won't be destroyed when OK is clicked, it will only disappear from sight. This function will then apply the current cursor settings and update the results table.

Returns

The return value of the base class version wxWindow::TransferDataFromWindow()

UpdateChannels()

void wxStfChildFrame::UpdateChannels

(

)

Updates the channels according to the current combo boy selection.

UpdateCursors()

void wxStfCursorsDlg::UpdateCursors

(

)

Updates the cursor entries in the Cursors Settings menu.

UpdateResults()

void wxStfChildFrame::UpdateResults

(

)

Updates the results table.

Called from wxStfApp::OnPeakcalcexecMsg() to update the results table. Don't call this directly; use wxStfApp::OnPeakcalcexecMsg() instead.

UpdateSelectedButton()

void wxStfDoc::UpdateSelectedButton

(

)

Updates the status of the selection button.

UseReference()

bool wxStfAlignDlg::UseReference ( ) const

inline

Indicates whether the reference channel should be used for alignment.

Returns

true if the reference channel should be used, false if the active channel should be used

Definition at line 169 of file smalldlgs.h.

UseScaling()

bool wxStfFitSelDlg::UseScaling ( ) const

inline

Scale x- and y-amplitudes to 1.0 before fit.

Returns

True if scaling should be used

Definition at line 114 of file fitseldlg.h.

ViewResults()

void wxStfGrid::ViewResults

(

)

Updates the context menu.

Width()

double wxStfGaussianDlg::Width ( ) const

inline

Get the width of the Gaussian.

Returns

The width of the Gaussian.

Definition at line 569 of file smalldlgs.h.

wxGetApp()

StfDll wxStfApp & wxGetApp ( )

extern

Returns a reference to the application.

References singleWindowMode, and StfDll.

wxGetProfileInt()

int wxStfApp::wxGetProfileInt	(	const wxString &	main,
		const wxString &	sub,
		int	default_ ) const

Retrieves an integer value from the configuration.

Parameters

main	The main path within the configuration.
sub	The sub-path within the configuration.
default_	The default integer to return if the configuration entry can't be read.

Returns

The integer that is stored in /main/sub, or default_ if the entry couldn't be read.

wxGetProfileString()

wxString wxStfApp::wxGetProfileString	(	const wxString &	main,
		const wxString &	sub,
		const wxString &	default_ ) const

Retrieves a string from the configuration.

Parameters

main	The main path within the configuration.
sub	The sub-path within the configuration.
default_	The default string to return if the configuration entry can't be read.

Returns

The string that is stored in /main/sub, or default_ if the entry couldn't be read.

wxStfAlignDlg()

wxStfAlignDlg::wxStfAlignDlg	(	wxWindow *	parent,
		bool	hasReference,
		int	id = wxID_ANY,
		wxString	title = wxT("Alignment mode"),
		wxPoint	pos = wxDefaultPosition,
		wxSize	size = wxDefaultSize,
		int	style = wxCAPTION )

Constructor.

Parameters

parent	Pointer to parent window.
id	Window id.
title	Dialog title.
pos	Initial position.
size	Initial size.
style	Dialog style.

References size.

wxStfApp()

wxStfApp::wxStfApp

(

)

Constructor.

wxStfBatchDlg()

wxStfBatchDlg::wxStfBatchDlg	(	wxWindow *	parent,
		int	id = wxID_ANY,
		wxString	title = wxT("Choose values"),
		wxPoint	pos = wxDefaultPosition,
		wxSize	size = wxDefaultSize,
		int	style = wxCAPTION )

Constructor.

Parameters

parent	Pointer to parent window.
id	Window id.
title	Dialog title.
pos	Initial position.
size	Initial size.
style	Dialog style.

References size.

wxStfChannelSelDlg()

wxStfChannelSelDlg::wxStfChannelSelDlg	(	wxWindow *	parent,
		const std::vector< wxString > &	channelNames = std::vector< wxString >(0),
		int	id = wxID_ANY,
		wxString	title = wxT("Select channels"),
		wxPoint	pos = wxDefaultPosition,
		wxSize	size = wxDefaultSize,
		int	style = wxCAPTION )

Constructor.

Parameters

parent	Pointer to parent window.
channelNames	A vector containing the channel names.
id	Window id.
title	Dialog title.
pos	Initial position.
size	Initial size.
style	Dialog style.

References size.

wxStfChildFrame()

wxStfChildFrame::wxStfChildFrame	(	wxDocument *	doc,
		wxView *	view,
		wxStfParentType *	parent,
		wxWindowID	id,
		const wxString &	title,
		const wxPoint &	pos = wxPoint(48, 48),
		const wxSize &	size = wxDefaultSize,
		long	style = wxDEFAULT_FRAME_STYLE,
		const wxString &	name = wxT("frame") )

Constructor.

Parameters

doc	Pointer to the attached document.
view	Pointer to the attached view.
parent	Pointer to the parent frame.
id	Window id.
title	Window title string.
pos	Initial window position.
size	Initial window size.
style	Window style.
name	Name of this frame.

References size.

wxStfConvertDlg()

wxStfConvertDlg::wxStfConvertDlg	(	wxWindow *	parent,
		int	id = wxID_ANY,
		wxString	title = wxT("Convert file series"),
		wxPoint	pos = wxDefaultPosition,
		wxSize	size = wxDefaultSize,
		int	style = wxCAPTION )

Constructor.

Parameters

parent	Pointer to parent window.
id	Window id.
title	Dialog title.
pos	Initial position.
size	Initial size.
style	Dialog style.

References size.

wxStfCursorsDlg()

wxStfCursorsDlg::wxStfCursorsDlg	(	wxWindow *	parent,
		wxStfDoc *	initDoc,
		int	id = wxID_ANY,
		wxString	title = wxT("Cursor settings"),
		wxPoint	pos = wxDefaultPosition,
		wxSize	size = wxDefaultSize,
		int	style = wxCAPTION )

Constructor.

Parameters

parent	Pointer to parent window.
initDoc	Pointer to the document the call originated from.
id	Window id.
title	Dialog title.
pos	Initial position.
size	Initial size.
style	Dialog style.

References size.

wxStfDoc()

wxStfDoc::wxStfDoc

(

)

Constructor.

Does nothing but initialising the member list.

Referenced by CopyCursors(), and SetData().

wxStfEventDlg()

wxStfEventDlg::wxStfEventDlg	(	wxWindow *	parent,
		const std::vector< stf::SectionPointer > &	templateSections,
		bool	isExtract,
		int	id = wxID_ANY,
		wxString	title = wxT("Event detection settings"),
		wxPoint	pos = wxDefaultPosition,
		wxSize	size = wxDefaultSize,
		int	style = wxCAPTION )

Constructor.

Parameters

parent	Pointer to parent window.
templateSections	A vector of pointers to sections that contain fits which might be used as a template.
isExtract	true if events are to be detected for later extraction (rather than just plotting the detection criterion or
id	Window id.
title	Dialog title.
pos	Initial position.
size	Initial size.
style	Dialog style.

References size.

wxStfFileInfoDlg()

wxStfFileInfoDlg::wxStfFileInfoDlg	(	wxWindow *	parent,
		const std::string &	szGeneral,
		const std::string &	szFile,
		const std::string &	szSection,
		int	id = wxID_ANY,
		wxString	title = wxT("File information"),
		wxPoint	pos = wxDefaultPosition,
		wxSize	size = wxDefaultSize,
		int	style = wxCAPTION )

Constructor.

Parameters

parent	Pointer to parent window.
szGeneral	General information.
szFile	File variables information.
szSection	Section variable information.
id	Window id.
title	Dialog title.
pos	Initial position.
size	Initial size.
style	Dialog style.

References size.

wxStfFilterSelDlg()

wxStfFilterSelDlg::wxStfFilterSelDlg	(	wxWindow *	parent,
		int	id = wxID_ANY,
		wxString	title = wxT("Filter function"),
		wxPoint	pos = wxDefaultPosition,
		wxSize	size = wxDefaultSize,
		int	style = wxCAPTION )

Constructor.

Parameters

parent	Pointer to parent window.
id	Window id.
title	Dialog title.
pos	Initial position.
size	Initial size.
style	Dialog style.

References size.

wxStfFitInfoDlg()

wxStfFitInfoDlg::wxStfFitInfoDlg	(	wxWindow *	parent,
		const wxString &	info,
		int	id = wxID_ANY,
		wxString	title = wxT("Fit information"),
		wxPoint	pos = wxDefaultPosition,
		wxSize	size = wxDefaultSize,
		int	style = wxCAPTION )

Constructor.

Parameters

parent	Pointer to parent window.
info	A string containing information about the fit.
id	Window id.
title	Dialog title.
pos	Initial position.
size	Initial size.
style	Dialog style.

References size.

wxStfFitSelDlg()

wxStfFitSelDlg::wxStfFitSelDlg	(	wxWindow *	parent,
		wxStfDoc *	doc,
		int	id = wxID_ANY,
		wxString	title = wxT("Non-linear regression"),
		wxPoint	pos = wxDefaultPosition,
		wxSize	size = wxDefaultSize,
		int	style = wxCAPTION )

Constructor.

Parameters

parent	Pointer to parent window.
doc	Pointer to the document the call originated from.
id	Window id.
title	Dialog title.
pos	Initial position.
size	Initial size.
style	Dialog style.

References size.

wxStfGaussianDlg()

wxStfGaussianDlg::wxStfGaussianDlg	(	wxWindow *	parent,
		int	id = wxID_ANY,
		wxString	title = wxT("Settings for Gaussian function"),
		wxPoint	pos = wxDefaultPosition,
		wxSize	size = wxDefaultSize,
		int	style = wxCAPTION )

Constructor.

Parameters

parent	Pointer to parent window.
id	Window id.
title	Dialog title.
pos	Initial position.
size	Initial size.
style	Dialog style.

References size.

wxStfGraph()

wxStfGraph::wxStfGraph	(	wxView *	v,
		wxStfChildFrame *	frame,
		const wxPoint &	pos,
		const wxSize &	size,
		long	style )

Constructor.

Parameters

v	is a pointer to the attached wxView.
frame	is a pointer to the attached child frame.
pos	and
size	indicate the initial position and size of this frame.
style	is the window style.

References size.

wxStfGrid()

wxStfGrid::wxStfGrid	(	wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = wxWANTS_CHARS,
		const wxString &	name = wxGridNameStr )

Constructor.

Parameters

parent	Pointer to the parent window.
id	Window id.
pos	Initial window position.
size	Initial window size.
style	Grid style.
name	Name of this grid.

References size.

wxStfOrderChannelsDlg()

wxStfOrderChannelsDlg::wxStfOrderChannelsDlg	(	wxWindow *	parent,
		const std::vector< wxString > &	channelNames = std::vector< wxString >(0),
		int	id = wxID_ANY,
		wxString	title = wxT("Re-order channels"),
		wxPoint	pos = wxDefaultPosition,
		wxSize	size = wxDefaultSize,
		int	style = wxCAPTION )

Constructor.

Parameters

parent	Pointer to parent window.
channelNames	A vector containing channel names.
id	Window id.
title	Dialog title.
pos	Initial position.
size	Initial size.
style	Dialog style.

References size.

wxStfParentFrame()

wxStfParentFrame::wxStfParentFrame	(	wxDocManager *	manager,
		wxFrame *	frame,
		const wxString &	title,
		const wxPoint &	pos,
		const wxSize &	size,
		long	style )

Constructor.

Parameters

manager	Pointer to the document manager.
frame	Pointer to the parent frame (should be NULL, because this is the top-level frame
title	Title of this frame.
pos	Initial position of this frame.
size	Initial size of this frame.
style	Window style.

References size.

wxStfPreprintDlg()

wxStfPreprintDlg::wxStfPreprintDlg	(	wxWindow *	parent,
		bool	isFile = false,
		int	id = wxID_ANY,
		wxString	title = wxT("Settings"),
		wxPoint	pos = wxDefaultPosition,
		wxSize	size = wxDefaultSize,
		int	style = wxCAPTION )

Constructor.

Parameters

parent	Pointer to parent window.
isFile	Set this to true if something should be printed to a file.
id	Window id.
title	Dialog title.
pos	Initial position.
size	Initial size.
style	Dialog style.

References size.

wxStfPrintout()

wxStfPrintout::wxStfPrintout

(

const wxChar *

title = _T("Printout")

)

Constructor.

Parameters

title

Printout title

wxStfTable()

wxStfTable::wxStfTable ( const stfnum::Table & table_ )

inline

Constructor.

Parameters

table_

The associated stfnum::Table

Definition at line 36 of file table.h.

wxStfTextImportDlg()

wxStfTextImportDlg::wxStfTextImportDlg	(	wxWindow *	parent,
		const wxString &	textPreview = wxT("\0"),
		int	hLines_ = 1,
		bool	isSeries = false,
		int	id = wxID_ANY,
		wxString	title = wxT("Text file import settings"),
		wxPoint	pos = wxDefaultPosition,
		wxSize	size = wxDefaultSize,
		int	style = wxCAPTION )

Constructor.

Parameters

parent	Pointer to parent window.
textPreview	The preview text to be shown.
hLines_	The number of header lines that are initially set.
isSeries	Set this to true for file series so that they can be batch-opened.
id	Window id.
title	Dialog title.
pos	Initial position.
size	Initial size.
style	Dialog style.

References size.

wxStfTransformDlg()

wxStfTransformDlg::wxStfTransformDlg	(	wxWindow *	parent,
		int	id = wxID_ANY,
		wxString	title = wxT("Choose function"),
		wxPoint	pos = wxDefaultPosition,
		wxSize	size = wxDefaultSize,
		int	style = wxCAPTION )

Constructor.

Parameters

parent	Pointer to parent window.
id	Window id.
title	Dialog title.
pos	Initial position.
size	Initial size.
style	Dialog style.

References size.

wxStfView()

wxStfView::wxStfView

(

)

Constructor.

Referenced by OnActivateView().

wxWriteProfileInt()

void wxStfApp::wxWriteProfileInt	(	const wxString &	main,
		const wxString &	sub,
		int	value ) const

Writes an integer value to the configuration.

Parameters

main	The main path within the configuration.
sub	The sub-path within the configuration.
value	The integer to write to the configuration.

wxWriteProfileString()

void wxStfApp::wxWriteProfileString	(	const wxString &	main,
		const wxString &	sub,
		const wxString &	value ) const

Writes a string to the configuration.

Parameters

main	The main path within the configuration.
sub	The sub-path within the configuration.
value	The string to write to the configuration.

~wxStfChildFrame()

wxStfChildFrame::~wxStfChildFrame

(

)

Destructor.

~wxStfDoc()

wxStfDoc::~wxStfDoc

(

)

Destructor.

~wxStfParentFrame()

wxStfParentFrame::~wxStfParentFrame

(

)

Destructor.

~wxStfView()

wxStfView::~wxStfView ( )

inline

Destructor.

Definition at line 44 of file view.h.

Variable Documentation

cppWindow

wxWindow* new_wxwindow::cppWindow

Definition at line 47 of file parentframe.h.

Referenced by new_wxwindow().

defaultPersp

const wxString defaultPersp

Initial value:

=
wxT("layout2| \
name=Results;caption=Results;state=2044;dir=1;layer=0;row=0;pos=1;prop=167270; \
bestw=200;besth=184;minw=-1;minh=-1;maxw=-1;maxh=-1;floatx=-1;floaty=-1;floatw=-1;floath=-1| \
name=Selection;caption=Trace selection;state=2044;dir=1;layer=0;row=0;pos=0;prop=32730; \
bestw=128;besth=64;minw=-1;minh=-1;maxw=-1;maxh=-1;floatx=-1;floaty=-1;floatw=-1;floath=-1| \
name=Traces;caption=Traces;state=18428;dir=5;layer=0;row=0;pos=0;prop=100000; \
bestw=20;besth=20;minw=-1;minh=-1;maxw=-1;maxh=-1;floatx=-1;floaty=-1;floatw=-1;floath=-1|")

Default perspective string.

Can be loaded to restore the default AUI perspective.

Definition at line 42 of file childframe.h.

index

int BatchOption::index

Checkbox status.

Definition at line 310 of file smalldlgs.h.

Referenced by BatchOption(), and BatchOption().

label

wxString BatchOption::label

Definition at line 308 of file smalldlgs.h.

Referenced by BatchOption(), and BatchOption().

pyWindow

PyObject* new_wxwindow::pyWindow

Definition at line 48 of file parentframe.h.

Referenced by new_wxwindow().

selection

bool BatchOption::selection

Checkbox label.

Definition at line 309 of file smalldlgs.h.

Referenced by BatchOption(), and BatchOption().

singleWindowMode

bool singleWindowMode

extern

true if in single-window mode

Referenced by wxGetApp().

view

wxStfView* wxStfGraph::view

Returns the current zoom struct.

Returns

the current zoom struct. Sets the current zoom struct.

Parameters

zoom_

The current zoom struct. The view attached to this wxStfGraph.

Definition at line 262 of file graph.h.