Stimfit  0.13.15
Public Member Functions

Dialog for event-detection settings. More...

#include <eventdlg.h>

Inheritance diagram for wxStfEventDlg:
Inheritance graph
[legend]
Collaboration diagram for wxStfEventDlg:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 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 GetThreshold () const
 Get the event detection threshold.
stf::extraction_mode GetMode () const
 Indicates the selected extraction algorithm.
int GetMinDistance () const
 Get the minimal distance between events.
int GetTemplate () const
 Get the selected template.
virtual void EndModal (int retCode)
 Called upon ending a modal dialog.

Detailed Description

Dialog for event-detection settings.

Definition at line 33 of file eventdlg.h.


Constructor & Destructor Documentation

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:
parentPointer to parent window.
templateSectionsA vector of pointers to sections that contain fits which might be used as a template.
isExtracttrue if events are to be detected for later extraction (rather than just plotting the detection criterion or
idWindow id.
titleDialog title.
posInitial position.
sizeInitial size.
styleDialog style.

Member Function Documentation

virtual void wxStfEventDlg::EndModal ( int  retCode) [virtual]

Called upon ending a modal dialog.

Parameters:
retCodeThe dialog button id that ended the dialog (e.g. wxID_OK)
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 90 of file eventdlg.h.

Indicates the selected extraction algorithm.

Returns:
The extraction algorithm.

Definition at line 85 of file eventdlg.h.

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 95 of file eventdlg.h.

double wxStfEventDlg::GetThreshold ( ) const [inline]

Get the event detection threshold.

Returns:
The event detection threshold.

Definition at line 80 of file eventdlg.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines