PSQ_DAScale_GetHelp: Nicify help text by moving the operation mode to…

… the front

Packages/MIES/MIES_AnalysisFunctions_PatchSeq.ipf

@@ -4018,52 +4018,48 @@ Function/S PSQ_DAScale_GetHelp(string name)
 		case "SamplingMultiplier":
 			return PSQ_GetHelpCommon(PSQ_DA_SCALE, name)
 		case "DAScaleModifier":
-			return "Percentage how the DAScale value is adapted if it is outside of the " \
-			       + "MinimumSpikeCount\"/\"MaximumSpikeCount\" band. Only for \"Supra\"."
+			return "Supra: Percentage how the DAScale value is adapted if it is outside of the " \
+			       + "MinimumSpikeCount\"/\"MaximumSpikeCount\" band."
 		case "DAScaleNegativeSlopePercent":
-			return "Percentage to use for DAScale estimation once the f-I slopes get negative/zero. Only for \"AdaptiveSupra\"."
+			return "AdaptiveSupra: Percentage to use for DAScale estimation once the f-I slopes get negative/zero."
 		case "DAScaleRangeFactor":
-			return "Fallback factor to apply to the input DAScale range for calculating "                                   \
-			       + "the DAScale minimum step width when all previous f-I data from Rheobase/Supra/Adaptive is constant. " \
-			       + "Only for \"AdaptiveSupra\"."
+			return "AdaptiveSupra: Fallback factor to apply to the input DAScale range for calculating "                  \
+			       + "the DAScale minimum step width when all previous f-I data from Rheobase/Supra/Adaptive is constant. "
 		case "DaScaleStepWidthMinMaxRatio":
-			return "Number of times the maximum DAScale step width is larger than the calculated minimum. " + \
-			       "Only for \"AdaptiveSupra\"."
+			return "AdaptiveSupra: Number of times the maximum DAScale step width is larger than the calculated minimum."
 		case "DAScales":
-			return "DA Scale Factors in pA"
+			return "Sub and Supra: DA Scale Factors in pA"
 		case "AbsFrequencyMinDistance":
-			return "Minimum absolute frequency distance for DAScale estimation. Only for \"AdaptiveSupra\"."
+			return "AdaptiveSupra: Minimum absolute frequency distance for DAScale estimation."
 		case "FailingAdaptiveSCIRange":
-			return "Number of stimset cycles (SCIs) we search backwards in time for failing Adaptive sets, defaults to 1. " \
-			       + "Set to 0 to turn it off and inf to look into all available SCIs. Only for \"AdaptiveSupra\"."
+			return "AdaptiveSupra: Number of stimset cycles (SCIs) we search backwards in time for failing Adaptive sets, defaults to 1. " \
+			       + "Set to 0 to turn it off and inf to look into all available SCIs."
 		case "MaxFrequencyChangePercent":
-			return "The maximum allowed difference for the frequency for two consecutive measurements. "           \
-			       + "In case this value is overshot, we redo the measurement with a fitting DAScale in-between. " \
-			       + "Only for \"AdaptiveSupra\"."
+			return "AdaptiveSupra: The maximum allowed difference for the frequency for two consecutive measurements. " \
+			       + "In case this value is overshot, we redo the measurement with a fitting DAScale in-between. "
 		case "NumSweepsWithSaturation":
-			return "Number of required consecutive passing sweeps to have passing sweep QC and f-I slope QC, defaults to 2. " + \
-			       "Only for \"AdaptiveSupra\"."
+			return "AdaptiveSupra: Number of required consecutive passing sweeps to have passing sweep QC and f-I slope QC, defaults to 2."
 		case "SlopePercentage":
-			return "Once the slope of the f-I fit is x percentage smaller "                                     \
-			       + "compared with the maximum slope, the stimset cycle is stopped. Only for \"AdaptiveSupra\"."
+			return "AdaptiveSupra: Once the slope of the f-I fit is x percentage smaller " \
+			       + "compared with the maximum slope, the stimset cycle is stopped."
 		case "FinalSlopePercent":
-			return "As additional passing criteria the slope of the f-I plot must be larger than this value. " \
-			       + "Note: The slope is used in percent. Only for \"Supra\"."
+			return "Supra: As additional passing criteria the slope of the f-I plot must be larger than this value. " \
+			       + "Note: The slope is used in percent."
 		case "MaximumSpikeCount":
-			return "The upper limit of the number of spikes. Only for \"Supra\"."
+			return "Supra: The upper limit of the number of spikes."
 		case "MinimumSpikeCount":
-			return "The lower limit of the number of spikes. Only for \"Supra\"."
+			return "Supra: The lower limit of the number of spikes."
 		case "MinimumSpikeCountForMaxSlope":
-			return "The minimum number of spikes required for a sweep to be considered as having the maximum f-I slope. Only for \"Adaptive\""
+			return "Adaptive: The minimum number of spikes required for a sweep to be considered as having the maximum f-I slope."
 		case "OffsetOperator":
-			return "Set the math operator to use for "                                    \
+			return "Supra: Set the math operator to use for "                             \
 			       + "combining the rheobase DAScale value from the previous run and "    \
 			       + "the DAScales values. Valid strings are \"+\" (addition) and \"*\" " \
-			       + "(multiplication). Only for \"Supra\" and defaults to \"+\"."
+			       + "(multiplication). Defaults to \"+\"."
 		case "OperationMode":
 			return "Operation mode of the analysis function. Can be either \"Sub\"/\"Supra\"/\"AdaptiveSupra\"."
 		case "ShowPlot":
-			return "Show the resistance (\"Sub\") or the f-I (\"Supra\") plot, defaults to true."
+			return "Sub and Supra: Show the resistance (\"Sub\") or the f-I (\"Supra\") plot, defaults to true."
 		default:
 			ASSERT(0, "Unimplemented for parameter " + name)
 	endswitch

Packages/MIES/analysis_function_parameters.itx

@@ -2,7 +2,7 @@ IGOR
 WAVES/T/N=(69,5)	analysis_function_parameters
 BEGIN
 	"Name"	"Type"	"Optionality"	"Used by"	"Help"
-	"AbsFrequencyMinDistance"	"variable"	"optional"	"DA"	"Minimum absolute frequency distance for DAScale estimation. Only for \"AdaptiveSupra\"."
+	"AbsFrequencyMinDistance"	"variable"	"optional"	"DA"	"AdaptiveSupra: Minimum absolute frequency distance for DAScale estimation."
 	"AbsoluteVoltageDiff"	"variable"	"required"	"VM"	"Maximum absolute allowed difference of the baseline membrane potentials [mV].\r Set to `inf` to disable this check."
 	"AmpBesselFilter"	"variable"	"optional"	"CR"	"Applies a bessel filter to the primary output.\r Defaults to 10e3 [Hz],pass \"100000\" to select \"Bypass\"."
 	"AmpBesselFilterRestore"	"variable"	"optional"	"CR"	"Restores the previously active bessel filter in POST_SET_EVENT. Defaults to ON."
@@ -15,33 +15,33 @@ BEGIN
 	"BaselineRMSShortThreshold"	"variable"	"optional"	"AR, CR, DA, PB, RA, RB, SE, VM"	"Threshold value in mV for the short RMS baseline QC check (defaults to 0.07)"
 	"BaselineTargetVThreshold"	"variable"	"optional"	"CR, DA, RA, RB"	"Threshold value in mV for the target V baseline QC check (defaults to 1)"
 	"BoundsEvaluationMode"	"string"	"required"	"CR"	"Select the bounds evaluation mode: Symmetric (Lower and Upper), Depolarized (Upper) or Hyperpolarized (Lower)"
-	"DAScaleModifier"	"variable"	"mixed"	"CR, DA, SC"	"Modifier value to the DA Scale of headstages with spikes during chirp\rPercentage how the DAScale value is adapted if it is outside of the MinimumSpikeCount\"/\"MaximumSpikeCount\" band. Only for \"Supra\".\rModifier value to the DA Scale of headstages for too few spikes"
-	"DAScaleNegativeSlopePercent"	"variable"	"optional"	"DA"	"Percentage to use for DAScale estimation once the f-I slopes get negative/zero. Only for \"AdaptiveSupra\"."
+	"DAScaleModifier"	"variable"	"mixed"	"CR, DA, SC"	"Modifier value to the DA Scale of headstages with spikes during chirp\rSupra: Percentage how the DAScale value is adapted if it is outside of the MinimumSpikeCount\"/\"MaximumSpikeCount\" band.\rModifier value to the DA Scale of headstages for too few spikes"
+	"DAScaleNegativeSlopePercent"	"variable"	"optional"	"DA"	"AdaptiveSupra: Percentage to use for DAScale estimation once the f-I slopes get negative/zero."
 	"DAScaleOperator"	"string"	"mixed"	"CR, SC"	"Set the math operator to use for combining the DAScale and the modifier. Valid strings are \"+\" (addition) and \"*\" (multiplication).\rSet the math operator to use for combining the DAScale and the too few spikes modifier. Valid strings are \"+\" (addition) and \"*\" (multiplication)."
-	"DAScaleRangeFactor"	"variable"	"optional"	"DA"	"Fallback factor to apply to the input DAScale range for calculating the DAScale minimum step width when all previous f-I data from Rheobase/Supra/Adaptive is constant. Only for \"AdaptiveSupra\"."
-	"DAScales"	"wave"	"required"	"DA, DS"	"DA Scale Factors in pA"
+	"DAScaleRangeFactor"	"variable"	"optional"	"DA"	"AdaptiveSupra: Fallback factor to apply to the input DAScale range for calculating the DAScale minimum step width when all previous f-I data from Rheobase/Supra/Adaptive is constant. "
+	"DAScales"	"wave"	"required"	"DA, DS"	"DA Scale Factors in pA\rSub and Supra: DA Scale Factors in pA"
 	"DAScaleSpikePositionModifier"	"variable"	"required"	"SC"	"Modifier value to the DA Scale of headstages with failing spike positions."
 	"DAScaleSpikePositionOperator"	"string"	"required"	"SC"	"Set the math operator to use for combining the DAScale and the spike position modifier. Valid strings are \"+\" (addition) and \"*\" (multiplication)."
-	"DaScaleStepWidthMinMaxRatio"	"variable"	"optional"	"DA"	"Number of times the maximum DAScale step width is larger than the calculated minimum. Only for \"AdaptiveSupra\"."
+	"DaScaleStepWidthMinMaxRatio"	"variable"	"optional"	"DA"	"AdaptiveSupra: Number of times the maximum DAScale step width is larger than the calculated minimum."
 	"DaScaleTooManySpikesModifier"	"variable"	"required"	"SC"	"Modifier value to the DA Scale of headstages for too many spikes"
 	"DaScaleTooManySpikesOperator"	"string"	"required"	"SC"	"Set the math operator to use for combining the DAScale and the too many spikes modifier. Valid strings are \"+\" (addition) and \"*\" (multiplication)."
 	"FailedLevel"	"variable"	"mixed"	"CR, VM"	"Absolute level for spike search"
 	"FailedPulseLevel"	"variable"	"optional"	"SC"	"[Optional, uses the already set value] Numeric level to use for the failed pulse search in the PA plot tab."
-	"FailingAdaptiveSCIRange"	"variable"	"optional"	"DA"	"Number of stimset cycles (SCIs) we search backwards in time for failing Adaptive sets, defaults to 1. Set to 0 to turn it off and inf to look into all available SCIs. Only for \"AdaptiveSupra\"."
-	"FinalSlopePercent"	"variable"	"optional"	"DA"	"As additional passing criteria the slope of the f-I plot must be larger than this value. Note: The slope is used in percent. Only for \"Supra\"."
+	"FailingAdaptiveSCIRange"	"variable"	"optional"	"DA"	"AdaptiveSupra: Number of stimset cycles (SCIs) we search backwards in time for failing Adaptive sets, defaults to 1. Set to 0 to turn it off and inf to look into all available SCIs."
+	"FinalSlopePercent"	"variable"	"optional"	"DA"	"Supra: As additional passing criteria the slope of the f-I plot must be larger than this value. Note: The slope is used in percent."
 	"IdealNumberOfSpikesPerPulse"	"variable"	"required"	"SC"	"Ideal number of spike which should be present. Overwrites the PA plot GUI value."
 	"InnerRelativeBound"	"variable"	"required"	"CR"	"Lower bound of a confidence band for the acquired data relative to the pre pulse baseline in mV. Must be positive."
 	"InterTrialInterval"	"variable"	"optional"	"VM"	"Inter trial interval to set, defaults to 10 [s]"
 	"MaxAccessResistance"	"variable"	"required"	"AR"	"Maximum allowed acccess resistance [MΩ]"
 	"MaxAccessToSteadyStateResistanceRatio"	"variable"	"required"	"AR"	"Maximum allowed ratio of access to steady state resistance [%]"
-	"MaxFrequencyChangePercent"	"variable"	"optional"	"DA"	"The maximum allowed difference for the frequency for two consecutive measurements. In case this value is overshot, we redo the measurement with a fitting DAScale in-between. Only for \"AdaptiveSupra\"."
+	"MaxFrequencyChangePercent"	"variable"	"optional"	"DA"	"AdaptiveSupra: The maximum allowed difference for the frequency for two consecutive measurements. In case this value is overshot, we redo the measurement with a fitting DAScale in-between. "
 	"MaximumDAScale"	"variable"	"required"	"FR"	"Maximum allowed DAScale, set to NaN to turn the check off [pA]"
-	"MaximumSpikeCount"	"variable"	"optional"	"DA"	"The upper limit of the number of spikes. Only for \"Supra\"."
+	"MaximumSpikeCount"	"variable"	"optional"	"DA"	"Supra: The upper limit of the number of spikes."
 	"MaxLeakCurrent"	"variable"	"required"	"AR, PB"	"Maximum current [pA] which is allowed in the pre pulse baseline"
 	"MaxPipetteResistance"	"variable"	"required"	"PB"	"Maximum allowed pipette resistance [MΩ]"
 	"MaxTrials"	"variable"	"optional"	"SC"	"[Optional, defaults to infinity] A sweep is rerun this many times on a failed headstage."
-	"MinimumSpikeCount"	"variable"	"optional"	"DA"	"The lower limit of the number of spikes. Only for \"Supra\"."
-	"MinimumSpikeCountForMaxSlope"	"variable"	"optional"	"DA"	"The minimum number of spikes required for a sweep to be considered as having the maximum f-I slope. Only for \"Adaptive\""
+	"MinimumSpikeCount"	"variable"	"optional"	"DA"	"Supra: The lower limit of the number of spikes."
+	"MinimumSpikeCountForMaxSlope"	"variable"	"optional"	"DA"	"Adaptive: The minimum number of spikes required for a sweep to be considered as having the maximum f-I slope."
 	"MinimumSpikePosition"	"variable"	"required"	"SC"	"Minimum allowed spike positions in pulse active coordinate system (0 - 100)."
 	"MinPipetteResistance"	"variable"	"required"	"PB"	"Minimum allowed pipette resistance [MΩ]"
 	"NextIndexingEndStimSetName"	"string"	"optional"	"AR, PB, SE, VM"	"Next indexing end stimulus set which should be set in case of success.\r Also enables indexing."
@@ -50,8 +50,8 @@ BEGIN
 	"NumberOfFailedSweeps"	"variable"	"required"	"AR, CR, PB, SE, VM"	"Number of failed sweeps which marks the set as failed."
 	"NumberOfSpikes"	"variable"	"required"	"RA"	"Number of spikes required to be found after the pulse onset in order to label the cell as having \"spiked\"."
 	"NumberOfTestpulses"	"variable"	"required"	"AR, PB"	"Expected number of testpulses in the stimset"
-	"NumSweepsWithSaturation"	"variable"	"optional"	"DA"	"Number of required consecutive passing sweeps to have passing sweep QC and f-I slope QC, defaults to 2. Only for \"AdaptiveSupra\"."
-	"OffsetOperator"	"string"	"optional"	"DA"	"Set the math operator to use for combining the rheobase DAScale value from the previous run and the DAScales values. Valid strings are \"+\" (addition) and \"*\" (multiplication). Only for \"Supra\" and defaults to \"+\"."
+	"NumSweepsWithSaturation"	"variable"	"optional"	"DA"	"AdaptiveSupra: Number of required consecutive passing sweeps to have passing sweep QC and f-I slope QC, defaults to 2."
+	"OffsetOperator"	"string"	"optional"	"DA"	"Supra: Set the math operator to use for combining the rheobase DAScale value from the previous run and the DAScales values. Valid strings are \"+\" (addition) and \"*\" (multiplication). Defaults to \"+\"."
 	"OperationMode"	"string"	"required"	"DA"	"Operation mode of the analysis function. Can be either \"Sub\"/\"Supra\"/\"AdaptiveSupra\"."
 	"OuterRelativeBound"	"variable"	"required"	"CR"	"Upper bound of a confidence band for the acquired data relative to the pre pulse baseline in mV. Must be positive."
 	"PostDAQDAScale"	"variable"	"required"	"FR"	"If true the found DAScale value will be set at the end of the set"
@@ -62,8 +62,8 @@ BEGIN
 	"SamplingFrequency"	"variable"	"optional"	"AR, CR, DA, PB, RA, RB, SE, SP, VM"	"Required sampling frequency for the acquired data [kHz]. Defaults to ITC:50 NI:50 Sutter:50.\rRequired sampling frequency for the acquired data [kHz]. Defaults to ITC:200 NI:250 Sutter:50.\rRequired sampling frequency for the acquired data [kHz]. Defaults to ITC:50 NI:50 Sutter:50.\rRequired sampling frequency for the acquired data [kHz]. Defaults to ITC:50 NI:50 Sutter:50.\rRequired sampling frequency for the acquired data [kHz]. Defaults to ITC:200 NI:250 Sutter:50.\rRequired sampling frequency for the acquired data [kHz]. Defaults to ITC:50 NI:50 Sutter:50.\rRequired sampling frequency for the acquired data [kHz]. Defaults to ITC:200 NI:250 Sutter:50."
 	"SamplingMultiplier"	"variable"	"required"	"AR, CR, DA, FR, PB, RA, RB, SE, SP, VM"	"Sampling multiplier, use 1 for no multiplier"
 	"SealThreshold"	"variable"	"required"	"SE"	"Minimum required seal threshold [GΩ]"
-	"ShowPlot"	"variable"	"optional"	"DA"	"Show the resistance (\"Sub\") or the f-I (\"Supra\") plot, defaults to true."
-	"SlopePercentage"	"variable"	"optional"	"DA"	"Once the slope of the f-I fit is x percentage smaller compared with the maximum slope, the stimset cycle is stopped. Only for \"AdaptiveSupra\"."
+	"ShowPlot"	"variable"	"optional"	"DA"	"Sub and Supra: Show the resistance (\"Sub\") or the f-I (\"Supra\") plot, defaults to true."
+	"SlopePercentage"	"variable"	"optional"	"DA"	"AdaptiveSupra: Once the slope of the f-I fit is x percentage smaller compared with the maximum slope, the stimset cycle is stopped."
 	"SpikeCheck"	"variable"	"optional"	"CR"	"Toggle spike check during the chirp. Defaults to off."
 	"SpikeFailureIgnoredTime"	"variable"	"required"	"VM"	"Time [ms] to ignore around spikes for average calculation.\r Half of this value before and after each spike."
 	"TestPulseGroupSelector"	"string"	"optional"	"SE"	"Group(s) which have their resistance evaluated: One of Both/First/Second, defaults to Both"

Packages/tests/Basic/UTF_AnalysisFunctionParameters.ipf

@@ -933,7 +933,7 @@ static Function GenerateAnalysisFunctionTable()
 	// if this test fails and the CRC changes
 	// commit the file `Packages/MIES/analysis_function_parameters.itx`
 	// and check that the changes therein are intentional
-	CHECK_EQUAL_VAR(WaveCRC(0, output, 0), 4072072509)
+	CHECK_EQUAL_VAR(WaveCRC(0, output, 0), 3170650258)
 	StoreWaveOnDisk(output, "analysis_function_parameters")
 End