from #98:
Backgrounds:
data and function type backgrounds are now supported. The following changes have been made:
- The
source field has been added to the backgrounds and resolutions models. This fields contains the background parameter (for constant backgrounds), data entry (for data backgrounds), or custom file entry (for function backgrounds). The value fields (i.e., value_1 to value_5) are not required for constant backgrounds, value_1 contains an optional background_parameter used as a data offset, or contain up to five function arguments (all defined as background_parameters).
- For resolutions, the
function type is still not supported, constant works in the same way as for backgrounds, but for data, neither the source nor value fields are required.
- When the background/resolution type is changed, the source and value fields should be cleared.
- In the examples and jupyter notebooks,
value_1 needs to be changed to source for constant type backgrounds and resolutions.
- Use a python version of the data and function background examples to check everything works (probably worth adding them to the examples too).
- The
check_indices routine needs to be modified to reflect the change of contrastBackgroundParams to be a nested list, with a variable number of inputs, and to consider a custom file entry in the case of function backgrounds.
- A routine mirroring
insertDataBackgroundIntoContrastData is required, to populate the additional columns in the data files for data backgrounds.
- The output result has had
backgroundParams removed from the contrastParams sub struct, with backgrounds added to the main result struct.
- ALL data files in the input
problemStruct have been extended to EXACTLY six columns. Any empty columns are filled with zero values.
- The
problemStruct input contrastBackgroundParams has been modified to be a nested list. The nested lists may contain between one and five indices. These are the indices of the source field (from the appropriate data struct), and from the values fields: nothing else (for constant backgrounds), a potential offset (value_1 if non-empty, for data backgrounds), or up to five function arguments (for function backgrounds).
- The field
contrastBackgroundTypes has been added to problemStruct
from #98: