The document class, derived from both wxDocument and Recording. More...

#include <doc.h>

Inheritance diagram for wxStfDoc:

Collaboration diagram for wxStfDoc:

Public Member Functions
	wxStfDoc ()
	Constructor.
	~wxStfDoc ()
	Destructor.
void	OnSwapChannels (wxCommandEvent &event)
	Swaps active and inactive channel.
virtual bool	OnOpenDocument (const wxString &filename)
	Override default file opening.
virtual bool	OnOpenPyDocument (const wxString &filename)
	Open document without progress dialog.
virtual bool	SaveAs ()
	Override default file saving.
virtual bool	DoSaveDocument (const wxString &filename)
	Override default file saving.
virtual bool	OnCloseDocument ()
	Override default file closing.
virtual bool	OnNewDocument ()
	Override default file creation.
void	SetData (const Recording &c_Data, const wxStfDoc *Sender, const wxString &title)
	Sets the content of a newly created file.
bool	GetIsAverage () const
	Indicates whether an average has been created.
bool	GetPeakAtEnd () const
	Indicates whether the right peak cursor should always be at the end of a trace.
bool	IsInitialized () const
	Indicates whether the the document is fully initialised.
void	SetPeakAtEnd (bool value)
	Sets the right peak cursor to the end of a trace.
const Recording &	GetAverage () const
	Retrieves the average trace(s).
void	CheckBoundaries ()
	Checks whether any cursor is reversed or out of range and corrects it if required.
bool	SetSection (std::size_t section)
	Sets the current section to the specified value.
bool	OnNewfromselectedThis ()
	Creates a new window containing the selected sections of this file.
void	Selectall (wxCommandEvent &event)
	Selects all sections.
void	Deleteselected (wxCommandEvent &event)
	Unselects all sections.
void	UpdateSelectedButton ()
	Updates the status of the selection button.
void	CreateAverage (bool calcSD, bool align)
	Creates an average trace from the selected sections.
void	ToggleSelect ()
	Toggles the selection status of the current section.
void	Select ()
	Selects the current section if previously unselected.
void	Remove ()
	Unselects the current section if previously selected.
void	Extract (wxCommandEvent &event)
	Creates a new document from the checked events.
void	InteractiveEraseEvents (wxCommandEvent &event)
	Erases all events, independent of whether they are checked or not.
void	AddEvent (wxCommandEvent &event)
	Adds an event at the current eventPos.
bool	SubtractBase ()
	Subtracts the baseline of all selected traces.
void	FitDecay (wxCommandEvent &event)
	Fit a function to the data.
void	SetFileMenu (wxMenu *menu)
	Sets a pointer to the file menu attached to this document.
void	Measure ()
	Measure everything using functions defined in measlib.h.
stf::Table	CurResultsTable ()
	Put the current measurement results into a text table.
std::size_t	GetCurCh () const
	Retrieves the index of the current channel.
std::size_t	GetSecCh () const
	Retrieves the index of the second channel.
std::size_t	GetCurSec () const
	Retrieves the index of the current section.
std::size_t	GetMeasCursor () const
	Retrieves the position of the measurement cursor (crosshair).
std::size_t	GetBaseBeg () const
	Retrieves the position of the left baseline cursor.
std::size_t	GetBaseEnd () const
	Retrieves the position of the right baseline cursor.
std::size_t	GetPeakBeg () const
	Retrieves the position of the left peak cursor.
std::size_t	GetPeakEnd () const
	Retrieves the position of the right peak cursor.
std::size_t	GetFitBeg () const
	Retrieves the position of the left fitting cursor.
std::size_t	GetFitEnd () const
	Retrieves the position of the right fitting cursor.
int	GetPM () const
	Retrieves the number of points used for averaging during peak calculation.
double	GetLatencyBeg () const
	Retrieves the position of the left latency cursor.
double	GetLatencyEnd () const
	Retrieves the position of the right latency cursor.
double	GetLatency () const
	Retrieves the latency.
double	GetTLoReal () const
	Retrieves the time point at which Lo% of the maximal amplitude have been reached.
double	GetTHiReal () const
	Retrieves the time point at which Hi% of the maximal amplitude have been reached.
double	GetT50LeftReal () const
	Retrieves the time point at which 50% of the maximal amplitude have been reached from the left of the peak.
double	GetT50RightReal () const
	Retrieves the time point at which 50% of the maximal amplitude have been reached from the right of the peak.
double	GetT50Y () const
	Retrieves the y value at 50% of the maximal amplitude.
double	GetMaxRise () const
	Retrieves the maximal slope of the rising phase.
double	GetMaxDecay () const
	Retrieves the maximal slope of the decaying phase.
double	GetAPMaxRiseT () const
	Retrieves the time point of the maximal slope of the rising phase in the second channel.
double	GetAPMaxT () const
	Retrieves the time point of the peak in the second channel.
double	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	GetMaxRiseT () const
	Retrieves the time point of the maximal slope during the rising phase.
double	GetMaxRiseY () const
	Retrieves the y-value at the time point of the maximal slope during the rising phase.
double	GetMaxDecayT () const
	Retrieves the time point of the maximal slope during the decaying phase.
double	GetMaxDecayY () const
	Retrieves the y-value at the time point of the maximal slope during the decaying phase.
double	GetMeasValue ()
	Retrieves the y-value at the measurement cursor (crosshair). Will update measCursor if out of range.
double	GetPeak () const
	Retrieves the peak value.
double	GetBase () const
	Retrieves the baseline.
double	GetAPBase () const
	Retrieves the baseline in the second channel.
double	GetBaseSD () const
	Retrieves the standard deviation of the baseline.
double	GetThreshold () const
	Retrieves the value at which the threshold slope is crossed.
double	GetMaxT () const
	Retrieves the time point at which the peak is found.
double	GetThrT () const
	Retrieves the time point at which the threshold slope is crossed.
double	GetRTLoHi () const
	Retrieves the Lo to Hi% rise time.
double	GetHalfDuration () const
	Retrieves the full width at half-maximal amplitude ("half duration").
double	GetSlopeRatio () const
	Retrieves ratio of the maximal slopes during the rising and decaying phase.
int	GetRTFactor () const
	Retrieves lower factor (e.g 20) for the rise time calculation.
double	GetPSlope () const
	Retrieves the value of the Slope.
stf::latency_mode	GetLatencyStartMode () const
	Retrieves the mode of the latency start cursor.
stf::latency_mode	GetLatencyEndMode () const
	Retrieves the mode of the latency end cursor.
stf::latency_window_mode	GetLatencyWindowMode () const
	Retrieves the mode of the latency window.
stf::direction	GetDirection () const
	Retrieves the direction of peak calculations.
bool	GetFromBase () const
	Indicates whether to use the baseline as a reference for AP kinetics.
bool	GetViewCrosshair () const
	Indicates whether the measurement cursor (crosshair) value should be shown in the results table.
bool	GetViewBaseline () const
	Indicates whether the baseline value should be shown in the results table.
bool	GetViewBaseSD () const
	Indicates whether the baseline's standard deviation should be shown in the results table.
bool	GetViewThreshold () const
	Indicates whether the threshold should be shown in the results table.
bool	GetViewPeakZero () const
	Indicates whether the peak value (measured from zero) should be shown in the results table.
bool	GetViewPeakBase () const
	Indicates whether the peak value (measured from baseline) should be shown in the results table.
bool	GetViewPeakThreshold () const
	Indicates whether the peak value (measured from threshold) should be shown in the results table.
bool	GetViewRTLoHi () const
	Indicates whether the Lo to Hi% rise time should be shown in the results table.
bool	GetViewT50 () const
	Indicates whether the half duration should be shown in the results table.
bool	GetViewRD () const
	Indicates whether the ratio of the maximal slopes during rise and decay should be shown in the results table.
bool	GetViewSlopeRise () const
	Indicates whether the maximal slope during the rising phase should be shown in the results table.
bool	GetViewSlopeDecay () const
	Indicates whether the maximal slope during the decaying phase should be shown in the results table.
bool	GetViewLatency () const
	Indicates whether the latency should be shown in the results table.
bool	GetViewCursors () const
	Indicates whether two additional rows showing the positions of start and end cursors should be shown in the results table.
double	GetSlopeForThreshold () const
	Returns the slope for threshold detection.
const std::vector< std::size_t > &	GetSelectedSections () const
	Retrieves the indices of the selected sections (read-only).
std::vector< std::size_t > &	GetSelectedSectionsW ()
	Retrieves the indices of the selected sections (read and write).
const Vector_double &	GetSelectBase () const
	Retrieves the stored baseline values of the selected sections (read-only).
Vector_double &	GetSelectBaseW ()
	Retrieves the stored baseline values of the selected sections (read and write).
const Section &	cur () const
	Retrieves the currently accessed section in the active channel (read-only)
Section &	cur ()
	Retrieves the currently accessed section in the active channel (read and write)
const Section &	sec () const
	Retrieves the currently accessed section in the second (reference) channel (read-only)
const XZoom &	GetXZoom ()
	Returns the current zoom settings for this channel (read-only).
XZoom &	GetXZoomW ()
	Returns the current zoom settings for this channel (read & write).
const YZoom &	GetYZoom (int ch)
	Returns the current zoom settings for this channel (read-only).
YZoom &	GetYZoomW (int ch)
	Returns the current zoom settings for this channel (read & write).
void	SetCurCh (std::size_t value)
	Sets the index of the current channel.
void	SetSecCh (std::size_t value)
	Sets the index of the second channel.
void	SetCurSec (std::size_t value)
	Sets the index of the current section.
void	SelectTrace (std::size_t sectionToSelect)
	Selects a section.
bool	UnselectTrace (std::size_t sectionToUnselect)
	Unselects a section if it was selected before.
void	SetMeasCursor (int value)
	Sets the position of the measurement cursor (crosshair).
void	SetBaseBeg (int value)
	Sets the position of the left baseline cursor.
void	SetBaseEnd (int value)
	Sets the position of the right baseline cursor.
void	SetPeakBeg (int value)
	Sets the position of the left peak cursor.
void	SetPeakEnd (int value)
	Sets the position of the right peak cursor.
void	SetFitBeg (int value)
	Sets the position of the left fitting cursor.
void	SetFitEnd (int value)
	Sets the position of the right fitting cursor.
void	SetLatencyBeg (double value)
	Sets the position of the left latency cursor.
void	SetLatencyEnd (double value)
	Sets the position of the right latency cursor.
void	SetLatency (double value)
	Sets the latency.
void	SetPM (int value)
	Sets the number of points used for averaging during peak calculation.
void	SetRTFactor (int value)
	Sets the lower value (e.g 20) to calculate the rise time.
void	SetLatencyStartMode (stf::latency_mode value)
	Sets the mode of the latency start cursor.
void	SetLatencyEndMode (stf::latency_mode value)
	Sets the mode of the latency end cursor.
void	SetLatencyWindowMode (stf::latency_window_mode value)
	Sets the mode of the latency end cursor.
void	SetLatencyStartMode (int value)
	Sets the mode of the latency start cursor.
void	SetLatencyEndMode (int value)
	Sets the mode of the latency end cursor.
void	SetLatencyWindowMode (int value)
	Sets the mode of the latency end cursor.
void	SetDirection (stf::direction value)
	Sets the direction of peak calculations.
void	SetFromBase (bool frombase)
	Sets the reference for AP kinetics measurements.
void	SetViewCrosshair (bool value)
	Determines whether the measurement cursor (crosshair) value should be shown in the results table.
void	SetViewBaseline (bool value)
	Determines whether the baseline value should be shown in the results table.
void	SetViewBaseSD (bool value)
	Determines whether the baseline's standard deviation should be shown in the results table.
void	SetViewThreshold (bool value)
	Determines whether the threshold should be shown in the results table.
void	SetViewPeakZero (bool value)
	Determines whether the peak value (measured from zero) should be shown in the results table.
void	SetViewPeakBase (bool value)
	Determines whether the peak value (measured from baseline) should be shown in the results table.
void	SetViewPeakThreshold (bool value)
	Determines whether the peak value (measured from threshold) should be shown in the results table.
void	SetViewRTLoHi (bool value)
	Determines whether the Lo to Hi% rise time should be shown in the results table.
void	SetViewT50 (bool value)
	Determines whether the half duration should be shown in the results table.
void	SetViewRD (bool value)
	Determines whether the ratio of the maximal slopes during rise and decay should be shown in the results table.
void	SetViewSlopeRise (bool value)
	Determines whether the maximal slope during the rising phase should be shown in the results table.
void	SetViewSlopeDecay (bool value)
	Determines whether the maximal slope during the decaying phase should be shown in the results table.
void	SetViewLatency (bool value)
	Determines whether the latency should be shown in the results table.
void	SetViewCursors (bool value)
	Determines whether two additional rows showing the positions of start and end cursors should be shown in the results table.
void	SetSlopeForThreshold (double value)
	Sets the slope where the baseline should be set.
stf::Table	CurAsTable () const
	Put the current trace into a text table.
void	CopyCursors (const wxStfDoc &c_Recording)
	Copies the cursor positions from another Recording to this Recording.
virtual void	resize (std::size_t c_n_channels)
	Resize the Recording to a new number of channels.
virtual void	InsertChannel (Channel &c_Channel, std::size_t pos)
	Insert a Channel at a given position.
const stf::SectionAttributes &	GetSectionAttributes (std::size_t nchannel, std::size_t nsection) const
const stf::SectionAttributes &	GetCurrentSectionAttributes () const
stf::SectionAttributes &	GetCurrentSectionAttributesW ()
void	DeleteFit (std::size_t nchannel, std::size_t nsection)
	Deletes the current fit, sets isFitted to false;.
void	SetIsFitted (std::size_t nchannel, std::size_t nsection, const Vector_double &bestFitP_, stf::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	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	ClearEvents (std::size_t nchannel, std::size_t nsection)
	Erases all events.
void	correctRangeR (int &value)
void	correctRangeR (std::size_t &value)

Detailed Description

The document class, derived from both wxDocument and Recording.

The document class can be used to model an application’s file-based data. It is part of the document/view framework supported by wxWidgets.

Constructor & Destructor Documentation

wxStfDoc::wxStfDoc ( )

Constructor.

Does nothing but initialising the member list.

Member Function Documentation

void wxStfDoc::AddEvent ( wxCommandEvent & event )

Adds an event at the current eventPos.

Parameters:

event The menu event that made the call.

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.

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.

const Section& wxStfDoc::cur ( ) const [inline]

Retrieves the currently accessed section in the active channel (read-only)

Returns:: The currently accessed section in the active channel.

Section& wxStfDoc::cur ( ) [inline]

Retrieves the currently accessed section in the active channel (read and write)

Returns:: The currently accessed section in the active channel.

void wxStfDoc::Deleteselected ( wxCommandEvent & event )

Unselects all sections.

Parameters:

event The menu event that made the call.

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.

void wxStfDoc::Extract ( wxCommandEvent & event )

Creates a new document from the checked events.

Parameters:

event The menu event that made the call.

void wxStfDoc::FitDecay ( wxCommandEvent & event )

Fit a function to the data.

Parameters:

event The menu event that made the call.

double wxStfDoc::GetAPBase ( ) const [inline]

Retrieves the baseline in the second channel.

Returns:: The baseline value in the second channel.

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

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.

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.

const Recording& wxStfDoc::GetAverage ( ) const [inline]

Retrieves the average trace(s).

Returns:: The average trace as a Recording object.

double wxStfDoc::GetBase ( ) const [inline]

Retrieves the baseline.

Returns:: The baseline value.

References stf::base().

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.

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.

double wxStfDoc::GetBaseSD ( ) const [inline]

Retrieves the standard deviation of the baseline.

Returns:: The standard deviation of the baseline.

std::size_t wxStfDoc::GetCurCh ( ) const [inline]

Retrieves the index of the current channel.

Returns:: The index of the current channel.

std::size_t wxStfDoc::GetCurSec ( ) const [inline]

Retrieves the index of the current section.

Returns:: The index of the current section.

stf::direction wxStfDoc::GetDirection ( ) const [inline]

Retrieves the direction of peak calculations.

Returns:: The current direction of peak calculations.

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.

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.

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.

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.

bool wxStfDoc::GetIsAverage ( ) const [inline]

Indicates whether an average has been created.

Returns:: true if an average has been created, false otherwise.

double wxStfDoc::GetLatency ( ) const [inline]

Retrieves the latency.

Returns:: The latency, expressed in units of data points.

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.

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.

stf::latency_mode wxStfDoc::GetLatencyEndMode ( ) const [inline]

Retrieves the mode of the latency end cursor.

Returns:: The current mode of the latency end cursor.

stf::latency_mode wxStfDoc::GetLatencyStartMode ( ) const [inline]

Retrieves the mode of the latency start cursor.

Returns:: The current mode of the latency start cursor..

stf::latency_window_mode wxStfDoc::GetLatencyWindowMode ( ) const [inline]

Retrieves the mode of the latency window.

Returns:: The current mode of the latency window.

double wxStfDoc::GetMaxDecay ( ) const [inline]

Retrieves the maximal slope of the decaying phase.

Returns:: The maximal slope of rise.

References stf::maxDecay().

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.

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.

double wxStfDoc::GetMaxRise ( ) const [inline]

Retrieves the maximal slope of the rising phase.

Returns:: The maximal slope during the rising phase.

References stf::maxRise().

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.

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.

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.

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.

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.

double wxStfDoc::GetPeak ( ) const [inline]

Retrieves the peak value.

Returns:: The peak value.

References stf::peak().

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.

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.

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.

int wxStfDoc::GetPM ( ) const [inline]

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

Returns:: The number of points to be used.

double wxStfDoc::GetPSlope ( ) const [inline]

Retrieves the value of the Slope.

Returns:: slope value in y-units/x-units.

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

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.

std::size_t wxStfDoc::GetSecCh ( ) const [inline]

Retrieves the index of the second channel.

Returns:: The index of the second channel.

const Vector_double& wxStfDoc::GetSelectBase ( ) const [inline]

Retrieves the stored baseline values of the selected sections (read-only).

Returns:: A vector containing the stored baseline values of the selected sections.

Vector_double& wxStfDoc::GetSelectBaseW ( ) [inline]

Retrieves the stored baseline values of the selected sections (read and write).

Returns:: A vector containing the stored baseline values of the selected sections.

const std::vector<std::size_t>& wxStfDoc::GetSelectedSections ( ) const [inline]

Retrieves the indices of the selected sections (read-only).

Returns:: A vector containing the indices of the selected sections.

std::vector<std::size_t>& wxStfDoc::GetSelectedSectionsW ( ) [inline]

Retrieves the indices of the selected sections (read and write).

Returns:: A vector containing the indices of the selected sections.

double wxStfDoc::GetSlopeForThreshold ( ) const [inline]

Returns the slope for threshold detection.

Returns:: The slope value for threshold detection.

double wxStfDoc::GetSlopeRatio ( ) const [inline]

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

Returns:: The ratio of GetMaxRise() and GetMaxDecay().

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.

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.

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.

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.

double wxStfDoc::GetThreshold ( ) const [inline]

Retrieves the value at which the threshold slope is crossed.

Returns:: The standard deviation of the baseline.

References stf::threshold().

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

const XZoom& wxStfDoc::GetXZoom ( ) [inline]

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

Returns:: The current zoom settings.

XZoom& wxStfDoc::GetXZoomW ( ) [inline]

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

Returns:: The current zoom settings.

const YZoom& wxStfDoc::GetYZoom ( int ch ) [inline]

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

Returns:: The current zoom settings.

YZoom& wxStfDoc::GetYZoomW ( int ch ) [inline]

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

Returns:: The current zoom settings.

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.

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.

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.

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.

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.

virtual bool wxStfDoc::OnNewDocument ( ) [virtual]

Override default file creation.

Returns:: true if successfully closed, false otherwise.

bool wxStfDoc::OnNewfromselectedThis ( )

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

Returns:: true upon success, false otherwise.

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.

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.

void wxStfDoc::OnSwapChannels ( wxCommandEvent & event )

Swaps active and inactive channel.

Parameters:

event The menu event that made the call.

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.

virtual bool wxStfDoc::SaveAs ( ) [virtual]

Override default file saving.

Returns:: true if successfully saved, false otherwise.

const Section& wxStfDoc::sec ( ) const [inline]

Retrieves the currently accessed section in the second (reference) channel (read-only)

Returns:: The currently accessed section in the second (reference) channel.

void wxStfDoc::Selectall ( wxCommandEvent & event )

Selects all sections.

Parameters:

event The menu event that made the call.

void wxStfDoc::SelectTrace ( std::size_t sectionToSelect )

Selects a section.

Parameters:

sectionToSelect The index of the section to be selected.

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.

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.

void wxStfDoc::SetCurCh ( std::size_t value )

Sets the index of the current channel.

Parameters:

value The index of the current channel.

void wxStfDoc::SetCurSec ( std::size_t value )

Sets the index of the current section.

Parameters:

value The index of the current section.

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.

void wxStfDoc::SetDirection ( stf::direction value ) [inline]

Sets the direction of peak calculations.

Parameters:

value The new direction of peak calculations.

void wxStfDoc::SetFileMenu ( wxMenu * menu ) [inline]

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

Parameters:

menu	The menu to be attached.

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.

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.

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.

void wxStfDoc::SetIsFitted	(	std::size_t	nchannel,
		std::size_t	nsection,
		const Vector_double &	bestFitP_,
		stf::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

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.

void wxStfDoc::SetLatency ( double value ) [inline]

Sets the latency.

Parameters:

value The latency, expressed in units of data points.

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.

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.

void wxStfDoc::SetLatencyEndMode ( int value )

Sets the mode of the latency end cursor.

Parameters:

value The new mode of the latency end cursor..

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

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

void wxStfDoc::SetLatencyStartMode ( int value )

Sets the mode of the latency start cursor.

Parameters:

value The new mode of the latency start cursor..

void wxStfDoc::SetLatencyWindowMode ( int value )

Sets the mode of the latency end cursor.

Parameters:

value The new mode of the latency end cursor..

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

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.

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.

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.

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.

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.

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.

void wxStfDoc::SetSecCh ( std::size_t value )

Sets the index of the second channel.

Parameters:

value The index of the second channel.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

bool wxStfDoc::SubtractBase ( )

Subtracts the baseline of all selected traces.

Returns:: true upon success, false otherwise.

bool wxStfDoc::UnselectTrace ( std::size_t sectionToUnselect )

Unselects a section if it was selected before.

Parameters:

sectionToUnselect The index of the section to be unselected.

Returns:: true if the section was previously selected, false otherwise.

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

src/stimfit/gui/doc.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation