MCAEmotiv.Interop.EEGDataEntry Struct Reference

Contains one EEG data point, with marker, timestamp, and voltage data. This class is immutable. More...

List of all members.

Public Member Functions
	EEGDataEntry (int marker, int timeStamp, int relativeTimeStamp, IEnumerable< double > channelData)
	Constructs an EEGDataEntry. A copy of channelData is created.
EEGDataEntry	WithMarker (int marker)
	Create an identical entry except for the marker field. Re-uses the channel data.
override string	ToString ()
	A CSV string representation which can be parsed by Parse.
override bool	Equals (object obj)
	Checks all fields to determine equality.
override int	GetHashCode ()
	Returns a hashcode for this entry.
Static Public Member Functions
static EEGDataEntry	Parse (string line)
	Parses a line of text as an EEGDataEntry. The line should have been created with ToString.
static EEGDataEntry	ParseOldFormat (string line, int onsetTime)
	Parses a line of text based on a format that is essentially the raw output of the emotiv headset.
static IEnumerable< EEGDataEntry >	FromFile (string path)
	Attempts to use Parse/ParseOldFormat to extract the entries in the file.
Public Attributes
const char	SEPARATOR = ','
	The separator character used in ToString.
const int	MARKER_UNKNOWN = -2
	A value used to mark the presentation of an unknown stimulus -2
const int	MARKER_DEFAULT = -1
	A value used to mark the absence of a stimulus -1
const int	EMO_MARKER_DEFAULT = 0
	The default marker value returned by the headset 0
Static Public Attributes
static readonly int	NUM_LINE_FIELDS = Channels.Values.Count + 3
	The number of fields in an entry's ToString output.
Properties
int	Marker [get, set]
	Provides an indication of the current trial.
int	TimeStamp [get, set]
	Time in millis.
int	RelativeTimeStamp [get, set]
	Time relative to stimulus onset.
IArrayView< double >	Data [get, set]
	The voltage data at each channel.
double	this [Channel channel] [get]
	Provides explicit channel-based access to data.

---

Detailed Description

Contains one EEG data point, with marker, timestamp, and voltage data. This class is immutable.

---

Constructor & Destructor Documentation

MCAEmotiv.Interop.EEGDataEntry.EEGDataEntry	(	int	marker,
		int	timeStamp,
		int	relativeTimeStamp,
		IEnumerable< double >	channelData
	)

Constructs an EEGDataEntry. A copy of channelData is created.

---

Member Function Documentation

override bool MCAEmotiv.Interop.EEGDataEntry.Equals

(

object

obj

)

Checks all fields to determine equality.

static IEnumerable<EEGDataEntry> MCAEmotiv.Interop.EEGDataEntry.FromFile

(

string

path

)

[static]

Attempts to use Parse/ParseOldFormat to extract the entries in the file.

override int MCAEmotiv.Interop.EEGDataEntry.GetHashCode

(

)

Returns a hashcode for this entry.

static EEGDataEntry MCAEmotiv.Interop.EEGDataEntry.Parse

(

string

line

)

[static]

Parses a line of text as an EEGDataEntry. The line should have been created with ToString.

static EEGDataEntry MCAEmotiv.Interop.EEGDataEntry.ParseOldFormat	(	string	line,
		int	onsetTime
	)		[static]

Parses a line of text based on a format that is essentially the raw output of the emotiv headset.

override string MCAEmotiv.Interop.EEGDataEntry.ToString

(

)

A CSV string representation which can be parsed by Parse.

EEGDataEntry MCAEmotiv.Interop.EEGDataEntry.WithMarker

(

int

marker

)

Create an identical entry except for the marker field. Re-uses the channel data.

---

Member Data Documentation

const int MCAEmotiv.Interop.EEGDataEntry.EMO_MARKER_DEFAULT = 0

The default marker value returned by the headset 0

const int MCAEmotiv.Interop.EEGDataEntry.MARKER_DEFAULT = -1

A value used to mark the absence of a stimulus -1

const int MCAEmotiv.Interop.EEGDataEntry.MARKER_UNKNOWN = -2

A value used to mark the presentation of an unknown stimulus -2

readonly int MCAEmotiv.Interop.EEGDataEntry.NUM_LINE_FIELDS = Channels.Values.Count + 3 [static]

The number of fields in an entry's ToString output.

const char MCAEmotiv.Interop.EEGDataEntry.SEPARATOR = ','

The separator character used in ToString.

---

Property Documentation

IArrayView<double> MCAEmotiv.Interop.EEGDataEntry.Data [get, set]

The voltage data at each channel.

int MCAEmotiv.Interop.EEGDataEntry.Marker [get, set]

Provides an indication of the current trial.

int MCAEmotiv.Interop.EEGDataEntry.RelativeTimeStamp [get, set]

Time relative to stimulus onset.

double MCAEmotiv.Interop.EEGDataEntry.this[Channel channel] [get]

Provides explicit channel-based access to data.

int MCAEmotiv.Interop.EEGDataEntry.TimeStamp [get, set]

Time in millis.

---

The documentation for this struct was generated from the following file:

• Emotiv/Interop/EEGDataEntry.cs