RAVEAbstarctElectrode: Abstract definition of electrode class in RAVE

In dipterix/ravebase: Base Package for RAVE

Description

Abstract definition of electrode class in RAVE

Abstract definition of electrode class in RAVE

Public fields

type

type of signals captured by electrode

subject

subject instance (RAVESubject)

number

integer stands for electrode number or reference ID

reference

reference electrode, either NULL for no reference or an electrode instance inherits RAVEAbstarctElectrode

epoch

a RAVEEpoch instance

cached_reference

character, refer to current cached reference

is_reference

whether this instance is a reference electrode

Active bindings

exists

whether electrode exists in subject

preprocess_file

path to preprocess 'HDF5' file

power_file

path to power 'HDF5' file

power_cached

path to power 'FST' file

phase_file

path to phase 'HDF5' file

voltage_file

path to voltage 'HDF5' file

reference_name

reference electrode name (field: number)

cache_path

run-time cache path; NA if epoch is missing

Methods

Public methods

• RAVEAbstarctElectrode$.set_cachename()

• RAVEAbstarctElectrode$new()

• RAVEAbstarctElectrode$.set_reference()

• RAVEAbstarctElectrode$set_epoch()

• RAVEAbstarctElectrode$clear_cache()

• RAVEAbstarctElectrode$clear_memory()

---

Method .set_cachename()

set cache name, internally used

Usage

RAVEAbstarctElectrode$.set_cachename(name)

Arguments

name

character, internally used

---

Method new()

constructor

Usage

RAVEAbstarctElectrode$new(subject, number, is_reference = FALSE)

Arguments

subject

character or RAVESubject instance

number

current electrode number or reference ID

is_reference

whether instance is a reference

---

Method .set_reference()

set reference for instance

Usage

RAVEAbstarctElectrode$.set_reference(reference, type)

Arguments

reference

NULL or RAVEAbstarctElectrode instance

type

reference electrode type, default is the same as current instance

---

Method set_epoch()

set epoch instance for the electrode

Usage

RAVEAbstarctElectrode$set_epoch(epoch)

Arguments

epoch

characters or RAVEEpoch instance. For characters, make sure "epoch_<name>.csv" is in meta folder.

---

Method clear_cache()

method to clear cache on hard drive

Usage

RAVEAbstarctElectrode$clear_cache(...)

Arguments

...

passed to child instances

---

Method clear_memory()

method to clear memory

Usage

RAVEAbstarctElectrode$clear_memory(...)

Arguments

...

passed to child instances

dipterix/ravebase documentation built on Sept. 1, 2020, 6:34 p.m.