Class: OtherModality¶
An acquisition whose modality has no class of its own: MEG, SPECT, and other. Nothing here is normalized, so this is where a modality the schema does not name keeps its parameters. A parameter that MRI, EEG, FNIRS, or PET has no field for belongs on that sibling class instead.
classDiagram
class OtherModality
click OtherModality href "../OtherModality/"
Acquisition <|-- OtherModality
click Acquisition href "../Acquisition/"
OtherModality : acquisition_duration_seconds
OtherModality : acquisition_type
OtherModality : brain_coverage
OtherModality --> "0..1" BrainCoverage : brain_coverage
click BrainCoverage href "../BrainCoverage/"
OtherModality : device
OtherModality --> "0..1" Device : device
click Device href "../Device/"
OtherModality : id
OtherModality : modality
OtherModality : modality_label
OtherModality : reason_no_modality_class_used
Inheritance¶
- Acquisition
- OtherModality
Slots¶
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| modality_label | 1 String |
The source's own name for the modality or recording technique, verbatim | direct |
| reason_no_modality_class_used | 0..1 String |
Why this is not an MRI, EEG, FNIRS, or PET record | direct |
| id | 1 String |
Acquisition | |
| acquisition_type | 1 String |
The concrete subclass this record instantiates | Acquisition |
| modality | 1 String or Modality |
Imaging or recording modality | Acquisition |
| acquisition_duration_seconds | 0..1 Float |
Total usable acquisition or recording duration in seconds | Acquisition |
| device | 0..1 Device |
The scanner, amplifier, or recording system this acquisition was made on, by ... | Acquisition |
| brain_coverage | 0..1 BrainCoverage |
How much of the brain the acquired volume contained | Acquisition |
Identifier and Mapping Information¶
Schema Source¶
- from schema: https://neurostuff.org/schemas/neuroimaging-study-storage
Mappings¶
| Mapping Type | Mapped Value |
|---|---|
| self | neurostudy:OtherModality |
| native | neurostudy:OtherModality |
LinkML Source¶
Direct¶
name: OtherModality
description: 'An acquisition whose modality has no class of its own: MEG, SPECT, and
`other`. Nothing here is normalized, so this is where a modality the schema does
not name keeps its parameters. A parameter that MRI, EEG, FNIRS, or PET has no field
for belongs on that sibling class instead.'
from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage
rank: 1000
is_a: Acquisition
attributes:
modality_label:
name: modality_label
description: The source's own name for the modality or recording technique, verbatim.
Always populated, since the Modality vocabulary is coarser than what a source
reports.
in_subset:
- mvp
- model_extracted
from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/acquisition
rank: 1000
domain_of:
- OtherModality
range: string
required: true
reason_no_modality_class_used:
name: reason_no_modality_class_used
description: Why this is not an MRI, EEG, FNIRS, or PET record.
in_subset:
- mvp
- model_extracted
from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/acquisition
rank: 1000
domain_of:
- OtherModality
range: string
Induced¶
name: OtherModality
description: 'An acquisition whose modality has no class of its own: MEG, SPECT, and
`other`. Nothing here is normalized, so this is where a modality the schema does
not name keeps its parameters. A parameter that MRI, EEG, FNIRS, or PET has no field
for belongs on that sibling class instead.'
from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage
rank: 1000
is_a: Acquisition
attributes:
modality_label:
name: modality_label
description: The source's own name for the modality or recording technique, verbatim.
Always populated, since the Modality vocabulary is coarser than what a source
reports.
in_subset:
- mvp
- model_extracted
from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/acquisition
rank: 1000
owner: OtherModality
domain_of:
- OtherModality
range: string
required: true
reason_no_modality_class_used:
name: reason_no_modality_class_used
description: Why this is not an MRI, EEG, FNIRS, or PET record.
in_subset:
- mvp
- model_extracted
from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/acquisition
rank: 1000
owner: OtherModality
domain_of:
- OtherModality
range: string
id:
name: id
in_subset:
- mvp
- deterministic
from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/acquisition
identifier: true
owner: OtherModality
domain_of:
- Arm
- Timepoint
- Group
- Task
- Condition
- Assessment
- Region
- Acquisition
- Device
- Analysis
- Measure
- Preprocessing
- ModelEstimation
- ModelTerm
- InferenceSettings
- StatisticalMap
- Table
- CoordinateSet
- Study
range: string
required: true
acquisition_type:
name: acquisition_type
description: The concrete subclass this record instantiates. Derived by the mapper
from the modality value's `instantiates`, never extracted.
in_subset:
- mvp
- deterministic
from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/acquisition
rank: 1000
designates_type: true
owner: OtherModality
domain_of:
- Acquisition
range: string
required: true
modality:
name: modality
description: 'Imaging or recording modality. A value in the Modality vocabulary
also names the class holding this acquisition''s modality-specific parameters,
through that value''s `instantiates`.
Open vocabulary: write the source''s own wording in the field when nothing here
fits, because the value is required and a closed range would discard the whole
acquisition over one unrecognised word. Only a vocabulary value carries an `instantiates`,
so an acquisition outside it resolves to the base class until normalization
maps the wording back on -- which is why `acquisition_type` is derived rather
than extracted, and why an unmapped modality is worth reporting.'
in_subset:
- mvp
- model_extracted
from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/acquisition
rank: 1000
owner: OtherModality
domain_of:
- Acquisition
range: string
required: true
any_of:
- range: Modality
- range: string
acquisition_duration_seconds:
name: acquisition_duration_seconds
description: Total usable acquisition or recording duration in seconds. Useful
for filtering studies by the amount of data contributing to an analysis, especially
resting-state and continuous recordings.
in_subset:
- mvp
- model_extracted
from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/acquisition
rank: 1000
owner: OtherModality
domain_of:
- Acquisition
range: float
minimum_value: 0
device:
name: device
description: The scanner, amplifier, or recording system this acquisition was
made on, by identifier. Acquisitions made on one machine reference one record;
a second record asserts the study used a second machine.
in_subset:
- model_extracted
from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/acquisition
rank: 1000
owner: OtherModality
domain_of:
- Acquisition
range: Device
inlined: false
brain_coverage:
name: brain_coverage
description: 'How much of the brain the acquired volume contained. This is the
extent the SCANNER sampled, and it is a third axis distinct from the two the
schema already carries: `Analysis.spatial_scope` is what the analysis tested,
and `InferenceSettings.correction_scope` with `search_volume` is where multiple
comparisons were controlled. A voxelwise analysis over a volume that clipped
the cerebellum is `whole_brain` in scope and `partial` here, and an ROI analysis
of a whole-head acquisition is the reverse. Never infer this from either of
those.
It describes the volume behind the REPORTED results. A scan that clipped a structure
in participants who were then excluded is `whole_brain`, because the analysed
volume was not clipped; calling it `partial` would say the opposite of what
the results rest on.
A field of view or slice prescription in millimetres is not by itself a statement
of coverage. Where only the geometry is given, the value is an inference and
`value_source` records it as one. Which structure a partial volume missed is
not a field of its own -- the evidence span carries that detail.'
in_subset:
- mvp
- model_extracted
from_schema: https://neurostuff.org/schemas/neuroimaging-study-storage/acquisition
rank: 1000
owner: OtherModality
domain_of:
- Acquisition
range: BrainCoverage