Skip to content

Commit 8c90f2d

Browse files
authored
1519 hotfix 20 last minute bugs (#1520)
* fix: description for probeconfig coordinate system * fix: remove InjectionDynamics.rate * chore: typo * docs: update docs
1 parent deb2707 commit 8c90f2d

File tree

4 files changed

+9
-7
lines changed

4 files changed

+9
-7
lines changed

docs/source/components/configs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ Configuration for a device inserted into a brain
371371
| `primary_targeted_structure` | [BrainAtlas](../aind_data_schema_models/brain_atlas.md#ccfv3) | |
372372
| `other_targeted_structure` | Optional[List[[BrainAtlas](../aind_data_schema_models/brain_atlas.md#ccfv3)]] | |
373373
| `atlas_coordinate` | Optional[[AtlasCoordinate](coordinates.md#atlascoordinate)] | |
374-
| `coordinate_system` | [CoordinateSystem](coordinates.md#coordinatesystem) | |
374+
| `coordinate_system` | [CoordinateSystem](coordinates.md#coordinatesystem) | Device coordinate system, defines un-rotated probe's orientation relative to the Acquisition.coordinate_system |
375375
| `transform` | List[[Translation](coordinates.md#translation) or [Rotation](coordinates.md#rotation) or [Scale](coordinates.md#scale) or [Affine](coordinates.md#affine)] | Entry coordinate, depth, and rotation in the Acquisition.coordinate_system |
376376
| `dye` | `Optional[str]` | |
377377
| `notes` | `Optional[str]` | |

docs/source/components/injection_procedures.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ Description of the volume and rate of an injection
2424
| `profile` | [InjectionProfile](#injectionprofile) | |
2525
| `volume` | `Optional[float]` | |
2626
| `volume_unit` | Optional[[VolumeUnit](../aind_data_schema_models/units.md#volumeunit)] | |
27-
| `rate` | `Optional[float]` | |
28-
| `rate_unit` | Optional[[VolumeUnit](../aind_data_schema_models/units.md#volumeunit)] | |
2927
| `duration` | `Optional[float]` | |
3028
| `duration_unit` | Optional[[TimeUnit](../aind_data_schema_models/units.md#timeunit)] | |
3129
| `injection_current` | `Optional[float]` | |

src/aind_data_schema/components/configs.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,14 @@ class ProbeConfig(DeviceConfig):
438438
)
439439

440440
# Transform
441-
coordinate_system: CoordinateSystem = Field(..., title="Device coordinate system")
441+
coordinate_system: CoordinateSystem = Field(
442+
...,
443+
title="Device coordinate system",
444+
description=(
445+
"Device coordinate system, defines un-rotated probe's orientation relative to the "
446+
"Acquisition.coordinate_system"
447+
),
448+
)
442449
transform: TRANSFORM_TYPES = Field(
443450
...,
444451
title="Device to acquisition transform",

src/aind_data_schema/components/injection_procedures.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,6 @@ class InjectionDynamics(DataModel):
8787
volume: Optional[float] = Field(default=None, title="Injection volume")
8888
volume_unit: Optional[VolumeUnit] = Field(default=None, title="Injection volume unit")
8989

90-
rate: Optional[float] = Field(default=None, title="Injection rate")
91-
rate_unit: Optional[VolumeUnit] = Field(default=None, title="Injection rate unit")
92-
9390
duration: Optional[float] = Field(default=None, title="Injection duration")
9491
duration_unit: Optional[TimeUnit] = Field(default=None, title="Injection duration unit")
9592

0 commit comments

Comments
 (0)