Skip to content
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

Revise magnitude function #132

Merged
merged 3 commits into from
Jan 13, 2025
Merged

Conversation

jschepers
Copy link
Collaborator

  • I removed the magnitude method which computes the norm as a default.
  • I added more documentation for the magnitude methods.
  • I added an assert statement in magnitude(lf::AbstractArray{T,3}, orientation::AbstractArray{T,2}) where {T<:Real} to ensure that the number of sources and spatial dimensions match in leadfield and orientation.

@jschepers jschepers requested a review from behinger January 9, 2025 14:27
@jschepers
Copy link
Collaborator Author

@behinger Just to make sure, this is a breaking change, isn't it? (In order to keep track of it for the release notes of the next release).

src/headmodel.jl Outdated Show resolved Hide resolved
@behinger
Copy link
Member

yes nice! We are doing a breaking release anyway, so yes. Dropping the norm feature is breaking

@jschepers jschepers merged commit 50fc4de into improve-docstrings Jan 13, 2025
2 checks passed
@jschepers jschepers deleted the revise-magnitude-function branch January 13, 2025 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants