File MIES_SweepFormula_Operations.ipf

SFO Sweep Formula Operations

Functions

wave SFO_OperationAnaFuncParam(SF_ExecutionData *exd)
wave SFO_OperationAnaFuncParamIterate(string graph, WaveText names, WaveRefWaveOrNull selectDataArray, string opShort)
static wave SFO_OperationAnaFuncParamImpl(string graph, WaveText names, WaveOrNull selectData, string opShort)
static wave SFO_OperationAnaFuncParamImplAllNames(WaveText names, WaveRefWave lbnParams)

Gather all requested analysis function parameters with wildcard support

Parameters:
  • names – requested analysis function parameter names, can include wildcards

  • lbnParams – wave reference wave, one wave per selectData entry, with the analysis function parameter data from the labnotebook including JWN metadata

Returns:

expanded analysis function parameter names (i.e. without wildcards) which match at least in one selectData entry

wave SFO_OperationApFrequency(SF_ExecutionData *exd)
static variable SFO_OperationApFrequencyNormalizeOverSweeps(WaveRefWave output, variable normValue)
static variable SFO_OperationApFrequencyNormalizeOverSweepsImpl(WaveOrNull data, variable normValue)
static wave SFO_OperationApFrequencyImpl(WaveOrNull data, variable level, variable method, string yStr, string normStr, string xAxisTypeStr, variable *normOSValue, wave normMean)
static string SFO_OperationApFrequencyMethodToString(variable method)
static variable SFO_ApFrequencyInstantaneous(wave peaksAt)
static wave SFO_ApFrequencyInstantaneousPairs(wave peaksAt, variable yModeTime, variable xAxisIsCounts)
wave SFO_OperationArea(SF_ExecutionData *exd)
static wave SFO_OperationAreaImpl(WaveOrNull input, variable zero)
wave SFO_OperationAvg(SF_ExecutionData *exd)
static wave SFO_OperationAvgImplOver(WaveRefWave input, string graph, string opShort)
static wave SFO_OperationAvgImplIn(WaveOrNull input)
wave SFO_OperationButterworth(SF_ExecutionData *exd)

butterworth(data, lowPassCutoff, highPassCutoff, order)

static wave SFO_OperationButterworthImpl(WaveOrNull input, variable lowPassCutoff, variable highPassCutoff, variable order)
wave SFO_OperationConcat(SF_ExecutionData *exd)

concat(array0, array1, array2, …)

wave SFO_OperationCursors(SF_ExecutionData *exd)
wave SFO_OperationData(SF_ExecutionData *exd)

data(array range[, array selectData])

returns [sweepData][sweeps][channelTypeNumber] for all sweeps selected by selectData

wave SFO_OperationDataset(SF_ExecutionData *exd)
wave SFO_OperationDerivative(SF_ExecutionData *exd)
static wave SFO_OperationDerivativeImpl(WaveOrNull input)
wave SFO_OperationDiv(SF_ExecutionData *exd)
static wave SFO_OperationDivImplDataSets(WaveOrNull data0, WaveOrNull data1)
wave SFO_OperationEpochs(SF_ExecutionData *exd)
static wave SFO_OperationEpochsImpl(string graph, WaveText epochPatterns, WaveOrNull selectData, variable epType, string opShort)
wave SFO_OperationFindLevel(SF_ExecutionData *exd)
wave SFO_OperationFit(SF_ExecutionData *exd)
wave SFO_OperationFitImpl(wave xData, wave yData, string fitFunc, wave holdWave, wave initialValues)
wave SFO_OperationFitLine(SF_ExecutionData *exd)
wave SFO_OperationIntegrate(SF_ExecutionData *exd)
static wave SFO_OperationIntegrateImpl(WaveOrNull input)
wave SFO_OperationLabnotebook(SF_ExecutionData *exd)

labnotebook(array keys[, array selectData [, string entrySourceType]])

return lab notebook key for all sweeps that belong to the channels channels

static wave SFO_OperationLabnotebookIterate(string graph, WaveText lbnKeys, WaveRefWaveOrNull selectDataArray, variable mode, string opShort)
static wave SFO_OperationLabnotebookImpl(string graph, WaveText LBNKeys, WaveOrNull selectData, variable mode, string opShort)
static wave SFO_OperationLabnotebookImplGetEntry(string graph, wave selectData, variable index, string lbnKey, variable mode)
static string SFO_GetLabnotebookEntryUnits_Impl(wave numericalKeys, wave textualKeys, string entry)
static wave SFO_GetLabnotebookEntryUnits(string graph, WaveText allLBNKeys, wave selectData)
static wave SFO_OperationLabnotebookExpandKeys(string graph, WaveText LBNKeys, wave selectData, variable mode)
wave SFO_OperationLog(SF_ExecutionData *exd)
static variable SFO_OperationLogImpl(WaveOrNull input)
wave SFO_OperationLog10(SF_ExecutionData *exd)
static wave SFO_OperationLog10Impl(WaveOrNull input)
wave SFO_OperationMax(SF_ExecutionData *exd)
static wave SFO_OperationMaxImpl(WaveOrNull input)
wave SFO_OperationMerge(SF_ExecutionData *exd)
wave SFO_OperationMin(SF_ExecutionData *exd)
static wave SFO_OperationMinImpl(WaveOrNull input)
wave SFO_OperationMinus(SF_ExecutionData *exd)
static wave SFO_OperationMinusImplDataSets(WaveOrNull data0, WaveOrNull data1)
wave SFO_OperationMult(SF_ExecutionData *exd)
static wave SFO_OperationMultImplDataSets(WaveOrNull data0, WaveOrNull data1)
wave SFO_OperationPlus(SF_ExecutionData *exd)
static wave SFO_OperationPlusImplDataSets(WaveOrNull data0, WaveOrNull data1)
wave SFO_OperationPowerSpectrum(SF_ExecutionData *exd)
static wave SFO_PowerSpectrumRatio(WaveOrNull input, variable ratioFreq, variable deltaHz, wave fitData = defaultValue)
variable SFO_LineNoiseFit(wave w, variable x)
static wave SFO_OperationPowerSpectrumImpl(WaveOrNull input, string unit, variable cutoff, string winFunc)
wave SFO_OperationRange(SF_ExecutionData *exd)

range (start[, stop[, step]])

wave SFO_OperationRMS(SF_ExecutionData *exd)
static wave SFO_OperationRMSImpl(WaveOrNull input)
wave SFO_OperationSetScale(SF_ExecutionData *exd)

setscale(data, dim, [dimOffset, [dimDelta[, unit]]])

static wave SFO_OperationSetScaleImpl(WaveOrNull input, string dim, variable offset, variable delta, string unit)
wave SFO_OperationStdev(SF_ExecutionData *exd)
static wave SFO_OperationStdevImpl(WaveOrNull input)
wave SFO_OperationStore(SF_ExecutionData *exd)
wave SFO_OperationText(SF_ExecutionData *exd)
static wave SFO_OperationTextImpl(WaveOrNull input)
wave SFO_OperationVariance(SF_ExecutionData *exd)
static wave SFO_OperationVarianceImpl(WaveOrNull input)
wave SFO_OperationWave(SF_ExecutionData *exd)
wave SFO_OperationXValues(SF_ExecutionData *exd)
static wave SFO_OperationXValuesImpl(WaveOrNull input)
static wave SFO_IndexOverDataSetsForPrimitiveOperation(SF_ExecutionData *exd, string opShort)
static variable SFO_AssertOnMismatchedWaves(wave data0, wave data1, string opShort)
static std::tuple<WaveDouble, WaveDouble> SFO_ParseFitConstraints(WaveTextOrNull constraints, variable numParameters)
static wave SFO_GetNumericVarArgs(SF_ExecutionData *exd, string opShort)
static variable SFO_RemoveEndOfSweepNaNs(WaveOrNull input)
static wave SFO_AverageDataOverSweeps(WaveRefWave input)
static wave SFO_SweepAverageHelper(WaveRefWave group)

Variables

static const double SF_APFREQUENCY_FULL = 0x0
static const double SF_APFREQUENCY_INSTANTANEOUS = 0x1
static const double SF_APFREQUENCY_APCOUNT = 0x2
static const double SF_APFREQUENCY_INSTANTANEOUS_PAIR = 0x3
static const string SF_OP_APFREQUENCY_Y_TIME = "time"
static const string SF_OP_APFREQUENCY_Y_FREQ = "freq"
static const string SF_OP_APFREQUENCY_NORMOVERSWEEPSMIN = "normoversweepsmin"
static const string SF_OP_APFREQUENCY_NORMOVERSWEEPSMAX = "normoversweepsmax"
static const string SF_OP_APFREQUENCY_NORMOVERSWEEPSAVG = "normoversweepsavg"
static const string SF_OP_APFREQUENCY_NORMWITHINSWEEPMIN = "norminsweepsmin"
static const string SF_OP_APFREQUENCY_NORMWITHINSWEEPMAX = "norminsweepsmax"
static const string SF_OP_APFREQUENCY_NORMWITHINSWEEPAVG = "norminsweepsavg"
static const string SF_OP_APFREQUENCY_NONORM = "nonorm"
static const string SF_OP_APFREQUENCY_X_COUNT = "count"
static const string SF_OP_APFREQUENCY_X_TIME = "time"
static const string SF_OP_AVG_INSWEEPS = "in"
static const string SF_OP_AVG_OVERSWEEPS = "over"
static const string SF_OP_EPOCHS_TYPE_RANGE = "range"
static const string SF_OP_EPOCHS_TYPE_NAME = "name"
static const string SF_OP_EPOCHS_TYPE_TREELEVEL = "treelevel"
static const double EPOCHS_TYPE_INVALID = -1
static const double EPOCHS_TYPE_RANGE = 0
static const double EPOCHS_TYPE_NAME = 1
static const double EPOCHS_TYPE_TREELEVEL = 2
static const string SF_POWERSPECTRUM_UNIT_DEFAULT = "default"
static const string SF_POWERSPECTRUM_UNIT_DB = "db"
static const string SF_POWERSPECTRUM_UNIT_NORMALIZED = "normalized"
static const string SF_POWERSPECTRUM_AVG_ON = "avg"
static const string SF_POWERSPECTRUM_AVG_OFF = "noavg"
static const string SF_POWERSPECTRUM_WINFUNC_NONE = "none"
static const double SF_POWERSPECTRUM_RATIO_DELTAHZ = 10
static const double SF_POWERSPECTRUM_RATIO_EPSILONHZ = 0.25
static const double SF_POWERSPECTRUM_RATIO_EPSILONPOSFIT = 1E-3
static const double SF_POWERSPECTRUM_RATIO_MAXFWHM = 5
static const double SF_POWERSPECTRUM_RATIO_GAUSS_SIGMA2FWHM = 2.35482004503
static const double SF_POWERSPECTRUM_RATIO_GAUSS_NUMCOEFS = 4
static const string SF_AVERAGING_NONSWEEPDATA_LBL = "NOSWEEPDATA"