Add Data and Function Background types #276
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
DrPaulSharp
force-pushed
the
background-types
branch
2 times, most recently
from
33dd23a
to
0c5efdf
Compare
DrPaulSharp
commented
Oct 24, 2024
StephenNneji
reviewed
Nov 1, 2024
There was a problem hiding this comment.
Looks good please see comments. I think its fine if constructBackground has no test as its being called by the example tests but if you are up for it we could save the inputs and output that goes in to the function from the two examples and have its own independent test. What I would like in the future is some kind of validation (maybe from ORSO) for the background stuff
examples/miscellaneous/backgroundTypes/DSPCScriptWithFunctionBackground.m
Outdated
Show resolved
Hide resolved
examples/miscellaneous/backgroundTypes/DSPCScriptWithDataBackground.m
Outdated
Show resolved
Hide resolved
…kgroundTypes' - this will be the example folder for this
…does not compile)
… background array instead
DrPaulSharp
force-pushed
the
background-types
branch
from
ae2894a
to
01ce884
Compare
examples/miscellaneous/backgroundTypes/DSPCScriptWithDataBackground.m
Outdated
Show resolved
Hide resolved
examples/miscellaneous/backgroundTypes/DSPCScriptWithFunctionBackground.m
Outdated
Show resolved
Hide resolved
API/projectClass/backgroundsClass.m
Outdated
| if ~isempty(source) | ||
| if strcmpi(inputBlock.type, allowedTypes.Constant.value) | ||
| source = obj.validateParam(source, obj.backgroundParams.getNames(), 'Background Param'); | ||
| maxValues = 0; |
There was a problem hiding this comment.
maxValues is used in multiple places might be worth making a private/constant struct with these values are reusing that
StephenNneji
approved these changes
Nov 27, 2024
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 enables data and function background types. In the compiled code, we construct a background array over the same range of q points that is used for the simulation, which replaces
backgroundParamsin the output.Constant backgrounds are now a constant array made in
constructBackground.Data backgrounds are defined in the data block of the project and appended to the contrast data in
insertDataBackgroundIntoContrastData(called inparseClassToStructs), with an optional offset added inconstructBackground.Function backgrounds are defined in the custom files block of the project and evaluated and applied in
constructBackground. Note that only MATLAB background functions are supported at present.The API for backgrounds and resolutions has changed. We have added the field "source" which contains either the background/resolution parameter, entry in the data block, or entry in the custom file block for constant, data, and function backgrounds respectively. This differentiates this field from the five "value" fields, which now ONLY contain background parameters (the optional offset for data, and up to five function parameters).
NOTE - I'm not entirely sure about the name "source" for this field, feedback on something better is welcome. I've kept it at five value fields, meaning a function background can have up to five arguments, which feels sensible to me.