Nest-o-Patch version 1.1, official release.
The program is distributed under the GPL v 3.0 license. Text of the license
must be included in the package which you have received. If it is not there,
the copy may be found at http://fsf.org/
This is a stable version of Nest-o-Patch with the support of PatchMaster for
daily use.
Please, visit our official site http://sourceforge.net/p/nestopatch/ for updates,
discussion and feature requests.
What's new in 1.1 version.
1. Support for the data, recorded with most current HEKA software - PatchMaster.
2. As a consequence of (1), a trace for loading may be selected (since PatchMaster
supports up to 16 traces).
If some of the selected series do not contain selected trace, a warning is issues
and these series are skipped during a trace loading.
3. Possibility to make time scale relative to a group, series or a sweep.
In the latter case a recording is displayed
with overlaid sweeps, like in PatchMaster or Pulse themselves.
4. Possibility to calculate an average current on an interval. If no levels
specified, relative to "0", otherwise relative to level "0". If a recording is
shown with "parallel" view of groups, series or sweeps, it is calculated for each
of them.
1. Program description
This program was designed mainly for preconditioning and analysis of single
channel properties in patch-clamp recordings. Single channel conductance, kinetics,
NPo and open probability may be estimated. The program focused mainly on the
analysis of level dwellings distribution in a recording with several channels and
estimate of the number of channels (N) and open probability (Po).
Advanced techniques of event detection planned in the future versions.
However, the program may be useful in various applications, for example, analysis
of whole-cell mode recordings, or of any other data, when limited editing and
measurements in a 2-dimentional (for example time-current) wave are required.
The program itself does not make any assumptions about units of the recordings,
it deals only with X-values and Y-values.
Directly supports files, created by Pulse and PatchMaster software (HEKA
Elektronik Dr. Schulze GmbH) and opens ASCII files.
2. Package content
NSTPatch: main program
ReadPulse: readpulse library (needed for reading of Pulse files).
ReadPMaster: readpmaster library (needed for reading of PatchMaster files).
NstPatchGuide1_1.pdf - Nest-o-Patch manual.
readme_1_1.txt - this text.
3. System requirements.
Operating systems supported:
Windows XP or higher.
Linux with "Wine" windows simulator.
(Tested on Windows XP, Windows 7, Wine)
Hardware: any computer running the abovementioned operating systems and
3 MB of free space on hard drive.
4. Installation
Just copy nstpatch.exe, readpulse.dll, readpmaster.dll to any desired user directory.
(But NOT a root of c: drive and not subdirs from c:\windows\ or c:\program files\).
The program creates nstpatch.ini file in its own directory.
5. Getting support and bugs report is possible at the official site:
https://sourceforge.net/projects/nestopatch/
Best way to report a bug is to open a ticket:
https://sourceforge.net/p/nestopatch/tickets/
Alternatively, you may post your questions and suggestions at the forum:
https://sourceforge.net/p/nestopatch/discussion/
or contact the author directly:
viatcheslav.nesterov@gmail.com
6. History of changes:
1.0 First released version.
1.01: 1. Bugfix: The program would not allow attempt to test binomial distribution when only one level is
defined, which could lead to a crash.
2. Use of distribution analysis is now allowed when only 2 levels (one "all closed", and one open) are present.
1.02 Small interface modifications:
1. A section of a Pulse file can be loaded by double click on a pulse tree.
2. Caption on the button "Load selected' in the Pulse Tree tab added.
3. Caption on the "Execute test" button (Levels analysis tab) is added.
4. Coordinate systems use exponential (eg 2.3E-9) notation for very small and very large values.
Bug fixes:
1. Date of a recording of pulse file is correctly shown (readpulse.dll 1.2.2 is needed).
2. Program would not crash if attempt is made to read data from a text file which does not contain them.
3. Program would not report read error when text file is actually successfully read.
4. Program now highlights correctly sections when sectioned text file was read with compression.
1.1b1: New functionality: Support for PatchMaster introduced (ReadPMaster library is needed).
Time scale can be set relative to File, Group, Series, Sweep. As a result, sweeps of
a series may be viewed as in parallel. In any of these views, the line, connecting sweeps
may be drawn or not (by default, it is not drawn).
Possibility to calculate an average current on an interval. If no levels specified, relative to "0",
otherwise relative to level "0". If a recording is shown with "parallel" view of groups, series or sweeps,
it is calculated for each of them.
Interface: Trace name edit is added (since PatchMaster records up to 16 traces).
Warning about absence of a selected trace in some selected sweeps is shown in StatusLine.
Formatting of the data in Pulse Tree tab is improved.
Bug fixes:
Handling of exceptions is now correct. Program remains stable after many errors in file
formats and reading.
(readpulse.dll 2.2 is needed).
1.1b2 Bug fixes.
Program will not crash if analysis or correction functions
are invoked when there are no datapoints inside the selected area.
(For example, between neighbor sweeps).
Meaningless point (0; -3E38) will not be saved when MLE fit results are
saved.
If a user defines Levels, and later switches direction of current, the Levels
are re-sorted according to the new setting.
When a function of data analysis changes Selection, the new Selection
is immediately shown on screen.
Axis labeling in the Closures and Openings histograms are fixed.
Program will not crash when NPo calculation is invoked with no points
inside Borders.
The Trace coordinate plane behaves correctly when "Y" value is constant over
the complete Trace.
Functionality.
Bessel filter is added (earlier only Butterworth was used).
When current is integrated (for the calculation of NPo or average
current), one can use time stamps at each data point (the only possible
behavior in the previous versions), or use every data point as one
unweighted value (new default behavior). This latter choice removes
false peaks in the histograms after removal of artifacts, but invalidates
current integration over data stretches with alternating acquisition
frequency.
Further support of overlaid view. Baseline correction now is possible and
is applied to Highlighted section. NPo in overlaid view is calculated for
highlighted segment.
Amplitude histogram in overlaid view is calculated either for sum of
selected portion of every segment or, if one segment is highlighted, then
for highlighted segment.
Interface:
Warnings in StatusLine are displayed as long as no other Hint
is shown. Titles to the Openings and Closures histograms are added.
New Options dialog is added. In this dialog a user can select if time is
considered for current summarizing or not (see above) and which filter to
use (Butterworth or Bessel). In addition, it selects a multiplying factor
for Holding field. (Typically, 1000, to convert from V to mV. However,
one can select 10E12, for pA, if current clamp mode was used. Default file
type (Pulse, PatchMaster or Text) also may be selected here.
Revised and more comprehensive user guide.
1.1b3 Extraordinary bug fix version.
Bug fixes.
Loading data from Patch-Master, Program will not subtract initial Y-value
(Sweep.Zerodata) from all Y-values of a sweep.
Program will not crash when a user attempts to load non-existing HEKA Trace.
New versions of both ReadPluse.dll and ReadPMaster.dll needed!
1.1 This version is essentially identical to 1.1b3, with one small bug fix:
the program executes correctly kinetic analysis when Selection extends
to an end of a Trace and channel state is indefinite at the end.
One small interface change: number of digits increased at the Amplitude
histogram.