Configuration

Functions for parsing sideeye configurations from JSON files, and validating sideeye configuration dictionaries.

class sideeye.config.ASCParsingConfig(asc_config: Dict[str, Union[int, bool]] = {})

ASC parser configuration.

fixation_min_cutoff

Minimum cutoff for including a fixation.

Type:Union[int, bool]
max_saccade_dur

Maximum cutoff for saccade duration.

Type:Union[int, bool]

Maximum number of blinks before trial exclusion.

Type:Union[int, bool]

Maximum blink duration before trial exclusion.

Type:Union[int, bool]
Parameters:asc_config (Dict) – ASC configuration dictionary.
class sideeye.config.Configuration(config_file: str = None)

SideEye configuration.

wide_format

Whether output should be in wide (True) or long (False) format.

Type:bool
da1_fields

DA1 file configuration.

Type:DA1Config
region_fields

Region file configuration.

Type:RegionConfig
asc_parsing

ASC file configuration.

Type:ASCParsingConfig
cutoffs

Fixation cutoff configuration.

Type:CutoffsConfig
measures

Configuration for calculating measures.

Type:MeasuresConfig
output

Output file configuration.

Type:OutputConfig
terminal_output

Verbose output level.

Type:int
Parameters:config_file (Optional[str]) – Path to configuration JSON file.
class sideeye.config.CutoffsConfig(cutoffs: Dict[str, Union[int, bool]] = {})

Fixation cutoff configuration.

min

Minimum cutoff for fixations.

Type:int
max

Maximum cutoff for fixations.

Type:int
include_fixation

Whether excluded fixations should be included in saccade duration.

Type:bool
include_saccades

Whether the saccades into and out of an excluded fixation should be included in saccade duration.

Type:bool
Parameters:cutoffs (dict) – Cutoff configuration dictionary.
class sideeye.config.DA1Config(da1_config: Dict[str, int] = {})

DA1 parser configuration.

index

Trial index column.

Type:int
condition

Item condition column.

Type:int
number

Item number column.

Type:int
time

Total trial time column.

Type:int
fixation_start

Column number of first fixation

Type:int
Parameters:da1_config (Dict) – DA1 configuration dictionary.
class sideeye.config.MeasuresConfig(region_measures: Dict[str, Dict[str, Union[int, str]]], trial_measures: Dict[str, Dict[str, Union[int, str]]])

Region measure configuration.

region

Output configuration for region measures.

Type:Dict[str, OutputColumnConfig]
trial

Output configuration for trial measures.

Type:Dict[str, OutputColumnConfig]
all

Output configuration for all measures.

Type:Dict[str, OutputColumnConfig]
names

List of all measure names.

Type:List[str]
Parameters:
  • region_measures (Dict[str, Dict]) – Region measure configuration dictionary.
  • trial_measures (Dict[str, Dict]) – Trial measure configuration dictionary.
class sideeye.config.OutputColumnConfig(measure: str, measure_config: Dict[str, Union[int, str]] = {})

Configuration for a single output column.

cutoff

Cutoff for excluding measure from output.

Type:int
header

Name of column in output file.

Type:str
Parameters:
  • measure (str) – Name of measure.
  • measure_config (Dict) – Measure configuration dictionary.
class sideeye.config.OutputConfig(region_output: Dict[str, Dict[str, Union[int, str]]], trial_output: Dict[str, Dict[str, Union[int, str]]])

Output column configuration.

class sideeye.config.RegionConfig(region_config: Dict[str, Union[int, bool]] = {})

Region parser configuration.

number

Item number column.

Type:int
condition

Condition label column.

Type:int
boundaries_start

First region boundary column position.

Type:int
includes_y

Whether or not y values are included in the region file.

Type:bool
Parameters:region_config (Dict) – Region configuration dictionary.
sideeye.config.validate_key(config_dict: Dict[str, Any], key: str, value_type: type, default: Any)

Returns config_dict[key] if the value exists and if of type value_type, otherwise returns a default value.