Permalink
Browse files

Added stf.get_maxrise() and stf.get_maxdecay() to the list of Python …

…functions
  • Loading branch information...
JoseGuzman committed Oct 27, 2011
1 parent 08adfff commit b75dbdbf324c55c76eeccd408160fd4160188ee5
Showing with 50 additions and 1 deletion.
  1. +1 −1 BUGS
  2. +8 −0 doc/sphinx/stf_reference/stf.rst
  3. +12 −0 src/stimfit/py/pystf.cxx
  4. +3 −0 src/stimfit/py/pystf.h
  5. +26 −0 src/stimfit/py/pystf.i
View
2 BUGS
@@ -13,7 +13,7 @@ The PSlope cursors does not appear at document loading (this is good, since we w
==============
Batch Analysis
==============
* Slope does not appear in the grid!!!
* PSlope does not appear in the grid!!!
* Batch analysis results gives names liek "0xb27468, Section #1" in the first column of the results table. This should be more human-readable.
=======
@@ -201,6 +201,14 @@ The :mod:`stf` module defines the following functions:
Returns the latency value (in x-units) determined by the latency cursors set in the cursors settings menu. Call :func:`measure()` or hit enter to update the cursors.
.. function:: get_maxdecay(\*args)
Returns the the maximal slope of the decay between the peak cursors. Returns -1.0 upon error. Call :func:`measure()` or hit enter to update the value.
.. function:: get_maxrise(\*args)
Returns the the maximal slope of the rise between the peak cursors. Returns -1.0 upon error. Call :func:`measure()` or hit enter to update the value.
.. function:: get_risetime(\*args)
Returns the 20-80% rise time (in x-units) by calculation of the interpolated adjacent sampling points at 20% and 80% of the peak amplitude. Returns -1.0 upon failure. Call :func:`measure()` or hit enter to update the value.
View
@@ -300,6 +300,18 @@ int get_size_recording( ) {
return actDoc()->size();
}
double get_maxdecay() {
if ( !check_doc() ) return -1.0;
return actDoc()->GetMaxDecay();
}
double get_maxrise() {
if ( !check_doc() ) return -1.0;
return actDoc()->GetMaxRise();
}
const char* get_recording_time( ) {
if ( !check_doc() ) return 0;
return actDoc()->GetTime().c_str();
View
@@ -26,6 +26,9 @@ const char* get_yunits( int trace = -1, int channel = -1 );
bool set_xunits( const char* units );
bool set_yunits( const char* units, int trace = -1, int channel = -1 );
double get_maxdecay();
double get_maxrise();
const char* get_recording_time( );
const char* get_recording_date( );
std::string get_recording_comment( );
View
@@ -180,6 +180,32 @@ The number traces in a channel.") get_size_channel;
int get_size_channel( int channel = -1 );
//--------------------------------------------------------------------
//--------------------------------------------------------------------
%feature("autodoc", 0) get_maxdecay;
%feature("docstring", "Retrieves the maximal slope of the decay
between the peak cursors in the current trace. Uses the currently
measured values, i.e. does not update measurements if the peak window
cursors have changed.
Returns:
The maximal slope of the decay, -1.0 upon failure.") get_maxdecay;
double get_maxdecay( );
//--------------------------------------------------------------------
//--------------------------------------------------------------------
%feature("autodoc", 0) get_maxrise;
%feature("docstring", "Retrieves the maximal slope of the rise
between the peak cursors in the current trace. Uses the currently
measured values, i.e. does not update measurements if the peak window
cursors have changed.
Returns:
The maximal slope of the rise, -1.0 upon failure.") get_maxrise;
double get_maxrise( );
//--------------------------------------------------------------------
//--------------------------------------------------------------------
%feature("autodoc", 0) get_size_recording;
%feature("docstring", "Retrieves the number of channels in a

0 comments on commit b75dbdb

Please sign in to comment.