Switching default Jansen-Rit to ODE #343
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Current Jansen-Rit is renamed JansenRitDelayed, and JansenRit is now back to being an ODE
Instead of separate `JansenRit()` and `JansenRitDelayed` constructors, create a single constructor with flag `delayed=false` default.
MasonProtter
reviewed
Mar 8, 2024
src/blox/neural_mass.jl
Outdated
Comment on lines
156
to
181
| """ | ||
| JansenRit(name, namespace, τ, H, λ, r, cortical) | ||
|
|
||
| Create a Jansen Rit blox with optional delays as described in Liu et al. | ||
| The formal definition of this blox is: | ||
|
|
||
| ```math | ||
| \\frac{dx}{dt} = y-\\frac{2}{\\tau}x | ||
| \\frac{dy}{dt} = -\\frac{x}{\\tau^2} + \\frac{H}{\\tau} [\\frac{2\\lambda}{1+\\text{exp}(-r*\\sum{jcn})} - \\lambda] | ||
| ``` | ||
|
|
||
| where ``jcn`` is any input to the blox. | ||
|
|
||
| Arguments: | ||
| - name: Name given to ODESystem object within the blox. | ||
| - namespace: Additional namespace above name if needed for inheritance. | ||
| - τ: Time constant. This is changed from the original source as the time constant was in seconds, while all our blocks are in milliseconds. | ||
| - H: See equation for use. | ||
| - λ: See equation for use. | ||
| - r: See equation for use. | ||
| - cortical: Boolean to determine whether to use cortical or subcortical parameters. Specifying any of the parameters above will override this. | ||
|
|
||
| Citations: | ||
| 1. Liu C, Zhou C, Wang J, Fietkiewicz C, Loparo KA. The role of coupling connections in a model of the cortico-basal ganglia-thalamocortical neural loop for the generation of beta oscillations. Neural Netw. 2020 Mar;123:381-392. doi: 10.1016/j.neunet.2019.12.021. | ||
|
|
||
| """ |
There was a problem hiding this comment.
Is this duplicated on purpose?
…ting started tutorial accordingly
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Current Jansen-Rit is renamed JansenRitDelayed, and JansenRit is now back to being an ODE