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

[SCHEMA] bep012 functional derivatives #1209

Open
wants to merge 29 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
5cb8bef
Merge branch 'schema/common_derivatives' of github.com:rwblair/bids-s…
rwblair Apr 19, 2022
ceb3cd8
Merge branch 'schema/common_derivatives' of github.com:rwblair/bids-s…
rwblair Apr 20, 2022
49cdb82
incomplete first pass at bep012 schema
rwblair Apr 20, 2022
4ac9a38
Merge branch 'master' of github.com:bids-standard/bids-specification …
rwblair Aug 15, 2022
a5c130f
expand bep12 datatypes
rwblair Aug 16, 2022
daa0cc2
Merge branch 'master' of github.com:bids-standard/bids-specification …
rwblair Aug 16, 2022
aa0fb95
would help if I actually committed the files.
rwblair Aug 16, 2022
fee20fb
fix missing quote
rwblair Aug 17, 2022
7452a99
Update src/schema/rules/sidecars/derivatives/functional_derivatives.yaml
rwblair Aug 18, 2022
262b4c6
Update src/schema/rules/datatypes/derivatives/functional_derivatives.…
rwblair Aug 19, 2022
6c67e9a
Update src/schema/rules/datatypes/derivatives/functional_derivatives.…
rwblair Aug 19, 2022
fde5ddd
Update src/schema/rules/datatypes/derivatives/functional_derivatives.…
rwblair Aug 19, 2022
06122bb
Update src/schema/rules/datatypes/derivatives/functional_derivatives.…
rwblair Aug 19, 2022
d10b4f6
Update src/schema/objects/columns.yaml
rwblair Aug 19, 2022
08f1e38
Update src/schema/rules/datatypes/derivatives/functional_derivatives.…
rwblair Aug 19, 2022
65ce47f
Update src/schema/rules/datatypes/derivatives/functional_derivatives.…
rwblair Aug 19, 2022
34ad6c3
Update src/schema/rules/datatypes/derivatives/functional_derivatives.…
rwblair Aug 19, 2022
203e2b3
Update src/schema/rules/datatypes/derivatives/functional_derivatives.…
rwblair Aug 19, 2022
c3a3204
Update src/schema/rules/datatypes/derivatives/functional_derivatives.…
rwblair Aug 19, 2022
931ae95
Update src/schema/rules/datatypes/derivatives/functional_derivatives.…
rwblair Aug 19, 2022
1178463
Update src/schema/rules/datatypes/derivatives/functional_derivatives.…
rwblair Aug 19, 2022
9a592ce
Update src/schema/rules/datatypes/derivatives/functional_derivatives.…
rwblair Aug 19, 2022
09fb799
Update src/schema/rules/datatypes/derivatives/functional_derivatives.…
rwblair Aug 19, 2022
137af27
Merge remote-tracking branch 'upstream/master' into schema/bep012
effigies Aug 19, 2022
b2ba2db
Add suffix definitions.
tsalo Aug 22, 2022
21c0a20
Add extension definitions.
tsalo Aug 22, 2022
daa34cc
Update suffixes.yaml
tsalo Aug 22, 2022
c0c6993
Add metadata fields.
tsalo Aug 22, 2022
e4ffa0b
Merge pull request #1 from tsalo/schema-bep012-tsalo
rwblair Aug 23, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 87 additions & 0 deletions src/schema/objects/columns.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,17 @@ color:
Hexadecimal. Label color for visualization.
type: string
unit: hexadecimal
compcor:
name: '[a|t|w|c]_compcor_cor_[0-9a-zA-Z]+'
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just FTR (attn @bendichter) something similarish came up in BEP032 context where for different shape of electrodes we would like to have columns describring the shapes, e.g.

name   shape   shape_radius  shape_width
1      square       n/a         1
2      circle        1         n/a

display_name: CompCor
description: |
CompCor (Behzadi, et al., 2007) calculated with voxels chosen based on:
a: anatomically derived ROIs (white matter and CSF),
t: temporal variance, w: white matter voxels only, c: CSF voxels only
cosine_x:
name: ^cosine_[0-9a-zA-Z]+$
Copy link
Member

Choose a reason for hiding this comment

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

These new regex-based names are new. I think having regex-based names fits, but one other novel aspect is that the columns will have a one-to-many relationship. All other columns and metadata fields have had one-to-one mappings so far (one object definition for each column/field). Do we need an additional field in the object schema to account for this?

display_name: Cosine <X>
description: Discrete cosine basis vectors
derived_from:
name: derived_from
display_name: Derived from
Expand Down Expand Up @@ -88,13 +99,24 @@ duration:
- type: string
enum:
- n/a
dvars:
name: dvars
display_name: DVARS
description: Change in variance (Brett, 2006, Power, et al., 2012)
type: number
filename:
name: filename
display_name: Filename
description: |
Relative paths to files.
type: string
format: participant_relative
framwise_displacement:
name: framewise_displacement
display_name: Framwise Displacement
description: Framewise displacement (Power, et al., 2012)
type: number
unit: mm
group__channel:
name: group
display_name: Channel group
Expand Down Expand Up @@ -179,6 +201,14 @@ index:
description: |
The label integer index.
type: integer
legendre_x:
name: ^legendre_[0-9a-zA-Z]+$
display_name: Legendre <X>
description: Legendre polynomial basis vectors
non_steady_state_x:
name: ^non_steady_state_[0-9a-zA-Z]+$
display_name: Non Steady State <X>
description: Initial non-steady-state volumes. One column per volume.
low_cutoff:
name: low_cutoff
display_name: Low cutoff
Expand All @@ -204,6 +234,10 @@ mapping:
description: |
Corresponding integer label in the standard BIDS label lookup.
type: integer
melodic:
name: ^melodic_[0-9a-zA-Z]+$
display_name: FSL MELODIC
description: Columns from the mixing matrix in FSL MELODIC
material:
name: material
display_name: Electrode material
Expand Down Expand Up @@ -341,6 +375,36 @@ response_time:
- type: string
enum:
- n/a
rmsd:
name: rmsd
display_name: Root Mean Square Derivation
description: Root mean square deviation (Jenkinson, 1999)
type: number
unit: mm
rms:
name: rms
display_name: Root Mean Square
description: Root mean square of translation parameters (Van Dijk, et al., 2012)
type: number
unit: mm
rot_x:
name: rot_x
display_name: X Axis Rotation
description: Rotation parameters
type: number
unit: rad
rot_y:
name: rot_y
display_name: Y Axis Rotation
description: Rotation parameters
type: number
unit: rad
rot_z:
name: rot_z
display_name: Z Axis Rotation
description: Rotation parameters
type: number
unit: rad
sample:
name: sample
display_name: Sample index
Expand Down Expand Up @@ -470,6 +534,11 @@ status_description:
Freeform text description of noise or artifact affecting data quality on the channel.
It is meant to explain why the channel was declared bad in the `status` column.
type: string
std_dvars:
name: std_dvars
display_name: Standardized DVARS
description: Standardized DVARS (Nichols, 2013)
type: number
stim_file:
name: stim_file
display_name: Stimulus file
Expand Down Expand Up @@ -508,6 +577,24 @@ time:
For example, 5.
type: number
unit: s
trans_x:
name: trans_x
display_name: X Axis Translation
description: Translation parameters
type: number
unit: mm
trans_y:
name: trans_y
display_name: Y Axis Translation
description: Translation parameters
type: number
unit: mm
trans_z:
name: trans_z
display_name: Z Axis Translation
description: Translation parameters
type: number
unit: mm
trial_type:
name: trial_type
display_name: Trial type
Expand Down
14 changes: 14 additions & 0 deletions src/schema/objects/extensions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,13 @@ dlabelnii:
description: |
A CIFTI-2 dense label file.

This extension may only be used in derivative datasets.
dtseriesnii:
value: .dtseries.nii
display_name: Timeseries CIFTI File
description: |
A CIFTI timeseries file.

This extension may only be used in derivative datasets.
edf:
value: .edf
Expand Down Expand Up @@ -251,6 +258,13 @@ tif:
display_name: Tag Image File Format
description: |
A [Tag Image File Format](https://en.wikipedia.org/wiki/TIFF) file.
timegii:
value: .time.gii
display_name: Surface timeseries
description: |
Surface timeseries.

This extension may only be used in derivative datasets.
trg:
value: .trg
display_name: KRISS TRG
Expand Down
24 changes: 24 additions & 0 deletions src/schema/objects/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,12 @@ BackgroundSuppressionPulseTime:
type: number
minimum: 0
unit: s
BandpassFilter:
name: BandpassFilter
display_name: Bandpass Filter
description: |
String describing all relevant parameters of the applied bandpass filter.
type: string
BasedOn:
name: BasedOn
display_name: Based On
Expand Down Expand Up @@ -1878,6 +1884,12 @@ MetaboliteRecoveryCorrectionApplied:
If `true`, the `hplc_recovery_fractions` column MUST be present in the
corresponding `*_blood.tsv` file.
type: boolean
Method:
name: Method
display_name: Method
description: |
String describing method used to calculate measure.
type: string
MiscChannelCount:
name: MiscChannelCount
display_name: Misc Channel Count
Expand Down Expand Up @@ -1955,6 +1967,12 @@ NegativeContrast:
usage of a contrast agent in conjunction with a T2\* weighted acquisition
protocol.
type: boolean
Neighborhood:
name: Neighborhood
display_name: Neighborhood
description: |
String describing neighborhood for regional measures.
type: string
NonlinearGradientCorrection:
name: NonlinearGradientCorrection
display_name: Nonlinear Gradient Correction
Expand Down Expand Up @@ -2997,6 +3015,12 @@ TermURL:
URL pointing to a formal definition of this type of data in an ontology
available on the web.
type: string
Threshold:
name: Threshold
display_name: Threshold
description: |
String describing threshold used for determining graph edges.
type: string
TimeZero:
name: TimeZero
display_name: Time Zero
Expand Down
Loading