npwork / kotlin-edf-parser

Small Kotlin library for EDF file parsing

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Kotlin EDF parser

Kotlin library to work with EDF files Build Status Apache License


EDF format description - https://www.teuniz.net/edfbrowser/edf%20format%20description.html

EDF viewer - https://www.teuniz.net/edfbrowser/

What does it look like? (Code snippets)

data class EdfFile(
        val header: EdfHeader,          // Header record
        val signal: EdfSignal           // Data record
) {
    val samples: List<Int> = ...        // Amount of samples        
    val sampleRate: List<Double> = ...  // Sample rate (second) 
}

How to use? (Code snippets)

You can work with File

val file = File("/example.edf")
val edfFile: EdfFile = EdfParser.parse(file)

Or stream

class EdfParserExample
val stream: InputStream = EdfParserExample::class.java.getResourceAsStream("/example.edf")
val edfFile: EdfFile = EdfParser.parse(stream)

Add to your project

Step 1 - Add jitpack repository (https://jitpack.io/)

Maven
<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>
Gradle
allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

Step 2 - Add dependency

Maven

<dependency>
    <groupId>com.github.npwork</groupId>
    <artifactId>kotlin-edf-parser</artifactId>
    <version>0.1.1</version>
</dependency>

Gradle

implementation 'com.github.npwork:kotlin-edf-parser:0.1.1'

About

Small Kotlin library for EDF file parsing

License:Apache License 2.0


Languages

Language:Kotlin 100.0%