[BUG] - Fix description of time constant estimation #302
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We have a function the repo to estimate 'timescales', added in here. I happened to notice that the function we have here described the calculation as being estimated from the knee parameter, whereas Richard's work estimates it from the knee frequency - which I assume is correct? If so, this is currently incorrectly described here, and this PR updates that.
This is what I'm following from Richard's work:
https://github.com/rdgao/field-echos/blob/master/echo_utils.py#L65
I know the "knee frequency" calculation is an estimation - this function should at least be updated to describe the correct parameter - should we also add a bit of note describing it more and/or referencing this to Richards paper? Thoughts, @rdgao?