Ticket #8554: ReduceSCD_v1.config

File ReduceSCD_v1.config, 6.7 KB (added by Peter Peterson, 7 years ago)
Line 
1# Configuration file for ReduceSCD_OneRun.py and ReduceSCD_Parallel.py.
2#
3# Each line can either start with a comment, indicated by a '#' mark or start
4# with a parameter name and value, optionally followed by a comment.  ALL
5# parameters used by the script must be specified.  If a required parameter
6# is not specified, the script will terminate with a message indicating which
7# parameter was missing.
8#
9
10#
11# _v1: December 3rd 2013. Mads Joergensen
12# This version now includes the posibility to use the 1D cylindrical integration method
13# and the posibility to load a UB matrix which will be used for integration of the individual
14# runs and to index the combined file (Code from Xiapoing).
15#
16
17# ==========================================================================
18# Parameters needed by ReduceOneSCD_Run.py, to process ONE run.
19# ==========================================================================
20#
21instrument_name   TOPAZ                        # prefix for run file names
22
23#
24# Specify calibration file(s).  SNAP requires two calibration files, one
25# for each bank.  If the default detector position is to be used, specify
26# None as the calibration file name.
27#
28calibration_file_1  /SNS/TOPAZ/IPTS-9890/shared/2013B_calibration/TOPAZ_27Aug2013.DetCal
29calibration_file_2  None
30
31#
32# Set the data_directory to None to use findnexus to get the run file when
33# running this on the SNS systems.  On other systems, all of the input files
34# must be copied into one directory and that directory must be specified as
35# the data_directory
36#
37data_directory    None       
38output_directory  /SNS/TOPAZ/IPTS-9890/shared/test/
39
40#
41# Min & max tof determine the range of events loaded. Min & max monitor tof
42# determine the range of tofs integrated in the monitor data to get the
43# total monitor counts
44#
45min_tof           1000
46max_tof          16666
47monitor_index        0
48min_monitor_tof   1000
49max_monitor_tof  12500
50
51#
52# Read the UB matrix from file. This option will be applied to each run and used for
53# combined file. This option is especially helpful for 2nd frame TOPAZ data.
54read_UB       False
55UB_filename  /SNS/TOPAZ/IPTS-9890/shared/test/test.mat
56
57#
58# Specifiy a conventional cell type and centering.  If these are None, only
59# one .mat and .integrate file will be written for this run, and they will
60# be in terms of the Niggli reduced cell.  If these specifiy a valid
61# cell type and centering, an additional .mat and .integrate file will be
62# written for the specified cell_type and centering.  NOTE: If run in
63# parallel, the driving script will only read the Niggli version of the
64# .integrate file, and will combine, re-index and convert to a conventional
65# cell, so these can usually be left as None.
66#
67# Cell trnasformation is not applied to cylindrical profiles,
68# i.e. use None if cylindrical integration is used!
69#
70cell_type     Triclinic
71centering     P
72
73#
74# Number of peaks to find, per run, both for getting the UB matrix,
75# AND to determine how many peaks are integrated, if peak positions are
76# NOT predicted.  NOTE: This number must be choosen carefully.  If too
77# many peaks are requested, find peaks will take a very long time and
78# the returned peaks will probably not even index, since most of them
79# will be "noise" peaks.  If too few are requested, then there will be
80# few peaks to be integrated, and the UB matrix may not be as accurate
81# as it should be for predicting peaks to integrate.
82#
83num_peaks_to_find 400
84
85#
86# min_d, max_d and tolerance control indexing peaks.  max_d is also
87# used to specify a threshold for the separation between peaks
88# returned by FindPeaksMD, so it should be specified somewhat larger
89# than the largest cell edge in the Niggli reduced cell for the
90# sample.
91#
92min_d         8
93max_d        20
94tolerance  0.12
95
96#
97# If predicted peak positions are to be integrated,
98# the integrate_predicted_peaks flag should be set to True and the range
99# of wavelengths and d-spacings must be specified
100#
101integrate_predicted_peaks   False
102min_pred_wl                 0.4
103max_pred_wl                 3.5
104min_pred_dspacing           0.5
105max_pred_dspacing           8.5
106
107#
108# Select only ONE of the following integration methods, by setting the
109# use_*****_integration flag True.
110#
111use_sphere_integration           True
112use_ellipse_integration          False
113use_fit_peaks_integration        False
114use_cylindrical_integration      False
115
116#
117# Specify sphere and ellipse integration control parameters. Check that these
118# are correct, if use_sphere_integration, or use_ellipse_integration is True.
119# Otherwise the values aren't used.
120#
121peak_radius             0.080      # for sphere integration only
122bkg_inner_radius        0.080      # for sphere or ellipse integration
123bkg_outer_radius        0.110     # for sphere or ellipse integration
124integrate_if_edge_peak  True       # for sphere integration only
125
126#
127# Specify ellispe integration control parameters
128#
129ellipse_region_radius   0.16
130ellipse_size_specified  True
131
132#
133# Specify fit peaks integration control parameters.  Check that these are
134# correct, if use_fit_peaks_integration = True.  Otherwise the values
135# aren't used.
136#
137rebin_step            -0.004
138preserve_events       True
139use_ikeda_carpenter   False
140n_bad_edge_pixels      0
141
142
143#
144# Specify cylindrical integration control parameters
145#
146cylinder_radius      0.05
147cylinder_length      0.30
148
149# ==========================================================================
150# Additional Parameters needed by ReduceSCD_Parallel.py, to process
151# multiple runs in parallel.
152# ==========================================================================
153#
154exp_name               SPAnH_test     
155reduce_one_run_script  ReduceSCD_OneRun_v1.py
156
157#
158# Specify the run numbers that should be reduced.  This can be done on several
159# lines.  Each line must start with the parameter name run_nums and be followed
160# by a comma separated list of individual run numbers or ranges of run numbers.
161# A range of run numbers is specified by listing the first number and last
162# number in the range, separated by a colon.
163#
164run_nums  8512:8513
165
166#
167# Specify the slurm partion, or None to use local processes.  The parameter
168# max_processes controls the maximum number of processes that will be run
169# simultaneously locally, or that will be simultaneously submitted to slurm.
170# The value of max_processes should be choosen carefully with the size of the
171# system in mind, to avoid overloading the system.  Since the lower level
172# calculations are all multi-threaded, this should be substantially lower than
173# the total number of cores available.
174# All runs will be processed eventually.  If there are more runs than then
175# max_processes, as some processes finish, new ones will be started, until
176# all runs have been processed.
177#
178#slurm_queue_name    topazq
179slurm_queue_name    None
180max_processes       13
181