Skip to content

Commit 0b102ca

Browse files
authored
adding example for MRISession (#828)
* adding example for MRISession * linters * Update mri_session.py * dummy info
1 parent 4f704a2 commit 0b102ca

File tree

3 files changed

+96
-2
lines changed

3 files changed

+96
-2
lines changed

examples/mri_session.json

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"describedBy": "https://raw.githubusercontent.com/AllenNeuralDynamics/aind-data-schema/main/src/aind_data_schema/core/mri_session.py",
3+
"schema_version": "0.3.4",
4+
"subject_id": "",
5+
"session_start_time": "2024-03-12T16:27:55.584892",
6+
"session_end_time": "2024-03-12T16:27:55.584892",
7+
"experimenter_full_name": [
8+
"Allen Brain"
9+
],
10+
"protocol_id": "dx.doi.org/10.57824/protocols.io.bh7kl4n6",
11+
"iacuc_protocol": "12345",
12+
"animal_weight_prior": null,
13+
"animal_weight_post": null,
14+
"weight_unit": "gram",
15+
"anaesthesia": null,
16+
"mri_scanner": {
17+
"device_type": "Scanner",
18+
"name": "Scanner 72",
19+
"serial_number": null,
20+
"manufacturer": null,
21+
"model": null,
22+
"path_to_cad": null,
23+
"port_index": null,
24+
"additional_settings": {},
25+
"notes": null,
26+
"scanner_location": "Fred Hutch",
27+
"magnetic_strength": 7,
28+
"magnetic_strength_unit": "T"
29+
},
30+
"scans": [
31+
null,
32+
null
33+
],
34+
"notes": "There was some information about this scan session"
35+
}

examples/mri_session.py

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
"""example MRISession and MRIScan"""
2+
from decimal import Decimal
3+
4+
from aind_data_schema.core.mri_session import MRIScan, MriScanSequence, MriSession, ScanType, SubjectPosition
5+
from aind_data_schema.models.coordinates import Rotation3dTransform, Scale3dTransform, Translation3dTransform
6+
from aind_data_schema.models.devices import Scanner
7+
8+
scan1 = MRIScan(
9+
scan_index="1",
10+
scan_type=ScanType.SETUP,
11+
primary_scan=False,
12+
scan_sequence_type=MriScanSequence.RARE,
13+
rare_factor=8,
14+
echo_time=Decimal(3.42),
15+
repetition_time=Decimal(100.0),
16+
subject_position=SubjectPosition.SUPINE,
17+
voxel_sizes=Scale3dTransform(scale=[0.5, 0.4375, 0.52]),
18+
processing_steps=[],
19+
additional_scan_parameters={},
20+
notes="Set up scan for the 3D scan.",
21+
)
22+
23+
scan2 = MRIScan(
24+
scan_index="2",
25+
scan_type=ScanType.SCAN_3D,
26+
primary_scan=True,
27+
scan_sequence_type=MriScanSequence.RARE,
28+
rare_factor=4,
29+
echo_time=Decimal(5.33333333333333),
30+
effective_echo_time=Decimal(10.6666666666666998253276688046753406524658203125),
31+
repetition_time=Decimal(500.0),
32+
vc_orientation=Rotation3dTransform(rotation=[1.0, 0.0, 0.0, 0.0, 0.0, -1.0, 0.0, 1.0, 0.0]),
33+
vc_position=Translation3dTransform(translation=[-6.1, -7.0, 7.9]),
34+
subject_position=SubjectPosition.SUPINE,
35+
voxel_sizes=Scale3dTransform(scale=[0.1, 0.1, 0.1]),
36+
processing_steps=[],
37+
additional_scan_parameters={},
38+
notes=None,
39+
)
40+
41+
scans = [scan1, scan2]
42+
43+
sess = MriSession(
44+
subject_id="",
45+
session_start_time="2024-03-12T16:27:55.584892",
46+
session_end_time="2024-03-12T16:27:55.584892",
47+
experimenter_full_name=["Allen Brain"],
48+
protocol_id="dx.doi.org/10.57824/protocols.io.bh7kl4n6",
49+
iacuc_protocol="12345",
50+
mri_scanner=Scanner(
51+
name="Scanner 72",
52+
scanner_location="Fred Hutch",
53+
magnetic_strength="7",
54+
),
55+
scans=scans,
56+
notes="There was some information about this scan session"
57+
)
58+
59+
sess.write_standard_file()

examples/multiplane_ophys_session.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
import datetime
44

5-
from aind_data_schema.core.session import FieldOfView, Session, Stream, LaserConfig
5+
from aind_data_schema.core.session import FieldOfView, LaserConfig, Session, Stream
66
from aind_data_schema.models.modalities import Modality
7-
from aind_data_schema.models.units import SizeUnit, PowerUnit
7+
from aind_data_schema.models.units import PowerUnit, SizeUnit
88

99
t = datetime.datetime(2022, 7, 12, 7, 00, 00)
1010

0 commit comments

Comments
 (0)