initial commit

This commit is contained in:
2026-08-07 15:56:42 +09:00
commit 91ad25aca9
1012 changed files with 159314 additions and 0 deletions
+118
View File
@@ -0,0 +1,118 @@
% [volume_new, update] = apply_lamino_constraints(volume, mask, lamino_angle , low_freq_protection, constrain_fun, Niter)
% apply laminography constraints in the real space and try to refill missing cone in laminography by provided prior
% knowledge
% Inputs:
% **volume - (3D array) represeting the refined volume in realspace
% **mask - (vector, array), mask pushing pixels where mask < 1 towards zero. Can be either 3D or only for example along 3r axis ie size(mask) = [1,1,Nlayers]
% **lamino_angle - (scalar), laminography angle from 0 to 90degrees, 90 == classical tomo, it is used to calculate the missing cone
% **low_freq_protection - (bool), used to protect in the fourier space the central region, ie low spatial frequncies. Important when multiscale approach is used
% **constrain_fun - anonymous function providing constrains such as positivity or material range limits
% **Niter - number of optimization iterations
% *returns*
% ++volume_new refined object
% ++update (norm(volume) - norm(update_new)) / norm(volume)
%
% Example:
% see template_tomo_recons_lamino.m for working example
%*-----------------------------------------------------------------------*
%|                                                                       |
%|  Except where otherwise noted, this work is licensed under a          |
%|  Creative Commons Attribution-NonCommercial-ShareAlike 4.0            |
%|  International (CC BY-NC-SA 4.0) license.                             |
%|                                                                       |
%|  Copyright (c) 2018 by Paul Scherrer Institute (http://www.psi.ch)    |
%|                                                                       |
%|      Author: CXS group, PSI  |
%*-----------------------------------------------------------------------*
% You may use this code with the following provisions:
%
% If the code is fully or partially redistributed, or rewritten in another
% computing language this notice should be included in the redistribution.
%
% If this code, or subfunctions or parts of it, is used for research in a
% publication or if it is fully or partially rewritten for another
% computing language the authors and institution should be acknowledged
% in written form in the publication: Data processing was carried out
% using the cSAXS matlab package developed by the CXS group,
% Paul Scherrer Institut, Switzerland.
% Variations on the latter text can be incorporated upon discussion with
% the CXS group if needed to more specifically reflect the use of the package
% for the published work.
%
% A publication that focuses on describing features, or parameters, that
% are already existing in the code should be first discussed with the
% authors.
%
% This code and subroutines are part of a continuous development, they
% are provided as they are without guarantees or liability on part
% of PSI or the authors. It is the user responsibility to ensure its
% proper use and the correctness of the results.
function [volume_new, update] = apply_lamino_constraints(volume, mask, lamino_angle , low_freq_protection, value_max, value_min, Niter, TV_lambda)
import utils.Garray
Npix = size(volume);
fft_mask = lamino.get_lamino_fourier_mask( Npix, lamino_angle, true);
fft_mask = Garray(fft_mask);
if low_freq_protection
% avoid modification of the low spatial frequencies that were
% already refined
fft_mask = fftshift(fft_mask);
for i = 1:3
grid{i} = ceil(Npix(i)/2)+[-ceil(Npix(i)/8):floor(Npix(i)/8)];
end
fft_mask(grid{:}) = 0;
fft_mask = fftshift(fft_mask);
end
volume = Garray(volume);
fft_split = 1;
for iter = 1:Niter
utils.progressbar(iter,Niter)
volume_new = volume;
%volume_new = regularization.local_TV3D_chambolle(volume_new, 1e-7, 10);
volume_new = regularization.local_TV3D_chambolle(volume_new, TV_lambda, 10);
% positivity constraint
volume_new = arrayfun(@clip_range,volume_new, value_max, value_min, mask);
%% go to the Fourier space
fvolume = (math.fftn_partial(Garray(volume), fft_split));
fvolume_new = (math.fftn_partial(Garray(volume_new), fft_split));
%% merge updated and original dataset in the fourier space
%% use overrelaxation of the constraint to get faster convergence
relax = 1.5;
regularize = 0.0;
fvolume = arrayfun(@relax_contraint,fvolume, fvolume_new, fft_mask, relax, regularize);
clear fvolume_new
%% back to the real space
volume_new = real(math.ifftn_partial(Garray(fvolume), fft_split));
clear fvolume
% get difference in update
update = gather(norm(volume(:)-volume_new(:)) ./ norm(volume(:)));
volume = volume_new;
end
volume = gather(volume);
end
% auxiliary function for fast execution on GPU
function fvolume = relax_contraint(fvolume, fvolume_new, fft_mask, relax, regularize)
fvolume = fvolume .* ( 1- relax.*fft_mask) + fvolume_new .* relax.*fft_mask;
fvolume = fvolume .* (1 - regularize.*fft_mask);
end
function array = clip_range(array, max_val, min_val, mask)
array = max(min_val, min(max_val, array)) .* mask;
end
@@ -0,0 +1,79 @@
% weight_sino = estimate_reliability_region(complex_projection, probe_size, subsample)
% Estimates the region where the complex projections are good enough to be unwrapped. Assumes that outside
% of the measured FOV the amplitude of the object will be zero. This assumes that ptychography reconstruction
% did not add any values, due to those pixels never been reached by any probe element. Then the region is reduced
% by half the probe size using something akin to erosion. This function is only useful if the FOV is not square,
% such as the case of the elliptical FOV of laminography.
%
% Pseudo code example:
% weights = imerode(abs(object) > 0, ones(probe_size/2))
%
% Inputs:
% **complex_projection - (3D array) complex valued reconstructions
% **probe_size - (int, int) size of the illumination probe
% **subsample - (int) subsample the resulting array to save memory
% Outputs:
% ++weight_sino - weights, 1 for full quality, 0<=W<1 for poor regions
%*-----------------------------------------------------------------------*
%|                                                                       |
%|  Except where otherwise noted, this work is licensed under a          |
%|  Creative Commons Attribution-NonCommercial-ShareAlike 4.0            |
%|  International (CC BY-NC-SA 4.0) license.                             |
%|                                                                       |
%|  Copyright (c) 2018 by Paul Scherrer Institute (http://www.psi.ch)    |
%|                                                                       |
%|      Author: CXS group, PSI  |
%*-----------------------------------------------------------------------*
% You may use this code with the following provisions:
%
% If the code is fully or partially redistributed, or rewritten in another
% computing language this notice should be included in the redistribution.
%
% If this code, or subfunctions or parts of it, is used for research in a
% publication or if it is fully or partially rewritten for another
% computing language the authors and institution should be acknowledged
% in written form in the publication: Data processing was carried out
% using the cSAXS matlab package developed by the CXS group,
% Paul Scherrer Institut, Switzerland.
% Variations on the latter text can be incorporated upon discussion with
% the CXS group if needed to more specifically reflect the use of the package
% for the published work.
%
% A publication that focuses on describing features, or parameters, that
% are already existing in the code should be first discussed with the
% authors.
%
% This code and subroutines are part of a continuous development, they
% are provided as they are without guarantees or liability on part
% of PSI or the authors. It is the user responsibility to ensure its
% proper use and the correctness of the results.
function weight_sino = estimate_reliability_region(complex_projection, probe_size, subsample)
% simple reliability estimation based on amplitude of the
% reconstruction
Npix = size(complex_projection);
Npix_new = ceil(Npix(1:2)/subsample/2)*2;
%% SOLVE THE PROBLEM IN LOW RESOLUTION
weight_sino = tomo.block_fun(@utils.interpolateFT, complex_projection,Npix_new, struct('use_GPU', false, 'use_fp16', false));
probe_size = round(probe_size .* Npix_new ./ Npix(1:2));
weight_sino =abs(weight_sino);
weight_sino = single(weight_sino > 0.1*quantile(weight_sino(:),0.9));
%% only CPU is supported -> gather and move abck to GPU afterwards
weight_sino = gpuArray(utils.imcrop_outliers(gather(weight_sino))); % leave only single largest compact object
[Y,X] = meshgrid(-ceil(probe_size(1)/2):floor(probe_size(1)/2), -ceil(probe_size(2)/2):floor(probe_size(2)/2));
probe = (X/probe_size(1)*2).^2+(Y/probe_size(2)*2).^2 < 1;
kernel = probe/sum(probe(:));
weight_sino = convn(weight_sino, kernel , 'same');
weight_sino = weight_sino > 0.95;
weight_sino = uint8(imgaussfilt(single(weight_sino), 1)*255);
end
+65
View File
@@ -0,0 +1,65 @@
% fft_mask = get_lamino_fourier_mask( Npix, lamino_angle, keep_on_GPU)
% find the missing cone mask based on provided inputs
% Inputs:
% **Npix - (3x1 int) volume size
% **lamino_angle - (scalar), laminography angle from 0 to 90degrees, 90 == classical tomo, it is used to calculate the missing cone
% **keep_on_GPU - (bool) move the mask to GPU and keep it there
% *returns*
% ++fft_mask = mask in the fourier space
%
% Example:
% ifftn(fftn(volume).*fft_mask)
%*-----------------------------------------------------------------------*
%|                                                                       |
%|  Except where otherwise noted, this work is licensed under a          |
%|  Creative Commons Attribution-NonCommercial-ShareAlike 4.0            |
%|  International (CC BY-NC-SA 4.0) license.                             |
%|                                                                       |
%|  Copyright (c) 2018 by Paul Scherrer Institute (http://www.psi.ch)    |
%|                                                                       |
%|      Author: CXS group, PSI  |
%*-----------------------------------------------------------------------*
% You may use this code with the following provisions:
%
% If the code is fully or partially redistributed, or rewritten in another
% computing language this notice should be included in the redistribution.
%
% If this code, or subfunctions or parts of it, is used for research in a
% publication or if it is fully or partially rewritten for another
% computing language the authors and institution should be acknowledged
% in written form in the publication: Data processing was carried out
% using the cSAXS matlab package developed by the CXS group,
% Paul Scherrer Institut, Switzerland.
% Variations on the latter text can be incorporated upon discussion with
% the CXS group if needed to more specifically reflect the use of the package
% for the published work.
%
% A publication that focuses on describing features, or parameters, that
% are already existing in the code should be first discussed with the
% authors.
%
% This code and subroutines are part of a continuous development, they
% are provided as they are without guarantees or liability on part
% of PSI or the authors. It is the user responsibility to ensure its
% proper use and the correctness of the results.
function fft_mask = get_lamino_fourier_mask( Npix, lamino_angle, keep_on_GPU)
if nargin < 3
keep_on_GPU = false;
end
for i = 1:3
grid{i} = fftshift(linspace(-1,1,Npix(i)))';
grid{i} = shiftdim(grid{i},1-i);
if keep_on_GPU, grid{i} = utils.Garray(grid{i}); end
end
fft_mask = get_mask(grid{:}, lamino_angle);
end
function fft_mask = get_mask(xgrid, ygrid, zgrid, lamino_angle)
fft_mask = ceil(atand( abs(zgrid) ./ sqrt(xgrid.^2+ygrid.^2) )) > lamino_angle;
end