Files
2026-08-07 15:56:42 +09:00

184 lines
7.5 KiB
Matlab
Raw Permalink Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
% Call function without arguments for instructions on how to use it
% Filename: $RCSfile: integrate_range.m,v $
%
% $Revision: 1.7 $ $Date: 2012/09/02 15:13:04 $
% $Author: $
% $Tag: $
%
% Description:
% azimuthal integration of a range of scans
%
% Note:
% Call without arguments for a brief help text.
% The integration masks need to be prepared first using prep_integ_masks.m
%
% Dependencies:
% - compile_x12sa_filename
% - find_files
% - radial_integ
%
% history:
%
% May 19th 2010: 1st documented version
%*-----------------------------------------------------------------------*
%|                                                                       |
%|  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) 2017 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 [] = integrate_range(scan_no_from,scan_no_to,scan_no_step,varargin)
import beamline.prep_integ_masks
import beamline.radial_integ
import utils.compile_x12sa_filename
import utils.find_files
% set default values for the variable input arguments:
% select PILATUS 2M
pilatus_det_no = 1;
% writing cbf files
file_extension = 'cbf';
save_format = '-v6';
if (nargin < 2)
fprintf('\nUsage:\n');
fprintf('%s(scan_no_from,scan_no_to,scan_no_step [[,<name>,<value>] ...]);\n',mfilename);
fprintf('integrates the scans within the range [scan_no_from, scan_no_to].\n');
fprintf('The optional <name>,<value> pairs are:\n');
fprintf('''PilatusDetNo'',<number> Detector number, 1 for 2M, default is %d\n',pilatus_det_no);
fprintf('''FileExtension'',<extension string> default is %s\n',file_extension);
fprintf('''SaveFormat'',<format string> default is %s\n',save_format);
fprintf('Example:\n');
fprintf('%s(100,500);\n',mfilename);
fprintf('Additional <name>,<value> pairs recognized by radial_integ can be specified.\n');
error('At least the scan number range has to be specified as input argument.');
end
% accept cell array with name/value pairs as well
no_of_in_arg = nargin;
if (nargin == 4)
if (isempty(varargin))
% ignore empty cell array
no_of_in_arg = no_of_in_arg -1;
else
if (iscell(varargin{1}))
% use a filled one given as first and only variable parameter
varargin = varargin{1};
no_of_in_arg = 1 + length(varargin);
end
end
end
% check number of input arguments
if (rem(no_of_in_arg,2) ~= 1)
error('The optional parameters have to be specified as ''name'',''value'' pairs');
end
% parse the variable input arguments:
% initialize the list of unhandled parameters
vararg_remain = cell(0,0);
for ind = 1:2:length(varargin)
name = varargin{ind};
value = varargin{ind+1};
switch name
case 'PilatusDetNo'
pilatus_det_no = value;
case 'SaveFormat'
save_format = value;
case 'FileExtension'
file_extension = value;
vararg_remain{end+1} = name; %#ok<AGROW>
vararg_remain{end+1} = value; %#ok<AGROW>
otherwise
vararg_remain{end+1} = name; %#ok<AGROW>
vararg_remain{end+1} = value; %#ok<AGROW>
end
end
vararg_remain{end+1} = 'UnhandledParError';
vararg_remain{end+1} = 0;
vararg_remain_x12sa_filename = vararg_remain;
vararg_remain_x12sa_filename{end+1} = 'DetectorNumber';
vararg_remain_x12sa_filename{end+1} = pilatus_det_no;
vararg_remain_x12sa_filename_wildcard = vararg_remain_x12sa_filename;
vararg_remain_x12sa_filename_wildcard{end+1} = 'PointWildcard';
vararg_remain_x12sa_filename_wildcard{end+1} = 1;
vararg_remain_x12sa_filename_wildcard{end+1} = 'SubExpWildcard';
vararg_remain_x12sa_filename_wildcard{end+1} = 1;
% highest number of an existing scan
scan_no_exists = scan_no_from -1;
scan_no_check = scan_no_from;
for scan_no = scan_no_from:scan_no_step:scan_no_to
% wait until the first file of the next scan is available
while (scan_no >= scan_no_exists)
scan_no_check = scan_no_check +1;
if (scan_no_check > scan_no + 100)
scan_no_check = scan_no +1;
fprintf('Pausing for 1 minute.\n');
pause(60);
% check if the data directory and first file exists
filename_mask = compile_x12sa_filename(scan_no,0,vararg_remain_x12sa_filename);
[ddir fnames] = find_files(filename_mask);
if (~isempty(fnames))
% integrate all data available until now
filename_mask = [ compile_x12sa_filename(scan_no,-1,vararg_remain_x12sa_filename) '*_' num2str(pilatus_det_no) '_' ['*' file_extension] ];
radial_integ(filename_mask,vararg_remain);
end
end
filename_next = compile_x12sa_filename(scan_no_check,0,vararg_remain_x12sa_filename);
[ddir fnames] = find_files(filename_next);
if (~isempty(fnames))
scan_no_exists = scan_no_check;
end
end
% integrate scan if a following scan has been started, i.e.,
% if the current one must be finished
if (scan_no < scan_no_exists)
% check if the data directory and first file exists
filename_mask = compile_x12sa_filename(scan_no,0,vararg_remain_x12sa_filename);
[ddir fnames] = find_files(filename_mask);
if (isempty(fnames))
fprintf('Skipping scan no %d: no data found\n',scan_no);
continue;
end
% integrate all data, i.e., all points and sub exposures
filename_mask = [ compile_x12sa_filename(scan_no,0,vararg_remain_x12sa_filename_wildcard) ];
radial_integ(filename_mask,vararg_remain);
end
end