Annotation Fields

Every CacheFile has one or more original files. Each file comes with original annotations stored in its MetaData. Additionally, each TraceData within its own set of annotations. There is a set of fields common to all OriginAnnotations and TraceAnnotations, but they also have additional fields which depend on the type of readin / readout used.

Generic MetaData fields implemented in all readouts

valid_trace_keys = ['id', 'event_name', 'event_sample', 'event_time', 'onset_shift', 'time_since_last_pulse_in_s', 'reject', 'comment', 'examiner']

information contained in every trace, regardless of readout

can_vary_across_merged_files = ['global_comment', 'filedate']

information about the origin file

must_be_identical_in_merged_file = ['channel_labels', 'channel_of_interest', 'samples_post_event', 'samples_pre_event', 'samplingrate', 'subject', 'readout', 'readin', 'version']

must be identical across original files merged into this cachefile

Contralateral MEPs induced by single pulse TMS

This is a readout for a single channel EMG response evoked by single pulse transcranial magnetic stimulation. As this will be a single-channel-readout with a relatively clear waveform, we store only the magnitude of the first negative and positive peak and the zero-crossing latency.

valid_keys = ['stimulation_intensity_mso', 'stimulation_intensity_didt', 'neg_peak_magnitude_uv', 'neg_peak_latency_ms', 'pos_peak_magnitude_uv', 'pos_peak_latency_ms', 'zcr_latency_ms', 'xyz_coords', 'channel_of_interest']

valid keys for tms-cmep (formerly know as ‘contralateral-mep’)

Ipsilateral MEPs induced by single pulse TMS

This is a readout for a single channel EMG response evoked by single pulse transcranial magnetic stimulation. As this will be a single-channel-readout with a relatively clear waveform, we store only the magnitude of the first negative and positive peak and the zero-crossing latency.

valid_keys = ['stimulation_intensity_mso', 'stimulation_intensity_didt', 'stimulation_intensity_mso', 'stimulation_intensity_didt', 'neg_peak_magnitude_uv', 'neg_peak_latency_ms', 'pos_peak_magnitude_uv', 'pos_peak_latency_ms', 'zcr_latency_ms', 'xyz_coords', 'imep_occurence', 'imep_latency', 'imep_magnitude', 'estimation_method', 'xyz_coords', 'channel_of_interest', 'target_phase', 'exact_phase']

valid keys for tms-imep

ERPs induced by single pulse TMS

This is a readout for EEG responses evoked by single pulse transcranial magnetic stimulation. As this will be a multi-channel-readout, there would be a tremendous amount of peaks and latencies. Therefore, we only store the GMFP trace results in the metadata.

valid_keys = ['stimulation_intensity_mso', 'stimulation_intensity_didt', 'xyz_coords', 'gmfp_neg_peaks_magnitude_uv', 'gmfp_neg_peaks_latency_ms', 'gmfp_pos_peaks_magnitude_uv', 'gmfp_pos_peaks_latency_ms', 'gmfp_zcr_latencies_ms']

valid keys for tms-erp