Merge pull request #10 from grero/recordings

Recordings

Author: grero

Project.toml

@@ -1,7 +1,7 @@
 name = "Eyelink"
 uuid = "83654edc-39a9-11e9-3850-750e501afe4a"
 authors = ["roger <roger.herikstad@gmail.com>"]
-version = "0.5.3"
+version = "0.6.0"
 
 [deps]
 FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"

README.md

@@ -3,8 +3,14 @@
 [![Build Status](https://travis-ci.org/grero/Eyelink.jl.svg?branch=master)](https://travis-ci.org/grero/Eyelink.jl)
 [![Coverage Status](https://coveralls.io/repos/github/grero/Eyelink.jl/badge.svg?branch=master)](https://coveralls.io/github/grero/Eyelink.jl?branch=master)
 ## Introduction
-Open up an edf file, loading both events and continuos data:
+Open up an EDF file, loading both events and continuos data:
 
 ```julia
 eyelinkdata = Eyelink.load("w7_10_2.edf")
 ```
+
+Since an EDF file contains a lot of data, and one might not be interested in all that data for every analysis, there are convenience functions for getting certain types of data. For instance, to get just the calibrated gaze positions, one can do the following
+
+```julia
+gazex, gazey, gtime = Eyelink.getgazepos("w7_10_2.edf")
+```

src/Eyelink.jl

@@ -59,6 +59,7 @@ function edfload(edffile::EDFFile)
     nevents = get_element_count(f)
     samples = Array{FSAMPLE}(undef, nevents)
     events = Array{Event}(undef, nevents)
+    recording_info = Recording[]
     event_count = 0
     sample_count = 0
     total_count = 0
@@ -70,8 +71,9 @@ function edfload(edffile::EDFFile)
             sample_count += 1
             samples[sample_count] = _sample
 
-		elseif nextevent == :recording_info
-			#nothing
+		elseif nextevent == :recordinginfo
+            _recinfo = edfdata(f)
+            push!(recording_info, _recinfo)
 		elseif nextevent == :no_pending_items
 			#ntohing
 		else #event
@@ -86,7 +88,7 @@ function edfload(edffile::EDFFile)
         total_count += 1
         update!(p, total_count)
 	end
-    Dict([("events", events[1:event_count]), ("samples", samples[1:sample_count])])
+    Dict([("events", events[1:event_count]), ("samples", samples[1:sample_count]), ("recording_info", recording_info)])
 end
 
 function get_element_count(edffile::EDFFile)
@@ -107,7 +109,7 @@ function load(f::String;check=1, load_events=true,load_samples=true,do_save=true
         ss = load(File(format"HDF5", samplefile))
 		edffile = edfopen(f, check, true, false)
 		data = edfload(edffile)
-		eyedata = EyelinkData(data["events"],ss)
+        eyedata = EyelinkData(data["recording_info"], data["events"],ss)
 	else
 		edffile = edfopen(f, check, load_events, load_samples)
 		data = edfload(edffile)
@@ -119,7 +121,7 @@ function load(f::String;check=1, load_events=true,load_samples=true,do_save=true
 		else
 			ss = Samples(0)
 		end
-		eyedata = EyelinkData(data["events"], ss)
+        eyedata = EyelinkData(data["recording_info"], data["events"], ss)
 	end
 	eyedata
 end
@@ -158,8 +160,10 @@ function edfdata(f::EDFFile)
 	if f.nextevent == :sample_type
 		#TODO: Implement this
 		_sample = unsafe_load(convert(Ptr{FSAMPLE}, _data), 1)
-                return _sample
-	elseif f.nextevent == :recording_info
+        return _sample
+	elseif f.nextevent == :recordinginfo
+        _recinfo = unsafe_load(convert(Ptr{Recording}, _data),1)
+        return _recinfo
 	elseif f.nextevent == :no_pending_items
 	else
 		#even type

src/types.jl

@@ -16,6 +16,7 @@ datatypes = Dict{Int16, Symbol}(0 => :nopending,
 			 16 => :endsamples,
 			 17 => :startevent,
 			 18 => :endevent,
+             30 => :recordinginfo,
              200 => :sample_type)
 
 
@@ -31,6 +32,29 @@ function EDFFile(fname::String, ptr::Ptr)
 	EDFFile(fname,ptr,0,0,:unknown)
 end
 
+struct Recording
+    time::UInt32
+    sample_rate::Float32
+    eflags::UInt16
+    sflags::UInt16
+    state::UInt8
+    record_type::UInt8
+    pupil_type::UInt8
+    recording_mode::UInt8
+    filter_type::UInt8
+    pos_type::UInt8
+    eye::UInt8
+end
+
+function Recording()
+    args = []
+    for f in fieldnames(Recording)
+        tt = fieldtype(Recording,f)
+        push!(args, zero(tt))
+    end
+    Recording(args...)
+end
+
 struct EyeEvent
 	time::Int64
 	x::Float32
@@ -415,9 +439,12 @@ function convert(::Type{Array{T,1}}, M::Dict) where T<:AbstractSaccade
 end
 
 struct EyelinkData
+    recording_info::Vector{Recording}
 	events::Array{Event,1}
 	samples::Samples
 end
 
+Eyelinkdata(events::Vector{Event}, samples::Samples) = EyelinkData([Reording()], events, samples)
+
 get_gaze(eyelinkdata::EyelinkData) = (eyelinkdata.samples.gx, eyelinkdata.samples.gy)
 get_pupil(eyelinkdata::EyelinkData) = eyelinkdata.samples.pa

test/runtests.jl

@@ -14,6 +14,10 @@ end
 @testset "Load file" begin
     download("http://cortex.nus.edu.sg/testdata/w7_10_2.edf", "w7_10_2.edf")
     eyelinkdata = Eyelink.load("w7_10_2.edf")
+    @test eyelinkdata.recording_info[1].time == 0x001c0657
+    @test eyelinkdata.recording_info[1].state == 0x01
+    @test eyelinkdata.recording_info[2].time == 0x001c07f9
+    @test eyelinkdata.recording_info[2].state == 0x00
     mm = eyelinkdata.events[1].message
     @test mm == "DISPLAY_COORDS 0 0 1920 1200"
     start_fix_events = filter(ee->ee.eventtype==:endfix,eyelinkdata.events)