Introduce ability to constrain particle states in ParticleUpdater and MCMCRegulariser #855
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
timothy-glover
requested review from
hpritchett-dstl and
mharris-dstl
and removed request for
a team
stonesoup/regulariser/particle.py
Outdated
Comment on lines
38
to
39
| "constraints to particle states. This is done by reverting " | ||
| "that are moved to a state outside of the defined constraints " |
There was a problem hiding this comment.
Suggested change
| "constraints to particle states. This is done by reverting " | |
| "that are moved to a state outside of the defined constraints " | |
| "constraints to particle states. This is done by reverting particles " | |
| "that are moved to a state outside of the defined constraints " |
There was a problem hiding this comment.
Well spotted. Fixed and improved clarity in latest commit.
jswright-dstl
approved these changes
Sep 14, 2023
mharris-dstl
approved these changes
Sep 22, 2023
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.
This PR has introduced the optional property
constraint_functoParticleUpdaterandMCMCRegulariser. If defined, this is intended to enforce that particle states should not exceed certain values by modifying the associated weights, increasing the likelihood of resampling. Here the constraint function should accept aParticleStatetype and return a logical index of particles that exceed the defined constraints. An example of this can be seen here:https://github.com/timothy-glover/Stone-Soup/blob/7ae343e147176107a35fafa81c00c2a7d879561e/stonesoup/regulariser/tests/test_particle.py#L16-L18
A bug was also spotted in the test for the
ParticleUpdater. The original line, seen below, was passing regardless of what the weights are. This has been replaced with a check to ensure the sum of the weights is correct.Stone-Soup/stonesoup/updater/tests/test_particle.py
Line 74 in f24090c