Skip to content

Adds the shiftValue argument to plotRefSLD #405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
StephenNneji merged 2 commits into from
Jul 29, 2025
Merged

Adds the shiftValue argument to plotRefSLD #405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59f5e51
Adds the shiftValue argument to the plotRefSLD
StephenNneji Jul 28, 2025
1421f15
Addresses review comments
StephenNneji Jul 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions utilities/plotting/plotRefSLD.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ function plotRefSLD(project, result, options)
% * q4 (logical, default: false) indicates if the Y axis should plot Q^4.
% * showErrorBar (logical, default: true) indicates if the error bar should be shown.
% * showGrid (logical, default: false) indicates if the grid should be shown.
% * showLegend (logical, default: true) indicates if the legend should be shown.
% * showLegend (logical, default: true) indicates if the legend should be shown.
% * shiftValue (float, default: 100) A value between 1 and 100 that controls the spacing between the reflectivity plots for each of the contrasts.

arguments
project
Expand All @@ -27,6 +28,7 @@ function plotRefSLD(project, result, options)
options.showErrorBar {mustBeA(options.showErrorBar, 'logical')} = true
options.showGrid {mustBeA(options.showGrid, 'logical')} = false
options.showLegend {mustBeA(options.showLegend, 'logical')} = true
options.shiftValue {mustBeGreaterThanOrEqual(options.shiftValue, 1), mustBeLessThanOrEqual(options.shiftValue, 100)} = 100
end
% Convert the project class to a struct.
controls = controlsClass();
Expand All @@ -43,5 +45,5 @@ function plotRefSLD(project, result, options)
data.contrastNames = projectStruct.names.contrasts;

plotRefSLDHelper(data, false, options.linearX, options.q4, options.showErrorBar, ...
options.showGrid, options.showLegend);
options.showGrid, options.showLegend, options.shiftValue);
end
12 changes: 7 additions & 5 deletions utilities/plotting/plotRefSLDHelper.m
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
function plotRefSLDHelper(data, noDelay, linearX, q4, showErrorBar, showGrid, showLegend)
function plotRefSLDHelper(data, noDelay, linearX, q4, showErrorBar, showGrid, showLegend, shiftValue)
% Helper function to plot the reflectivity and SLD profiles from plot event struct.
% Most users never need to use this function, rather use ``useLivePlot`` for live
% plotting or ``plotRefSLD`` for simple SLD plots.
Expand Down Expand Up @@ -39,7 +39,9 @@ function plotRefSLDHelper(data, noDelay, linearX, q4, showErrorBar, showGrid, sh
% showGrid : logical, default: false
% Indicates if the grid should be shown.
% showLegend : logical, default: true
% Indicates if the legend should be shown.
% Indicates if the legend should be shown.
% shiftValue : float, default: 100
% A value between 1 and 100 that controls the spacing between the reflectivity plots for each of the contrasts.

arguments
data
Expand All @@ -49,8 +51,8 @@ function plotRefSLDHelper(data, noDelay, linearX, q4, showErrorBar, showGrid, sh
showErrorBar {mustBeA(showErrorBar, 'logical')} = true
showGrid {mustBeA(showGrid, 'logical')} = false
showLegend {mustBeA(showLegend, 'logical')} = true
end

shiftValue {mustBeGreaterThanOrEqual(shiftValue, 1), mustBeLessThanOrEqual(shiftValue, 100)} = 100
end
defaultState = 'on';
s = warning();
if any(strcmp({s.identifier}, 'MATLAB:Axes:NegativeDataInLogAxis'))
Expand Down Expand Up @@ -81,7 +83,7 @@ function plotRefSLDHelper(data, noDelay, linearX, q4, showErrorBar, showGrid, sh
thisRef = data.reflectivity{i};
thisData = data.shiftedData{i};
if i > 1 || q4
mult = 2^(4*i);
mult = 10.^((i/100)*shiftValue);
end

if q4 && data.dataPresent(i)
Expand Down