Releases: JuliaSMLM/SMLMData.jl
Releases · JuliaSMLM/SMLMData.jl
v0.7.0
SMLMData v0.7.0
Breaking changes
There are no breaking changes. This is a minor version bump (v0.6.0 -> v0.7.0) that adds two new exported abstract types (AbstractSMLMConfig, AbstractSMLMInfo) for the JuliaSMLM ecosystem tuple pattern. No existing API is modified or removed.
Merged pull requests:
v0.6.0
SMLMData v0.6.0
Breaking changes
- Emitter2DFit: New
σ_xyfield added betweenσ_yandσ_photonsfor x-y covariance - Emitter3DFit: New
σ_xy,σ_xz,σ_yzfields added for full 3D covariance matrix
Migration
Use the keyword constructor which remains backward compatible:
Emitter2DFit{T}(x, y, photons, bg, σ_x, σ_y, σ_photons, σ_bg; σ_xy=0.0, frame=1, ...)
Emitter3DFit{T}(x, y, z, photons, bg, σ_x, σ_y, σ_z, σ_photons, σ_bg; σ_xy=0.0, σ_xz=0.0, σ_yz=0.0, ...)All JuliaSMLM ecosystem packages tested and compatible.
Merged pull requests:
v0.5.1
SMLMData v0.5.1
Merged pull requests:
v0.5.0
SMLMData v0.5.0
Breaking changes
- Remove SCMOSCamera accessor functions (get_offset, get_gain, get_readnoise, get_qe, get_readnoise_var) - access struct fields directly instead
New features
- Add
ROIBatch{T,N,A,C}type for batched ROI processing across JuliaSMLM ecosystem - Add
SingleROI{T}type for individual ROI with location context - GPU support via Adapt.jl for ROIBatch
- Iteration and indexing support for ROIBatch
Documentation
- Add "Ecosystem Role" section explaining SMLMData as core types package
- Clarify that other JuliaSMLM packages re-export SMLMData types
Merged pull requests:
v0.4.0 - sCMOS Camera Support
Added
- SCMOSCamera type for sCMOS camera support with pixel-dependent calibration parameters
offset: Dark level in ADU (scalar or per-pixel matrix)gain: Conversion gain in e⁻/ADU (scalar or per-pixel matrix)readnoise: Read noise in e⁻ rms (scalar or per-pixel matrix)qe: Quantum efficiency 0-1 (scalar or per-pixel matrix)- Units match camera specification sheets for easy parameterization
- Supports mixed scalar and matrix parameters for flexible calibration
- Two constructor forms:
(nx, ny, pixel_size, readnoise; kwargs...)and(edges_x, edges_y; kwargs...)
- Accessor functions for SCMOSCamera parameters:
get_offset,get_gain,get_readnoise,get_qe,get_readnoise_var - Custom display methods showing parameter types (uniform vs per-pixel)
- Comprehensive test suite with 91 new tests covering:
- Scalar and matrix parameter construction
- Type stability (Float32/Float64)
- Dimension validation
- Accessor functions
- Realistic use cases (ORCA-Flash4.0, ORCA-Quest specifications)
Changed
- Updated type hierarchy documentation to include SCMOSCamera
- Enhanced README.md with SCMOSCamera examples
- Expanded api_overview.md with detailed SCMOSCamera usage patterns
- Version bumped to 0.4.0 (minor version for backward-compatible new feature)
Notes
- No breaking changes - purely additive feature
- IdealCamera remains the default for Poisson-only noise models
- SCMOSCamera designed for compatibility with future SMLMCamera.jl calibration package
Full Changelog: v0.3.1...v0.4.0
v0.3.1
SMLMData v0.3.1
Documentation improvements
- Add api() function that integrates API documentation into Julia's help system
- Users can now access comprehensive API docs via
?SMLMData.apiorSMLMData.api() - Update module docstring to reference new documentation feature
- Add .claude directory with development command configurations
Merged pull requests:
v0.3.0
SMLMData v0.3.0
Breaking changes
- Fix frame numbering to be 1-based throughout package (breaking change from 0-based indexing)
- Update emitter constructors default frame values from 0 to 1
- Existing code using frame numbers will need to be updated to account for 1-based indexing
Other changes
- Update tests and documentation to reflect 1-based frame numbering
- Add CLAUDE.md for development guidance
Merged pull requests:
v0.2.3
SMLMData v0.2.3
minor updates
- handle complex values from smite when loading
- improve Base.show() methods
Merged pull requests: