Source
2021
2021
-1, or greater than 0. Negative means no limit. (default -1)
2022
2022
2023
2023
If the major cycle limit is reached stopcode 9 will be returned. Other stopping
2024
2024
criteria (such as threshold) could cause tclean to stop in fewer than this
2025
2025
number of major cycles. If tclean reaches another stopping criteria, first
2026
2026
or at the same time as nmajor, then that stopcode will be returned instead.
2027
2027
2028
2028
If calcres=True, then an additional major cycle will be executed prior to
2029
2029
starting clean. This additional major cycle will be visible in the logs, but
2030
2030
it will not be included in the count for nmajor.
2031
+
2032
+
For example, consider the following two use cases. For both cases, there will
2033
+
be a printout in the logs "Running Major Cycle 1" and the return value will
2034
+
include "nmajordone: 1", however there is a difference in the purpose of
2035
+
the major cycle and the number of minor cycles executed:
2036
+
Case 1; nmajor=0, calcres=True: The major cycle done is for the creation
2037
+
of the residual, and no minor cycles are executed.
2038
+
Case 2; nmajor=1, calcres=False: The major cycle is done as part of the
2039
+
major/minor cycle loop, and 1 minor cycle will be executed.
2031
2040
</description>
2032
2041
<value type="int">-1</value>
2033
2042
</param>
2034
2043
2035
2044
2036
2045
2037
2046
2038
2047
2039
2048
2040
2049
<param type="string" name="usemask">