Allow user-defined fields for image correlation #106
Merged
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.
Until now, users were only allowed to use automatically-generated fields when performing image correlation using the
DISCorrel
andGPUCorrel
Blocks. The fields were provided as strings, and converted into standard fields by theget_field
function. Recently, a request was filed for further customization options of correlation fields in #97.This PR enables users to provide their own correlation fields as numpy arrays, along with strings representing fields to automatically generate. A new example is added, demonstrating the simultaneous use of automatic and user-provided fields.