Skip to content

Enhance plotting functionality of plot slice wrapper #831

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

Closed
wants to merge 2 commits into from
Closed

Enhance plotting functionality of plot slice wrapper #831

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
5e88d36
Enhance plotting functionality of plot slice wrapper
ahmadnish Mar 28, 2025
3c34966
Merge branch 'master' into add_title_to_plotslice
wahln Apr 24, 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
20 changes: 14 additions & 6 deletions examples/matRad_example2_photons.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,18 +197,26 @@
plane = 3;
doseWindow = [0 max([resultGUI.physicalDose(:); resultGUI_coarse.physicalDose(:)])];

figure,title('original plan - fine beam spacing')
matRad_plotSliceWrapper(gca,ct,cst,1,resultGUI.physicalDose,plane,slice,[],0.75,colorcube,[],doseWindow,[]);
figure,title('modified plan - coarse beam spacing')
matRad_plotSliceWrapper(gca,ct,cst,1,resultGUI_coarse.physicalDose,plane,slice,[],0.75,colorcube,[],doseWindow,[]);
% Create figure for the original plan
figure
titleString = 'Original Plan - Fine Beam Spacing';
matRad_plotSliceWrapper(gca,ct,cst,1,resultGUI.physicalDose,plane,slice,[],0.75,colorcube,[],doseWindow,[],[],[],false,titleString);

% Create figure for the modified plan
figure
titleString = 'Modified Plan - Coarse Beam Spacing';
matRad_plotSliceWrapper(gca,ct,cst,1,resultGUI_coarse.physicalDose,plane,slice,[],0.75,colorcube,[],doseWindow,[],[],[],false,titleString);

%%
% At this point we would like to see the absolute difference of the first
% optimization (finer beam spacing) and the second optimization (coarser
% beam spacing)
absDiffCube = resultGUI.physicalDose-resultGUI_coarse.physicalDose;
figure,title( 'fine beam spacing plan - coarse beam spacing plan')
matRad_plotSliceWrapper(gca,ct,cst,1,absDiffCube,plane,slice,[],[],colorcube);

% Create figure for the difference plot
figure
titleString = 'Fine Beam Spacing Plan - Coarse Beam Spacing Plan';
matRad_plotSliceWrapper(gca,ct,cst,1,absDiffCube,plane,slice,[],[],colorcube,[],[],[],[],[],false,titleString);

%% Obtain dose statistics
% Two more columns will be added to the cst structure depicting the DVH and
Expand Down
40 changes: 25 additions & 15 deletions matRad/plotting/matRad_plotAxisLabels.m
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
function matRad_plotAxisLabels(axesHandle,ct,plane,slice,defaultFontSize,tickdist)
function matRad_plotAxisLabels(axesHandle,ct,plane,slice,defaultFontSize,titleString)
% matRad function to plot x and y labels denoting the ct dimensions
% according to the selected plane
%
% call
% matRad_plotAxisLabels(axesHandle,ct,plane,slice,defaultFontSize)
% matRad_plotAxisLabels(axesHandle,ct,plane,slice,defaultFontSize,
% tickdist)
% matRad_plotAxisLabels(axesHandle,ct,plane,slice,defaultFontSize,titleString)
%
% input
% axesHandle handle to axes the slice should be displayed in
% ct matRad ct structure
% plane plane view (coronal=1,sagittal=2,axial=3)
% slice slice in the selected plane of the 3D cube
% defaultFontSize default font size as double value
% titleString optional custom title to display above plane information
%
% output
% -
Expand All @@ -39,15 +39,14 @@ function matRad_plotAxisLabels(axesHandle,ct,plane,slice,defaultFontSize,tickdi
defaultFontSize = matRad_cfg.gui.fontSize;
end

ct = matRad_getWorldAxes(ct);


if ~exist('tickdist','var') || isempty(tickdist)
tickdist = abs(ct.x(end)-ct.x(1))/10;
if ~exist('titleString','var') || isempty(titleString)
titleString = '';
end

ct = matRad_getWorldAxes(ct);

%% Set axis labels and plot iso center
if plane == 3% Axial plane
if plane == 3 % Axial plane
if ~isempty(ct.resolution.x) && ~isempty(ct.resolution.y)
set(axesHandle,'XTick',linspace(0,ct.x(end)-ct.x(1),10)./ct.resolution.x);
set(axesHandle,'YTick',linspace(0,ct.y(end)-ct.y(1),10)./ct.resolution.y);
Expand All @@ -56,11 +55,11 @@ function matRad_plotAxisLabels(axesHandle,ct,plane,slice,defaultFontSize,tickdi
xlabel(axesHandle,'x [mm]','FontSize',defaultFontSize)
ylabel(axesHandle,'y [mm]','FontSize',defaultFontSize)
vcoord = matRad_cubeIndex2worldCoords([1,1,slice],ct);
title(axesHandle,['axial plane z = ' num2str(vcoord(3)) ' [mm]'],'FontSize',defaultFontSize,'Color',matRad_cfg.gui.highlightColor);
planeInfo = ['axial plane z = ' num2str(vcoord(3)) ' [mm]'];
else
xlabel(axesHandle,'x [voxels]','FontSize',defaultFontSize)
ylabel(axesHandle,'y [voxels]','FontSize',defaultFontSize)
title(axesHandle,'axial plane','FontSize',defaultFontSize,'Color',matRad_cfg.gui.highlightColor)
planeInfo = 'axial plane';
end
elseif plane == 2 % Sagittal plane
if ~isempty(ct.resolution.y) && ~isempty(ct.resolution.z)
Expand All @@ -71,11 +70,11 @@ function matRad_plotAxisLabels(axesHandle,ct,plane,slice,defaultFontSize,tickdi
xlabel(axesHandle,'z [mm]','FontSize',defaultFontSize);
ylabel(axesHandle,'y [mm]','FontSize',defaultFontSize);
vcoord = matRad_cubeIndex2worldCoords([1,slice,1],ct);
title(axesHandle,['sagittal plane x = ' num2str(vcoord(1)) ' [mm]'],'FontSize',defaultFontSize,'Color',matRad_cfg.gui.highlightColor);
planeInfo = ['sagittal plane x = ' num2str(vcoord(1)) ' [mm]'];
else
xlabel(axesHandle,'z [voxels]','FontSize',defaultFontSize)
ylabel(axesHandle,'y [voxels]','FontSize',defaultFontSize)
title(axesHandle,'sagittal plane','FontSize',defaultFontSize,'Color',matRad_cfg.gui.highlightColor);
planeInfo = 'sagittal plane';
end
elseif plane == 1 % Coronal plane
if ~isempty(ct.resolution.x) && ~isempty(ct.resolution.z)
Expand All @@ -86,16 +85,27 @@ function matRad_plotAxisLabels(axesHandle,ct,plane,slice,defaultFontSize,tickdi
xlabel(axesHandle,'z [mm]','FontSize',defaultFontSize)
ylabel(axesHandle,'x [mm]','FontSize',defaultFontSize)
vcoord = matRad_cubeIndex2worldCoords([slice,1,1],ct);
title(axesHandle,['coronal plane y = ' num2str(vcoord(2)) ' [mm]'],'FontSize',defaultFontSize,'Color',matRad_cfg.gui.highlightColor)
planeInfo = ['coronal plane y = ' num2str(vcoord(2)) ' [mm]'];
else
xlabel(axesHandle,'z [voxels]','FontSize',defaultFontSize)
ylabel(axesHandle,'x [voxels]','FontSize',defaultFontSize)
title(axesHandle,'coronal plane','FontSize',defaultFontSize,'Color',matRad_cfg.gui.highlightColor)
planeInfo = 'coronal plane';
end
end

% Create the combined title if a custom title is provided
if ~isempty(titleString)
titleText = sprintf('%s\n%s', titleString, planeInfo);
else
titleText = planeInfo;
end

% Set the title with the combined text
title(axesHandle, titleText, 'FontSize', defaultFontSize, 'Color', matRad_cfg.gui.highlightColor);

%Apply coloring
set(axesHandle,'XColor',matRad_cfg.gui.textColor,'YColor',matRad_cfg.gui.textColor);

end


18 changes: 14 additions & 4 deletions matRad/util/matRad_plotSliceWrapper.m
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
function [hCMap,hDose,hCt,hContour,hIsoDose] = matRad_plotSliceWrapper(axesHandle,ct,cst,cubeIdx,dose,plane,slice,thresh,alpha,contourColorMap,...
doseColorMap,doseWindow,doseIsoLevels,voiSelection,colorBarLabel,boolPlotLegend,varargin)
doseColorMap,doseWindow,doseIsoLevels,voiSelection,colorBarLabel,boolPlotLegend,titleString,varargin)
% matRad tool function to directly plot a complete slice of a ct with dose
% including contours and isolines.
%
Expand All @@ -13,7 +13,7 @@
% [hCMap,hDose,hCt,hContour,hIsoDose] = matRad_plotSliceWrapper(axesHandle,ct,cst,cubeIdx,dose,plane,slice,doseIsoLevels)
% ...
% [hCMap,hDose,hCt,hContour,hIsoDose] = matRad_plotSliceWrapper(axesHandle,ct,cst,cubeIdx,dose,plane,slice,thresh,alpha,contourColorMap,...
% doseColorMap,doseWindow,doseIsoLevels,voiSelection,colorBarLabel,boolPlotLegend,...)
% doseColorMap,doseWindow,doseIsoLevels,voiSelection,colorBarLabel,boolPlotLegend,titleString,...)
%
% input (required)
% axesHandle handle to axes the slice should be displayed in
Expand All @@ -36,6 +36,7 @@
% all non-ignored contours.
% colorBarLabel string defining the yLabel of the colorBar
% boolPlotLegend boolean if legend should be plottet or not
% titleString string to display as title for the plot
% varargin additional input parameters that are passed on to
% individual plotting functions (e.g. 'LineWidth',1.5)
%
Expand Down Expand Up @@ -99,6 +100,10 @@
cst = [];
end

if ~exist('titleString','var') || isempty(titleString)
titleString = [];
end

matRad_cfg = MatRad_Config.instance();

set(axesHandle,'YDir','Reverse');
Expand Down Expand Up @@ -148,10 +153,10 @@
set(axesHandle,'xtick',[],'ytick',[]);
colormap(axesHandle,doseColorMap);

matRad_plotAxisLabels(axesHandle,ct,plane,slice,[])
% Add axis labels with plane information and title
matRad_plotAxisLabels(axesHandle,ct,plane,slice,[],titleString)

% set axis ratio

ratios = [1/ct.resolution.x 1/ct.resolution.y 1/ct.resolution.z];

set(axesHandle,'DataAspectRatioMode','manual');
Expand All @@ -172,5 +177,10 @@
set(get(hCMap,'YLabel'),'String', colorBarLabel,'FontSize',matRad_cfg.gui.fontSize);
end

% Set the figure name as well if title is provided
if ~isempty(titleString)
set(ancestor(axesHandle, 'figure'), 'Name', titleString);
end

end

Loading