Package adaptlil.gazepoint.api.recv

Class RecXml

java.lang.Object

adaptlil.gazepoint.api.XmlObject

adaptlil.gazepoint.api.recv.RecXml

public class RecXml
extends XmlObject

Implements GazeAPI for real time processing of gaze data. public class attributes are used to convert this object to a WEKA instance for machine learning. private attributes are generally adaptlil.data_classes that mirror the GazeAPI for a more 'best-practice' development experience Looks ike gaze api doesnt send different rec templates where we have to map. It sends one single rec element with unique attribute ids for each command set.

Field Summary

Fields

Modifier and Type	Field	Description
private BestPointOfGaze	bestPointOfGaze
Boolean	BPOGV
Double	BPOGX
Double	BPOGY
Integer	counter
Integer	CS
private Cursor	cursor
Double	CX	5.13 Cursor position Description: The position of the mouse cursor.
Double	CY
private Fixation	fixation
Double	FPOGD
Integer	FPOGID
Double	FPOGS
Boolean	FPOGV
Double	FPOGX
Double	FPOGY
private LeftEyePointOfGaze	leftEyePointOfGaze
private LeftEyePupil	leftEyePupil
Double	LPCX
Double	LPCY
Double	LPD
Double	LPMM
Boolean	LPMMV
Boolean	LPOGV
Double	LPOGX
Double	LPOGY
Double	LPS
Boolean	LPV
private PupilDiameter	pupilDiameter
private RightEyePointOfGaze	rightEyePointOfGaze
private RightEyePupil	rightEyePupil
Double	RPCX
Double	RPCY
Double	RPD
Double	RPMM
Boolean	RPMMV
Boolean	RPOGV
Double	RPOGX
Double	RPOGY
Double	RPS
Boolean	RPV
private Double	time
Long	timeTick

Constructor Summary

Constructors

Constructor	Description
RecXml()

Method Summary

Modifier and Type	Method	Description
BestPointOfGaze	getBestPointOfGaze()	Returns the data class holder for BestPointOfGaze attributes contained in this data packet.
Boolean	getBPOGV()
Double	getBPOGX()
Double	getBPOGY()
Integer	getCounter()
Integer	getCS()
Cursor	getCursor()
Double	getCX()
Double	getCY()
Fixation	getFixation()	Returns the data class holder for the Fixation attributes contained in the packet.
Double	getFPOGD()
Integer	getFPOGID()
Double	getFPOGS()
Boolean	getFPOGV()
Double	getFPOGX()
Double	getFPOGY()
LeftEyePointOfGaze	getLeftEyePointOfGaze()	Returns the data class holder for the LeftPointOfGaze attributes contained in this
LeftEyePupil	getLeftEyePupil()	Returns the data class holder for the LeftEyePupil attributes contained
Double	getLPCX()
Double	getLPCY()
Double	getLPD()
Double	getLPMM()
Boolean	getLPMMV()
Boolean	getLPOGV()
Double	getLPOGX()
Double	getLPOGY()
Double	getLPS()
Boolean	getLPV()
PupilDiameter	getPupilDiameter()	Data class holder for PupilDiameter attributes of the (This)
RightEyePointOfGaze	getRightEyePointOfGaze()	Returns the data class holder for the RightEyePointOfGaze attributes contained in this
RightEyePupil	getRightEyePupil()	Returns the RightEyePupil data class for the attributes contained in the (this)
Double	getRPCX()
Double	getRPCY()
Double	getRPD()
Double	getRPMM()
Boolean	getRPMMV()
Boolean	getRPOGV()
Double	getRPOGX()
Double	getRPOGY()
Double	getRPS()
Boolean	getRPV()
Double	getTime()
Long	getTimeTick()
boolean	hasInvalidAttributes()
RecXml[]	interpolate(RecXml first, RecXml last, List<RecXml> packetsBetweenFirstAndLast, int steps)	Interpolates all data attributes of a RECXml object.
void	setBestPointOfGaze(BestPointOfGaze bestPointOfGaze)	Sets the bestPointOfGaze attribute and its relative GazePoitn data metrics [e.g.
void	setFixation(Fixation fixation)	Sets the fixation object and the relative GazePoint Data metric names [e.g.
void	setLeftEyePointOfGaze(LeftEyePointOfGaze leftEyePointOfGaze)	Sets the leftEyePointOfGaze attribute and its relative GazePoint data metrics [e.g.
void	setLeftEyePupil(LeftEyePupil leftEyePupil)	Sets the LeftEyePupil attribute and its relative GazePoint data metrics [e.g.
void	setPupilDiameter(PupilDiameter pupilDiameter)	Sets the PupilDiameter attribute of this class and its relative GazePoint data metrics [e.g.
void	setRightEyePointOfGaze(RightEyePointOfGaze rightEyePointOfGaze)	Sets the rightEyePointOfGaze attribute and its relative GazePoint data metrics [e.g.
void	setRightEyePupil(RightEyePupil rightEyePupil)	Sets the RightEyePupil attribute and its relative GazePoint data metrics [e.g.
void	setTime(Double time)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

fixation

private Fixation fixation

cursor

private Cursor cursor

bestPointOfGaze

private BestPointOfGaze bestPointOfGaze

leftEyePointOfGaze

private LeftEyePointOfGaze leftEyePointOfGaze

rightEyePointOfGaze

private RightEyePointOfGaze rightEyePointOfGaze

leftEyePupil

private LeftEyePupil leftEyePupil

rightEyePupil

private RightEyePupil rightEyePupil

pupilDiameter

private PupilDiameter pupilDiameter

FPOGX

public Double FPOGX

FPOGY

public Double FPOGY

FPOGS

public Double FPOGS

FPOGD

public Double FPOGD

FPOGID

public Integer FPOGID

FPOGV

public Boolean FPOGV

BPOGX

public Double BPOGX

BPOGY

public Double BPOGY

BPOGV

public Boolean BPOGV

LPOGX

public Double LPOGX

LPOGY

public Double LPOGY

LPOGV

public Boolean LPOGV

RPOGX

public Double RPOGX

RPOGY

public Double RPOGY

RPOGV

public Boolean RPOGV

LPCX

public Double LPCX

LPCY

public Double LPCY

LPD

public Double LPD

LPS

public Double LPS

LPV

public Boolean LPV

RPCX

public Double RPCX

RPCY

public Double RPCY

RPD

public Double RPD

RPS

public Double RPS

RPV

public Boolean RPV

LPMM

public Double LPMM

LPMMV

public Boolean LPMMV

RPMMV

public Boolean RPMMV

RPMM

public Double RPMM

CX

public Double CX

5.13 Cursor position Description: The position of the mouse cursor. Parameter ID: CX, CY Parameter type: float Parameter description: The X- and Y-coordinates of the mouse cursor, as percentage of the screen size. Parameter ID: CS (0 for idle, 1 for left mouse button down, 2 for right button down, 3 for left button up, 4 for right button up. Parameter type: integer Parameter description: Mouse cursor state, 0 for steady state, 1 for left button down, 2 for right button down, 3 for left button up, 4 for right button up

CY

public Double CY

CS

public Integer CS

counter

public Integer counter

time

private Double time

timeTick

public Long timeTick

Constructor Details

RecXml

public RecXml()

Method Details

getFixation

public Fixation getFixation()

Returns the data class holder for the Fixation attributes contained in the packet.

Returns:

Fixation

getBestPointOfGaze

public BestPointOfGaze getBestPointOfGaze()

Returns the data class holder for BestPointOfGaze attributes contained in this data packet.

Returns:

BestPointOfGaze

getLeftEyePointOfGaze

public LeftEyePointOfGaze getLeftEyePointOfGaze()

Returns the data class holder for the LeftPointOfGaze attributes contained in this

Returns:

LeftEyePointOfGaze

getRightEyePointOfGaze

public RightEyePointOfGaze getRightEyePointOfGaze()

Returns the data class holder for the RightEyePointOfGaze attributes contained in this

Returns:

RightEyePointOfGaze

getLeftEyePupil

public LeftEyePupil getLeftEyePupil()

Returns the data class holder for the LeftEyePupil attributes contained

Returns:

LeftEyePupil

getRightEyePupil

public RightEyePupil getRightEyePupil()

Returns the RightEyePupil data class for the attributes contained in the (this)

Returns:

RightEyePupil

getPupilDiameter

public PupilDiameter getPupilDiameter()

Data class holder for PupilDiameter attributes of the (This)

Returns:

getCursor

public Cursor getCursor()

getFPOGX

public Double getFPOGX()

getFPOGY

public Double getFPOGY()

getFPOGS

public Double getFPOGS()

getFPOGD

public Double getFPOGD()

getFPOGID

public Integer getFPOGID()

getFPOGV

public Boolean getFPOGV()

getCX

public Double getCX()

getCY

public Double getCY()

getCS

public Integer getCS()

getCounter

public Integer getCounter()

getTime

public Double getTime()

getBPOGX

public Double getBPOGX()

getBPOGY

public Double getBPOGY()

getBPOGV

public Boolean getBPOGV()

getLPOGX

public Double getLPOGX()

getLPOGY

public Double getLPOGY()

getLPOGV

public Boolean getLPOGV()

getRPOGX

public Double getRPOGX()

getRPOGY

public Double getRPOGY()

getRPOGV

public Boolean getRPOGV()

getLPCX

public Double getLPCX()

getLPCY

public Double getLPCY()

getLPD

public Double getLPD()

getLPS

public Double getLPS()

getLPV

public Boolean getLPV()

getRPCX

public Double getRPCX()

getRPCY

public Double getRPCY()

getRPD

public Double getRPD()

getRPS

public Double getRPS()

getRPV

public Boolean getRPV()

getLPMM

public Double getLPMM()

getLPMMV

public Boolean getLPMMV()

getRPMMV

public Boolean getRPMMV()

getRPMM

public Double getRPMM()

getTimeTick

public Long getTimeTick()

setFixation

public void setFixation(Fixation fixation)

Sets the fixation object and the relative GazePoint Data metric names [e.g. FPOGX, FPOGY]

Parameters:

fixation -

setBestPointOfGaze

public void setBestPointOfGaze(BestPointOfGaze bestPointOfGaze)

Sets the bestPointOfGaze attribute and its relative GazePoitn data metrics [e.g. BPOGX, BPOGY]

Parameters:

bestPointOfGaze - The object to set the RecXmlObject bestPointOfGaze attribute to.

setLeftEyePointOfGaze

public void setLeftEyePointOfGaze(LeftEyePointOfGaze leftEyePointOfGaze)

Sets the leftEyePointOfGaze attribute and its relative GazePoint data metrics [e.g. LPOGX, LPOGY]

Parameters:

leftEyePointOfGaze - The object to set the RecXmlObject leftEyePointOfGaze attribute to.

setRightEyePointOfGaze

public void setRightEyePointOfGaze(RightEyePointOfGaze rightEyePointOfGaze)

Sets the rightEyePointOfGaze attribute and its relative GazePoint data metrics [e.g. RPOGX, RPOGY]

Parameters:

rightEyePointOfGaze - The actual param to set the RecXmlObject.rightEyePointOfGaze to.

setLeftEyePupil

public void setLeftEyePupil(LeftEyePupil leftEyePupil)

Sets the LeftEyePupil attribute and its relative GazePoint data metrics [e.g. LPV, LPCX, LPCY, LPD]

Parameters:

leftEyePupil - the actual param to set the RecXmlObject.leftEyePupil to.

setRightEyePupil

public void setRightEyePupil(RightEyePupil rightEyePupil)

Sets the RightEyePupil attribute and its relative GazePoint data metrics [e.g. RPCX, RPCY, RPV, RPD]

Parameters:

rightEyePupil - the actual param to set the RecXmlObject.rightEyePupil to.

setPupilDiameter

public void setPupilDiameter(PupilDiameter pupilDiameter)

Sets the PupilDiameter attribute of this class and its relative GazePoint data metrics [e.g. RPMM, RPMMV, LPMM, LPMMV]

Parameters:

pupilDiameter - The actual param to set the RecXmlObject.pupilDiameter to.

setTime

public void setTime(Double time)

interpolate

public RecXml[] interpolate(RecXml first,
 RecXml last,
 List<RecXml> packetsBetweenFirstAndLast,
 int steps)

Interpolates all data attributes of a RECXml object. This means if the packets contained BestPointofGaze and PupilDiameter, this function will interpolate those two attributes between the first packet and the last packet.

Parameters:

first -

last -

packetsBetweenFirstAndLast - Optional array. If only a few attributes of the packets between first and last are marked as invalid, we can use this function to interpolate on those marked as invalid. Otherwise, if we leave this as null, this function will interpolate ALL attributes for ALL packets between first and last.

steps -

Returns:

hasInvalidAttributes

public boolean hasInvalidAttributes()