- Removed
ExcitationLightPathandEmissionLightPathclasses in favor of a more integrated approach withMicroscopyRig
NWB TAB reviews Issue#48
- Added
MicroscopyChannelobject Sub-Issue#49 - Added
MicroscopyRigobject Sub-Issue#51 - Changed
Microscopeto inherit fromDeviceInstanceinstead ofDeviceSub-Issue#51 - Added
MicroscopeModelthat inherit fromDeviceModelSub-Issue#51 - Updated
MicroscopySeriesto useMicroscopyRiginstead of individualmicroscope,excitation_light_path, andemission_light_pathreferences Sub-Issue#51 - Added
dimensions_in_pixelstoPlanarImagingSpaceanddimensions_in_voxelstoVolumetricImagingSpaceobject Sub-Issue#52 - Added
MultiChannelMicroscopyContainerobject Sub-Issue#53 - Refactored segmentation classes: Sub-Issue#56
- Renamed
Segmentation2DtoPlanarSegmentation - Renamed
Segmentation3DtoVolumetricSegmentation
- Renamed
- Added
get_FOV_size()method to bothPlanarImagingSpaceandVolumetricImagingSpaceclasses for calculating Field of View size in micrometers Sub-Issue#53 - Added
microscopy_serieslink toMicroscopyResponseSeriesclass Sub-Issue#58 - Changed
image_to_voxelinvolume_to_voxel,voxel_to_imageinvoxel_to_volume, andimage_maskinvolume_maskin VolumetricSegmentation Sub-Issue#57
- Change
grid_spacing_in_uminpixel_size_in_umandvoxel_size_in_um(and relative doc string) to better represent the physical dimension of the fundamental unit of the image (pixel or voxel).
-
New illumination pattern classes to represent different microscopy scanning methods:
IlluminationPattern: Base class for describing the illumination pattern used to acquire imagesLineScan: Line scanning method commonly used in two-photon microscopyPlaneAcquisition: Whole plane acquisition method, common for light sheet and one-photon techniquesRandomAccessScan: Random access method for targeted, high-speed imaging of specific regions
-
Added
techniqueattribute to theMicroscopeclass to describe the imaging technique used -
Updated
ImagingSpaceclasses to include anillumination_patternparameter, creating a direct link between the imaging space and the acquisition method -
Added mock implementations for all new classes in
_mock.pyfor testing purposes -
Updated example notebooks to demonstrate the use of different scanning methods
- These changes are backward compatible and add new functionality without removing existing features
- The
illumination_patternparameter is now required when creatingImagingSpaceobjects