Desktop Software for Patch-Clamp Raw Binary Data Conversion and Preprocessing
Since raw data recorded by patch-clamp systems are always stored in binary format, electrophysiologists may experience difficulties with patch clamp data preprocessing especially when they want to analyze by custom-designed algorithms. In this study, we present desktop software, called PCDReader, which could be an effective and convenient solution for patch clamp data preprocessing for daily laboratory use. We designed a novel class module, called clsPulseData, to directly read the raw data along with the parameters recorded from HEKA instruments without any other program support. By a graphical user interface, raw binary data files can be converted into several kinds of ASCII text files for further analysis, with several preprocessing options. And the parameters can also be viewed, modified and exported into ASCII files by a user-friendly Explorer style window. The real-time data loading technique and optimized memory management programming makes PCDReader a fast and efficient tool. The compiled software along with the source code of the clsPulseData class module is freely available to academic and nonprofit users.
Since the advent of patch-clamp electrophysiology at the end of the 1970s , there has been an ever-increasing interest in the application of its power to investigate ion-channel-related bioscientific questions in unprecedented detail. By the use of the technique, investigators are able to measure both electrical currents and transmembrane potential responses from individual cells. Over the past decade, patch-clamp technology has led to major advances in the knowledge of the structure and function of ion channels and in drug development, becoming an essential tool in electrophysiology and neuroscience [2–5].
Currently, the world of electrophysiology data acquisition and analysis is practically divided between two major software packages—PULSE from HEKA and pClamp from Axon Instruments. The software produced by HEKA and Axon employ different data acquisition and analysis systems. Pulse+PulseFit package consists of two parts: PULSE, the main acquisition program, and PulseFit to fit raw traces and to derive parameters. Clampex and Clampfit are the acquisition component and the analysis component of the pCLAMP 9 suite, respectively. Although both commercial packages provide rich set of features, electrophysiologists may still experience some difficulties with data analysis especially when it comes to implementing a novel analysis algorithm (e.g., detrended fluctuation analysis (DFA)), which is not implemented in the commercial software packages. In addition, data recorded by patch-clamp systems are always stored in binary format, because of its advantages—it occupies less space than text format both on the hard disk and in the memory and also takes less time to read/write for the same reason. However, it is usually easier to implement custom analysis of data stored in text file format. Furthermore, text format has wider support; the text format, such as the comma-separated-values (CSV) format, is supported by virtually all existing data analysis packages. Therefore, it is really the problem of the absence of generally accepted organization of multiple binary values into a single data file stream, because it is more difficult for electrophysiologists to program a binary file loading module than to get the data from an ASCI file.
There are other programs available to analyze patch-clamp data, most of which are very highly featured and include methods for analysis. For instance, data obtained from patch-clamp instruments can be further analyzed and plotted by means of Igor Pro. Some 3rd-party analysis packages are able to import pClamp files directly for analysis of data recorded in pClamp 9 suite, such as Origin, SigmaPlot , and DataView . Marrannes and Prins  also designed IVOC and IROC programs to facilitate the analysis of drug effects on currents through ion channels in the cell membrane measured by means of voltage clamp. The programs are written in Igor Pro (WaveMetrics) and read exported files or raw data files generated by the PULSE (HEKA Electronic) or pClamp (Axon Instruments) systems. However, most of these programs are commercial packages, some are free. In the latter group only a few can read the binary raw data recorded from HEKA instruments. In addition, modules of some existing tools (e.g., Igor Pro, Origin) could not be easily used for electrophysiological researchers who are not familiar with programming using the specific language (e.g., the script language in Igor Pro or in Origin), which makes it still hard to read data from binary files.
There are some software tools developed for facilitating solving these problems, such as DataAccess (http://www.bruxton.com/DataAccess/index.html), which is capable of reading both the pClamp and HEKA PULSE file formats, WinWCP (http://spider.science.strath.ac.uk/sipbs/page.php?show=software_winWCP), which supports some of HEKA acquisition hardware, without any conversion of HEKA PULSE format.
In this study, we developed a software called PCDReader (Patch-Clamp Data Reader) for patch-clamp raw binary data conversion and preprocessing. Differing from some earlier studies such as IVOC and IROC , which programmed in Igor Pro, we designed a novel class module to directly read the raw data files recorded from HEKA instruments without any other program support (such as Igor Pro and Origin). We have preprocessed the raw data by using PCDReader in our previous patch clamp experiments, such as [9–11].
2. Computational Methods and Theory
2.1. File Format Overview
The idea of PULSE is to order the data of an experiment in Trees. A single PULSE “Experiment,” that can hold a variable number of single electrophysiological experiments, consists of at least three files: *.pgf, *.pul, and *.dat (Table 1). Each of the three files has a tree structure, separately. PCDReader is designed to recognize and read all the information stored in these files.
2.2. Outline of PCDReader
PCDReader is a Windows-based application that is implemented using Visual Basic programming language and Win32 API (Application Programming Interface). It consists of four main components: (i) a Data Quick Viewer to quickly obtain (with <1 s file loading time) parts of the raw data, (ii) a Spike-wave Viewer to visualize the spike waves of traces, (iii) a Data Conversion dialog (with data preprocessing options) to export raw data into ASCII text files, and (iv) a Parameter Viewer to view *.pgf and *.pul files in an Explorer style window. By the Parameter Viewer, users can export all information in *.pgf and *.pul files into ASCII text and can also modify parameters and save the modifications back to the raw binary files. Figure 1 depicts an outline of the proposed system.
It has been successfully tested on most 32-bit Windows systems (Windows 98, Windows Me, Windows NT, Windows 2000, Windows XP, and Windows 2003). It can be run on any PC compatible computers with the minimal requirements of a 386DX processor and 64 Mb RAM. The program has also been optimized both in memory management and data loading and writing processing (see below).
PCDReader is programmed in an objected-oriented programming style. Object-oriented technique is more versatile because of its modularity, data abstraction, and inheritance characteristics. PCDReader employs many different classes to accomplish different tasks, for instance, raw data reading class, memory management class, traces drawing class, and Windows interface class. A complete description of every class module is beyond the scope and length of this paper and here we point out only the raw data reading class below.
2.3. Class Module for Reading Raw Data
We design a novel class module, called clsPulseData, to directly read the raw data along with the parameters recorded from HEKA instruments without any other program support (such as Igor Pro and Origin). A Class Module encapsulates objects’ properties and methods, which is a fundamental concept of object-oriented programming (OOP). Data analysis algorithm programmers may use the Class Module to create their own custom objects for easily retrieving data from raw binary files. It is not necessary for them to redesign the data retrieving program when they analyze data. Technical information about the format of the raw binary files was obtained from the PULSE+PULSEFIT Manual (8.52).
clsPulseData encapsulates as much as possible properties and functions for raw data loading, which can be easily called in the main procedure. Some of the properties and methods of the clsPulseData class are listed in Table 2. The parser in the class will automatically recognize and read the data and return values to the main procedure as required.
clsPulseData does not load all data in memory at the time of file opening but only constructs the data structure and stores the pointers. The event of reading data stream from raw files occurs only if one of the following conditions is met: (a) the main procedure calls a reading method; (b) the main procedure sends a data preprocessing command. In addition, clsPulseData reads only part of the data required at the moment. This kind of real-time data loading technique makes the program optimized a quick and efficient data processing tool.
3. Program Features
3.1. Raw Data Quick Viewer
A quick viewer window was designed, which provides a rapid access to the raw data (Figure 2). The real-time data loading technique makes it possible to view any part of the raw data quickly. In the screen, users can select the Group, Series, Sweep, and the Trace, as well as the start and end point to display. The selected section of raw data will be rapidly shown in the window on the right hand, which can then be copied to the clipboard or saved to an ASCII text file by a right-click mouse pop-up menu. As for selection of start and end point, there is also a scrollbar in the middle left of the window to drag as well as to input values into the text boxes.
This is a useful tool for researchers especially when they want to quickly view only a specific part of the raw data. There is no necessity to wait for a long time for the whole data file to be loaded.
3.2. Spike Wave Viewer
PCDReader has a graphical interface that allows for the spike waves visualization for traces. There is a selector with some labels at the bottom, each for one sweep. Users can select a sweep by clicking the corresponding label to view both its traces in the graph window and the data value in the table right. Data are shown by rows and columns in the table just as that shown in Igor Pro software. Real-time movable cursors, scroll, zoom, resize, and selection functions capabilities are also supplied in the graphic window. A sample of spike waves visualized in this window is presented in Figure 3. Users can select a part of the data by dragging to highlight it. The selection can then be exported to a file.
3.3. Binary Data Conversion
PCDReader provides a versatile dialog to export binary data, with several data preprocessing options. The dialog is shown in Figure 4.
Users are allowed to specify which part of raw data to export, by selecting fields in the top left window and typing start and end point in the top right window. There is also a drop-down menu for quick selection of the same type traces in the top left window. For instance, one can simply select all the “stim” traces (such as Pulse_1_1_1_Stim, Pulse_1_1_2_Stim, Pulse_1_2_1_Stim, and Pulse_1_3_1_Stim) by clicking the “Pulse_Stim” item of the drop-down menu. PCDReader also supports “Level Export” to generate files automatically at different levels, that is, Group level, Series level, or Sweep level. For instance, if a user exports raw data in a Series level, each Series will be exported into one file in spite of the number of Sweeps it contains. This provides a convenient way to preprocess for batch data analysis one unit by one unit (Series by Series in this example). Otherwise, without this feature, one must do the complicated procedure manually as follows: select all Sweeps in Series 1, export them into one file; select all Sweeps in Series 2, export them into another file; and so forth; repeat until all Series are exported. There will be no necessity to export the whole file and then manually separate it into several parts, either. Note that the “Level Export” functions are not shown in Figure 4. They will be displayed in the place of the top left window in the dialog if the user selects the “Level Export” radio button.
Then the exported data can be loaded by other software to make further analysis. PCDReader provides an option to set the maximum samples in each exported file. Large data files will be separated into several small parts automatically, with each one not exceeding the maximum number of samples. This is useful and provides a possible way for memory-consuming algorithms to analyze part by part the samples from a large-size raw data file.
Another special feature of the program is that data modification by a user-defined expression is permitted during the export processing. Any valid expression (+, −, , , ∧) and many functions such as Sin(), Cos(), Exp(), Log(), and Sqr() are supported. This preprocessing feature provides a batch calculation based on raw values to generate more proper data for further analysis. It can be used in, for example, data value magnification such that each sample is multiplied by 1012, which can be simply done by typing the expression “[OriData]*1E12” in the expression text box in the dialog. Users have another option to add row headers (num column) and column headers in the exported files. The num column can also be customized by specifying the start value and the sampling frequency in the text box.
Exported data can be saved in several kinds of ASCII text format, such as CSV, ATF, and user-defined TXT files. An ATF format file can then be loaded directly into Clampfit software for further analysis. User-defined TXT files can be generated by specifying the field separator (space, comma, semicolon, tab, etc.) and the wrap character (line feeds, carriage returns, etc.). Furthermore, a progress window will be shown to indicate the export progress, and a “Cancel” button is also provided for user to cancel at any time during the processing.
3.4. The Parameters Viewer
The Parameters Viewer is used for *.pul files and *.pgf files. Information in *.pul files and *.pgf files can be presented in an Explorer style window, with left part displaying the tree structure and right part displaying all the parameters corresponding to the selected node (Figure 5). The right window includes various kinds of controls, such as text boxes, drop-down menus, and check boxes. There are also some command buttons in the right window to click to open another pop-up window, for example, the Trig parameters in a stimulation record. Every parameter entry can be customized by users in the configuration file “PlsFdCfg.ini”. Properties of parameter entries that can be customized in the “ini” file are listed in Table 3. Users are able to modify “PlsFdCfg.ini” to customize their own window screen, and the configuration file has a default version for novice users.
A special screen was designed to enable selected parameter entries to be exported to ASCII files. Recursion operations are also supported, which enables the export of the sublevels of a selected item, for example, a series entry is exported together with all its subsweeps in the series.
All parameter entries shown in the right window can be edited and the modification can be saved back to the original binary files. Modified *.pul files and *.pgf files by PCDReader can be loaded again in Pulse+Pulsefit system or any other software which support the format.
3.5. Software Performance
The program has been optimized both in memory management and data loading and writing processing. A 2.8 GHz Pentium 4 computer was used to benchmark the performance of PCDReader. The results are shown in Table 4.
As shown in Table 4, the real-time data loading technique makes the time spent for file opening less than 1 second, even for files more than 100 MB. The time spent for loading and preprocessing data is usually less than 20 min and often less than 5 min when data conversion is without modification, with much less memory occupied. Therefore, PCDReader is a fast and efficient tool for patch-clamp data processing for daily laboratory use.
4. Conclusions and Future Plans
In the present study, a desktop software, PCDReader, has been presented for the patch-clamp raw binary data conversion and preprocessing. The program is different from most of the previous programs in the field. It incorporates a class module designed by ourselves that includes many useful properties and functions for raw binary data reading. The class module is a stand-alone program and can run without any support of other programs (e.g., Igor Pro or Origin). The real-time data loading technique and our efforts to optimize the program both in memory management and programming make PCDReader a fast and efficient tool. It provides features for data conversion and preprocessing in several versatile dialogs. In addition, it provides a vivid and easy way (an Explorer style window) to view information in *.pul and *.pgf files and supports the modification and changes being saved back to the original binary files.
Future enhancement of the software could include (i) integrating more programs of newly developed algorithms into the system for data analysis and providing an easy way to integrate custom designed algorithms; (ii) designing new class modules to support more patch-clamp data formats; (iii) extending programming to support additional platforms, such as Linux, and MacOS.
PCDReader, as a desktop application, is made friendly for electrophysiological researchers for ease of use with a graphical user interface. Although some commercial software implement more sophisticated analysis algorithms, the free PCDReader application is potentially useful especially for small laboratories that do not have funding for the expensive commercial packages. Its primal goal is to help a user with some patch-clamp data on his/her hand and the need to preprocess it, with the choice of what to use, and what is out there that can be used. PCDReader could be an effective and convenient solution for daily laboratory use, for the growing number of researchers who are moving beyond simple use of a software tool for preprocessing raw patch-clamp data and are designing their own analysis algorithms.
The compiled software along with the source code of the clsPulseData class module is freely available to academic and nonprofit users and can be downloaded from the website http://www.nkbiox.com/sub/pcdreader/index.htm. There is no password required to enter the system.
Conflict of Interests
The authors declare that there is no conflict of interest.
This work was partly supported by grants from the National Natural Science Foundation of China (30870827).