Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.javaabf
Interface ABF_parser

All Known Implementing Classes:
ABF18_parser, ABF2_parser, ABFpClamp9_parser, AbstractABF_parser
public interface ABF_parser

A generic .abf file parser interface.

Field Summary
static int ADCNAMELEN
           
static int ADCUNITLEN
           
static int CACHE_BYTE_SIZE
           
static int CHAR
           
static int FLOAT
           
static int LONG
           
static int LONGLONG
           
static int SHORT
           
 
Method Summary
 float getABFVersion()
           
 long getAbsoluteTime(long row)
          Returns the absolute time for the sample row in milliseconds"""
 double[] getChannelData(int channel)
          Returns a list of the whole channel"s data."""
 double[] getChannelData(int channel, double lowerBound, double upperBound, int decimate)
           
 double[] getChannelData(int channel, int decimate)
           
 double[] getChannelDataByEpoch(Epoch epoch, int channel, int decimate)
           
 int[] getChannelIndices()
          Returns a list of the channel indices, which is simply the order in which the channels appear in the file."""
 java.lang.String[] getChannelNames()
           
 int[] getChannelNumbers()
           
 java.lang.String[] getChannelUnits()
           
 Comments getComments(Epoch epoch, java.lang.String filename)
           
 Comments getComments(java.lang.String filename)
           
 double getData(long row, int ch)
          """Returns a specific data value at a time point in a specific channel."""
 java.lang.String getDataFormat()
           
 java.util.Vector getEpochsByCommentPattern(java.lang.String commentPattern)
           
 long getExperimentDuration()
          Returns the duration of the experiment in milliseconds"""
 Epoch getNextEpoch(int epochChannel)
           
 int getNumberOfActualEpisodes()
           
 int getNumberOfADC()
           
 int getNumberOfEpisodes()
           
 long getNumberOfRows()
          """Returns the number of sample rows."""
 long getNumberOfSamplesPerEpisode()
           
 java.lang.String getOperationMode()
           
 Epoch getPreviousEpoch(int epochChannel)
           
 long getRelativeTime(long row)
          Returns the time relative to the start of the experiment in milliseconds"""
 double[] getRow(long row)
           
 long getRowNumberByAbsoluteTime(double time)
          """Returns the row number for the absolute time (assuming ms)."""
 long getRowNumberByRelativeTime(double time)
          """Returns the row number for the relative time (assuming ms)."""
 double getSamplingRate()
           
 short getSizeOfNumberInBytes()
          Returns 2 for integers && 4 for floating point, depending on the data format."""
 long getStartTime()
          Returns the start of the file in milliseconds"""
 Tag[] getTags()
           
 void resetCursor()
           
 void setABFVersion(float newVersion)
           
 void setCurrentRow(int currentRow2)
           
 

Field Detail

CHAR

static final int CHAR
See Also:
Constant Field Values

SHORT

static final int SHORT
See Also:
Constant Field Values

FLOAT

static final int FLOAT
See Also:
Constant Field Values

LONG

static final int LONG
See Also:
Constant Field Values

LONGLONG

static final int LONGLONG
See Also:
Constant Field Values

ADCNAMELEN

static final int ADCNAMELEN
See Also:
Constant Field Values

ADCUNITLEN

static final int ADCUNITLEN
See Also:
Constant Field Values

CACHE_BYTE_SIZE

static final int CACHE_BYTE_SIZE
See Also:
Constant Field Values
Method Detail

getABFVersion

float getABFVersion()

setABFVersion

void setABFVersion(float newVersion)

getSamplingRate

double getSamplingRate()

setCurrentRow

void setCurrentRow(int currentRow2)

getPreviousEpoch

Epoch getPreviousEpoch(int epochChannel)

getNextEpoch

Epoch getNextEpoch(int epochChannel)

getComments

Comments getComments(java.lang.String filename)

getComments

Comments getComments(Epoch epoch,
                     java.lang.String filename)

getEpochsByCommentPattern

java.util.Vector getEpochsByCommentPattern(java.lang.String commentPattern)

getNumberOfEpisodes

int getNumberOfEpisodes()

getNumberOfActualEpisodes

int getNumberOfActualEpisodes()

getSizeOfNumberInBytes

short getSizeOfNumberInBytes()
Returns 2 for integers && 4 for floating point, depending on the data format."""

getNumberOfADC

int getNumberOfADC()

getOperationMode

java.lang.String getOperationMode()

getDataFormat

java.lang.String getDataFormat()

getStartTime

long getStartTime()
Returns the start of the file in milliseconds"""

getTags

Tag[] getTags()
              throws java.io.IOException
Throws:
java.io.IOException

getNumberOfSamplesPerEpisode

long getNumberOfSamplesPerEpisode()

getExperimentDuration

long getExperimentDuration()
Returns the duration of the experiment in milliseconds"""

getChannelNames

java.lang.String[] getChannelNames()
                                   throws java.io.IOException
Throws:
java.io.IOException

getChannelUnits

java.lang.String[] getChannelUnits()
                                   throws java.io.IOException
Throws:
java.io.IOException

getChannelNumbers

int[] getChannelNumbers()
                        throws java.io.IOException
Throws:
java.io.IOException

getChannelIndices

int[] getChannelIndices()
Returns a list of the channel indices, which is simply the order in which the channels appear in the file."""

getAbsoluteTime

long getAbsoluteTime(long row)
Returns the absolute time for the sample row in milliseconds"""

getRelativeTime

long getRelativeTime(long row)
Returns the time relative to the start of the experiment in milliseconds"""

getChannelDataByEpoch

double[] getChannelDataByEpoch(Epoch epoch,
                               int channel,
                               int decimate)
                               throws java.io.IOException
Throws:
java.io.IOException

getChannelData

double[] getChannelData(int channel)
                        throws java.io.IOException
Returns a list of the whole channel"s data."""

Throws:
java.io.IOException

getChannelData

double[] getChannelData(int channel,
                        int decimate)
                        throws java.io.IOException
Throws:
java.io.IOException

getChannelData

double[] getChannelData(int channel,
                        double lowerBound,
                        double upperBound,
                        int decimate)
                        throws java.io.IOException
Throws:
java.io.IOException

getRow

double[] getRow(long row)
                throws java.io.IOException
Throws:
java.io.IOException

getNumberOfRows

long getNumberOfRows()
"""Returns the number of sample rows."""

getRowNumberByAbsoluteTime

long getRowNumberByAbsoluteTime(double time)
"""Returns the row number for the absolute time (assuming ms)."""

getRowNumberByRelativeTime

long getRowNumberByRelativeTime(double time)
"""Returns the row number for the relative time (assuming ms)."""

getData

double getData(long row,
               int ch)
               throws java.io.IOException
"""Returns a specific data value at a time point in a specific channel."""

Throws:
java.io.IOException

resetCursor

void resetCursor()
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD