Skip to content

Disambiguate the device model from device instance #5

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

Merged
merged 19 commits into from
Jun 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
fd1ec71
remove DeviceModel
alessandratrapani Feb 6, 2025
11b27fa
update changelog
alessandratrapani Feb 6, 2025
fdf3477
Introduce DeviceModel and DeviceInstance
alessandratrapani Feb 6, 2025
7497d15
Refactor DeviceInstance and DeviceModel documentation and attributes;…
alessandratrapani May 28, 2025
7d8b67e
Rename ObjectiveLens and ObjectiveLensModel to OpticalLens and Optica…
alessandratrapani May 28, 2025
f2f7a34
Refactor DeviceInstance and DeviceModel references to use Device as t…
alessandratrapani May 28, 2025
40080eb
Update changelog, release notes, and namespace for version 0.2.0;
alessandratrapani May 28, 2025
be4f66a
Refactor README to categorize neurodata types and update device model…
alessandratrapani May 28, 2025
8caa3d4
Refactor code structure for improved readability and maintainability
alessandratrapani May 28, 2025
23b5032
ruff fixes
alessandratrapani May 28, 2025
2e7c237
Merge branch 'main' into ophys-devices-inherit-from-device
alessandratrapani May 28, 2025
fe56c53
Add ExcitationSource and PulsedExcitationSource classes to device ins…
alessandratrapani May 28, 2025
702acee
Remove unused code and improve notebook structure for clarity
alessandratrapani May 28, 2025
d59aef3
ignore ruff check on print statements in the example notebook
alessandratrapani May 28, 2025
c849c3f
Enhance documentation by marking attributes as optional in README and…
alessandratrapani May 28, 2025
cc65cc0
Update docs/source/description.rst
alessandratrapani May 29, 2025
6e216f6
update __all__
alessandratrapani May 29, 2025
85d14f2
Update device model addition in documentation
alessandratrapani May 29, 2025
76fa5a8
Update DeviceModel class diagram to reflect correct inheritance from …
alessandratrapani May 29, 2025
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
27 changes: 27 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,30 @@
# v0.2.0 (Upcoming)

## Deprecations and Changes
### Major Refactoring:
- Implemented a clear distinction between device models and device instances:
- Added ``DeviceModel`` as a base class for all device model classes
- Added ``DeviceInstance`` as a base class for all device instance classes
- Refactored all device classes into model and instance pairs (e.g., ``OpticalFiberModel`` and ``OpticalFiber``)
- Renamed ``ObjectiveLens`` to ``OpticalLens`` for consistency

### New Features:
- Added new neurodata types:
- ``LensPositioning``: Extends ``NWBContainer`` to hold metadata on the positioning of a lens relative to the brain.
- ``FiberInsertion``: Extends ``NWBContainer`` to hold metadata on the insertion of a fiber into the brain.

### Changes:
- Changed ``illumination_type`` to ``source_type`` in ``ExcitationSourceModel`` for better clarity.
- Removed ``excitation_wavelength_in_nm`` from ``ExcitationSourceModel`` as it's often redundant with filter specifications.
- Removed ``detected_wavelength_in_nm`` from ``PhotodetectorModel`` as it's often redundant with filter specifications.
- Added ``wavelength_range_in_nm`` to ``ExcitationSourceModel`` and ``PhotodetectorModel`` to specify the range of wavelengths.

## Bug Fixes

## Features

## Improvements

# v0.1.1 (Feb 25, 2025)

## Deprecations and Changes
Expand Down
Loading