Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consolidated PR for #109 to #112, #139, #135. #137, #138 #140

Merged
merged 17 commits into from
Feb 26, 2024
Merged

Consolidated PR for #109 to #112, #139, #135. #137, #138 #140

merged 17 commits into from
Feb 26, 2024

Conversation

VisLab
Copy link
Member

@VisLab VisLab commented Feb 21, 2024

No description provided.

@VisLab VisLab mentioned this pull request Feb 21, 2024
@VisLab VisLab mentioned this pull request Feb 21, 2024
@VisLab VisLab changed the title Modified description of word as per issue #112 Consolidated PR for #109 to #112, #139, #135. #137, #138 Feb 21, 2024
@VisLab
Copy link
Member Author

VisLab commented Feb 21, 2024

This is a consolidated PR for the items that the HWG has discussed for updates to 8.3.0. Please review carefully for discussion.

@IanCa
Copy link
Member

IanCa commented Feb 22, 2024

I don't see any mistakes in the units/values/etc sections from what we discussed.

Are we still planning to update the allowedCharacters on value classes for this release?

@VisLab
Copy link
Member Author

VisLab commented Feb 22, 2024

I don't see any mistakes in the units/values/etc sections from what we discussed.

Are we still planning to update the allowedCharacters on value classes for this release?

Yes -- haven't gotten to it yet.

Attached is a summary of the changes --- as generated by the new schema comparison tool (Thx @IanCa). In the current PR, I just changed degree Celsius to degree-Celsius as the unit wasn't supposed to have a space according to the rules. However, I am wondering whether I should leave both in and add the deprecatedFrom=8.3.0 to degree Celsius.
HED8.2.0_HED8.3.0_differences.txt.

Copy link
Member

@neuromechanist neuromechanist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 😊

@@ -487,13 +487,16 @@ Each term in this vocabulary has a human-readable description and may include ad
**** Female <nowiki>[Biological sex of an individual with female sexual organs such ova.]</nowiki>
**** Male <nowiki>[Biological sex of an individual with male sexual organs producing sperm.]</nowiki>
**** Intersex <nowiki>[Having genitalia and/or secondary sexual characteristics of indeterminate sex.]</nowiki>
**** Other-sex <nowiki>[A non-specific designation of sexual traits.]</nowiki>
*** Ethnicity <nowiki>[Belong to a social group that has a common national or cultural tradition. Use with Label to avoid extension.]</nowiki>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldnt this refer to a population or culture within which the ethnicity references?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you make a specific wording suggestion. Ethnicity isn't in BIDS so we are not constrained by a particular definitions. Thx @smakeig

@IanCa
Copy link
Member

IanCa commented Feb 22, 2024

There seems to be something wrong validating deprecatedFrom. I'm looking into it...

Source tag: Item/Biological-item/Anatomical-item/Body-part/Torso/Gentalia
	Source Attribute: deprecatedFrom
		SCHEMA_ATTRIBUTE_VALUE_INVALID: (Warning) 'Item/Biological-item/Anatomical-item/Body-part/Torso/Gentalia' has invalid or unknown value in attribute deprecatedFrom: '8.1.0'.
Source tag: Item/Object/Man-made-object/Device/Measurement-device/Clock/Clock-face
	Source Attribute: deprecatedFrom
		SCHEMA_ATTRIBUTE_VALUE_INVALID: (Warning) 'Item/Object/Man-made-object/Device/Measurement-device/Clock/Clock-face' has invalid or unknown value in attribute deprecatedFrom: '8.3.0'.

Fixed by this PR, it just hasn't been added to main develop branch yet:
hed-standard/hed-python#867

README.md Outdated Show resolved Hide resolved
standard_schema/prerelease/HED8.3.0.mediawiki Show resolved Hide resolved
standard_schema/prerelease/HED8.3.0.mediawiki Outdated Show resolved Hide resolved
@VisLab
Copy link
Member Author

VisLab commented Feb 26, 2024

As discussed with HWG -- this PR is being merged so that changes will be available in the prerelease schema viewer. Comments are still possible as the schema itself is not being released yet.

@VisLab VisLab marked this pull request as ready for review February 26, 2024 19:46
@VisLab VisLab merged commit 02d1e3a into hed-standard:main Feb 26, 2024
1 check failed
@dorahermes
Copy link
Member

I would like to add the different EEG artifact types to the main HED schema. Would you like me to open a pull request?

Biological artifacts would include the following:

    ** Eye-blink-artifact <nowiki>[Example for EEG: Fp1/Fp2 become electropositive with eye closure because the cornea is positively charged causing a negative deflection in Fp1/Fp2. If the eye blink is unilateral, consider prosthetic eye. If it is in F8 rather than Fp2 then the electrodes are plugged in wrong. (Source: Beniczky ea 2013, Appendix S7; Beniczky ea 2017, Table 15.)]</nowiki>
    ** Eye-movement-horizontal-artifact <nowiki>[Example for EEG: There is an upward deflection in the Fp2-F8 derivation, when the eyes move to the right side. In this case F8 becomes more positive and therefore. When the eyes move to the left, F7 becomes more positive and there is an upward deflection in the Fp1-F7 derivation. (Source: Beniczky ea 2013, Appendix S7; Beniczky ea 2017, Table 15.)]</nowiki>
    ** Eye-movement-vertical-artifact <nowiki>[Example for EEG: The EEG shows positive potentials (50-100 micro V) with bi-frontal distribution, maximum at Fp1 and Fp2, when the eyeball rotated upward. The downward rotation of the eyeball was associated with the negative deflection. The time course of the deflections was similar to the time course of the eyeball movement. (Source: Beniczky ea 2013, Appendix S7; Beniczky ea 2017, Table 15.)]</nowiki>
    ** Slow-eye-movement-artifact <nowiki>[Slow, rolling eye-movements, seen during drowsiness. (Source: Beniczky ea 2013, Appendix S7.)]</nowiki>
    ** Nystagmus-artifact <nowiki>[Source: Beniczky ea 2017, Table 15.]</nowiki>
    ** Chewing-artifact <nowiki>[Source: Beniczky ea 2017, Table 15.]</nowiki>
    ** Sucking-artifact <nowiki>[Source: Beniczky ea 2017, Table 15.]</nowiki>
    ** Glossokinetic-artifact <nowiki>[The tongue functions as a dipole, with the tip negative with respect to the base. The artifact produced by the tongue has a broad potential field that drops from frontal to occipital areas, although it is less steep than that produced by eye movement artifacts. The amplitude of the potentials is greater inferiorly than in parasagittal regions; the frequency is variable but usually in the delta range. Chewing and sucking can produce similar artifacts. (Source: Beniczky ea 2013, Appendix S7; Beniczky ea 2017, Table 15.)]</nowiki>
    ** Rocking-patting-artifact <nowiki>[Quasi-rhythmical artifacts in recordings from infants caused by rocking/patting. (Source: Beniczky ea 2013, Appendix S7; Beniczky ea 2017, Table 15.)]</nowiki>
    ** Movement-artifact <nowiki>[Example for EEG: Large amplitude artifact, with irregular morphology (usually resembling a slow-wave or a wave with complex morphology) seen in one or several channels, due to movement. If the causing movement is repetitive, the artifact might resemble a rhythmic EEG activity. (Source: Beniczky ea 2013, Appendix S7; Beniczky ea 2017, Table 15.)]</nowiki>
    ** Respiration-artifact <nowiki>[Respiration can produce 2 kinds of artifacts. One type is in the form of slow and rhythmic activity, synchronous with the body movements of respiration and mechanically affecting the impedance of (usually) one electrode. The other type can be slow or sharp waves that occur synchronously with inhalation or exhalation and involve those electrodes on which the patient is lying. (Source: Beniczky ea 2013, Appendix S7; Beniczky ea 2017, Table 15.)]</nowiki>
    ** Pulse-artifact <nowiki>[Example for EEG: Occurs when an EEG electrode is placed over a pulsating vessel. The pulsation can cause slow waves that may simulate EEG activity. A direct relationship exists between ECG and the pulse waves (200-300 millisecond delay after ECG equals QRS complex). (Source: Beniczky ea 2013, Appendix S7; Beniczky ea 2017, Table 15.)]</nowiki>
    ** ECG-artifact <nowiki>[Example for EEG: Far-field potential generated in the heart. The voltage and apparent surface of the artifact vary from derivation to derivation and, consequently, from montage to montage. The artifact is observed best in referential montages using earlobe electrodes A1 and A2. ECG artifact is recognized easily by its rhythmicity/regularity and coincidence with the ECG tracing. (Source: Beniczky ea 2013, Appendix S7; Beniczky ea 2017, Table 15.)]</nowiki>
    ** Sweat-artifact <nowiki>[Is a low amplitude undulating waveform that is usually greater than 2 seconds and may appear to be an unstable baseline. (Source: Beniczky ea 2013, Appendix S7; Beniczky ea 2017, Table 15.)]</nowiki>
    ** EMG-artifact <nowiki>[Myogenic potentials are the most common artifacts. Frontalis and temporalis muscles (ex..: clenching of jaw muscles) are common causes. Generally, the potentials generated in the muscles are of shorter duration than those generated in the brain. The frequency components are usually beyond 30-50 Hz, and the bursts are arrhythmic. (Source: Beniczky ea 2013, Appendix S7; Beniczky ea 2017, Table 15.)]</nowiki>

Non-biological artifacts would include the following:

    ** Power-supply-artifact <nowiki>[50-60 Hz artifact. Monomorphic waveform due to 50 or 60 Hz A/C power supply. (Source: Beniczky ea 2013, Appendix S7; Beniczky ea 2017, Table 15.)]</nowiki>
    ** Induction-artifact <nowiki>[Artifacts (usually of high frequency) induced by nearby equipment (like in the intensive care unit). (Source: Beniczky ea 2013, Appendix S7; Beniczky ea 2017, Table 15.)]</nowiki>
    ** Dialysis-artifact <nowiki>[Source: Beniczky ea 2017, Table 15.]</nowiki>
    ** Artificial-ventilation-artifact <nowiki>[Source: Beniczky ea 2017, Table 15.]</nowiki>
    ** Electrode-pops-artifact <nowiki>[Brief discharges with a very steep upslope and shallow fall that occur in all leads which include that electrode. (Source: Beniczky ea 2013, Appendix S7; Beniczky ea 2017, Table 15.)]</nowiki>
    ** Salt-bridge-artifact <nowiki>[Typically occurs in 1 channel which may appear isoelectric. Only seen in bipolar montage. (Source: Beniczky ea 2013, Appendix S7; Beniczky ea 2017, Table 15.)]</nowiki>

@VisLab
Copy link
Member Author

VisLab commented Mar 7, 2024

I agree we should add artifacts, but lets have a HED Working Group discussion about how artifacts will evolve to include specific artifacts from other modalities. What are the artifact concerns for IEEG? Are there fMRI artifacts that would fall under these tags?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants