wxStfCursorsDlg Class Reference

Cursor settings non-modal dialog. More...

#include <cursorsdlg.h>

Inheritance diagram for wxStfCursorsDlg:

Collaboration diagram for wxStfCursorsDlg:

List of all members.

Public Member Functions
	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	EndModal (int retCode)
	Called upon ending a modal dialog.
virtual bool	TransferDataFromWindow ()
	Called when data should be transferred from the non-modal dialog (e.g. when OK is pressed)
int	GetCursorM () const
	Get the measurement cursor x-position.
int	GetCursor1P () const
	Get the left peak cursor x-position.
int	GetCursor2P () const
	Get the right peak cursor x-position.
int	GetCursor1B () const
	Get the left base cursor x-position.
int	GetCursor2B () const
	Get the right base cursor x-position.
int	GetCursor1D () const
	Get the left fit cursor x-position.
int	GetCursor2D () const
	Get the right fit cursor x-position.
int	GetCursor1L () const
	Get the left latency cursor x-position.
int	GetCursor2L () const
	Get the right latency cursor x-position.
int	GetPeakPoints () const
	Gets the number of points used for the binned average during peak detection.
int	GetRTFactor () const
	Gets the lower factor (e.g 20) used to calculate the rise time.
void	SetPeakPoints (int peakPoints)
	Sets the number of points used for the binned average during peak detection.
void	SetRTFactor (int RTFactor)
	Set the lower value (e.g 20) to compute the rise-time. The high value is simply 100-lower value.
int	GetDeltaT () const
	Gets the distance to the first PSlope cursor in number of points.
void	SetDeltaT (int DeltaT)
	Sets the number of points used for the distance from the first PSlope cursor.
stf::direction	GetDirection () const
	Gets the direction of peak calculations.
stf::latency_mode	GetLatencyStartMode () const
	Gets the mode of Latency for the beginning of the latency cursor.
stf::latency_mode	GetLatencyEndMode () const
	Gets the mode of Latency of the last latency cursor.
void	SetLatencyStartMode (stf::latency_mode latencyBegMode)
	Sets the latency mode of the left latency cursor.
void	SetLatencyEndMode (stf::latency_mode latencyEndMode)
	Sets the latency mode of the right latency cursor.
bool	UsePeak4Latency () const
	Indicates whether latency measurements should be taken within the current peak cursors.
void	SetPeak4Latency (int val)
	Sets the latency measurements to current peak cursors.
bool	GetFromBase () const
	Indicates whether to use the baseline as a reference for AP kinetics.
void	SetDirection (stf::direction direction)
	Sets the direction of peak calculations.
void	SetFromBase (bool frombase)
	Sets the reference for AP kinetics measurements.
bool	GetPeakAtEnd () const
	Indicates whether the right peak cursor should always be at the end of the trace.
bool	GetStartFitAtPeak () const
	Indicates whether to always start a fit at the current peak position.
void	UpdateCursors ()
	Updates the cursor entries in the Cursors Settings menu.
stf::cursor_type	CurrentCursor () const
	Retrieve the current cursor notebook page.
double	GetSlope () const
	Get the slope at which the baseline should be fixed.
void	SetSlope (double slope)
	Set the threshold slope.
void	SetSlopeUnits (const wxString &units)
	Set the units of the slope.
bool	GetBaseToSlope () const
	Indicates whether the baseline should be fixed to a certain slope.
bool	GetRuler () const
	Indicates whether an additional vertical ruler should be drawn through the baseline.
void	SetActiveDoc (wxStfDoc *actDoc_)
	Sets the currently active document.

---

Detailed Description

Cursor settings non-modal dialog.

Definition at line 34 of file cursorsdlg.h.

---

Constructor & Destructor Documentation

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.

---

Member Function Documentation

stf::cursor_type wxStfCursorsDlg::CurrentCursor

(

)

const

Retrieve the current cursor notebook page.

Returns:

The cursor corresponding to the currently selected notebook page.

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)

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.

int wxStfCursorsDlg::GetCursor1B

(

)

const

Get the left base cursor x-position.

Returns:

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

int wxStfCursorsDlg::GetCursor1D

(

)

const

Get the left fit cursor x-position.

Returns:

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

int wxStfCursorsDlg::GetCursor1L

(

)

const

Get the left latency cursor x-position.

Returns:

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

int wxStfCursorsDlg::GetCursor1P

(

)

const

Get the left peak cursor x-position.

Returns:

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

int wxStfCursorsDlg::GetCursor2B

(

)

const

Get the right base cursor x-position.

Returns:

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

int wxStfCursorsDlg::GetCursor2D

(

)

const

Get the right fit cursor x-position.

Returns:

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

int wxStfCursorsDlg::GetCursor2L

(

)

const

Get the right latency cursor x-position.

Returns:

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

int wxStfCursorsDlg::GetCursor2P

(

)

const

Get the right peak cursor x-position.

Returns:

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

int wxStfCursorsDlg::GetCursorM

(

)

const

Get the measurement cursor x-position.

Returns:

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

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.

stf::direction wxStfCursorsDlg::GetDirection

(

)

const

Gets the direction of peak calculations.

Returns:

The current direction of peak calculations.

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.

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.

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.

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.

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.

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.

bool wxStfCursorsDlg::GetRuler

(

)

const

Indicates whether an additional vertical ruler should be drawn through the baseline.

Returns:

true if an additional ruler should be drawn.

double wxStfCursorsDlg::GetSlope

(

)

const

Get the slope at which the baseline should be fixed.

Returns:

The slope at which the baseline should be fixed.

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.

void wxStfCursorsDlg::SetActiveDoc

(

wxStfDoc *

actDoc_

)

[inline]

Sets the currently active document.

Parameters:

actDoc_

A pointer to the currently active document.

Definition at line 347 of file cursorsdlg.h.

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.

void wxStfCursorsDlg::SetDirection

(

stf::direction

direction

)

Sets the direction of peak calculations.

Parameters:

direction

The new direction of peak calculations.

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.

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.

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.

void wxStfCursorsDlg::SetPeak4Latency

(

int

val

)

Sets the latency measurements to current peak cursors.

Parameters:

val.

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.

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) .

void wxStfCursorsDlg::SetSlope

(

double

slope

)

Set the threshold slope.

Parameters:

slope

The new threshold slope.

void wxStfCursorsDlg::SetSlopeUnits

(

const wxString &

units

)

Set the units of the slope.

Parameters:

units

The units of the slope.

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()

bool wxStfCursorsDlg::UsePeak4Latency

(

)

const

Indicates whether latency measurements should be taken within the current peak cursors.

Returns:

true if latency measurement is taken within the peak cursors.

---

The documentation for this class was generated from the following file:

• /git/stimfit/src/stimfit/gui/dlgs/cursorsdlg.h