CrossCorrelationSynchronization¶

class CrossCorrelationSynchronization¶

Clone()¶

Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.

Returns:: A copy of this object
Return type:: CrossCorrelationSynchronization

EnableConsiderNegative(enable=True)¶

Enables or disables (default) the consideration of negative correlations.

Parameters:

enable : bool¶: True to enable, False to disable

EnableMinCorrelation(enable=True)¶

Enables (default) or disables the check for a minimum necessary correlation coefficient between the matched signals.

Parameters:

enable : bool¶: True to enable, False to disable

GetMaster()¶

Returns the master recording group for this synchronization.

Returns:: The master recording group
Return type:: RecordingGroup

GetMasterSignal()¶

Returns the signalName and signalType of the master signal. The type will be either “PHY” (interpreted as number) or “RAW” (raw values).

Returns:: Dictionary with keys “signalName”, “signalType”
Return type:: dict[str, str]

GetMaxDeltaT()¶

Returns the bound for deltaT. If deltaT is found to be greater than this bound, the synchronization will fail.

Returns:: The maximum for deltaT as expression
Return type:: str

GetMinCorrelation()¶

Returns the minimum necessary correlation coefficient for the synchronization.

Returns:: Minimum necessary correlation coefficient
Return type:: str

GetOffset()¶

Returns the (known) offset. The offset will be added to the calculated deltaT. By default, it is only used for the OffsetSynchronization.

Returns:: The (known) offset as expression
Return type:: str

GetOffsetUsed()¶

Sets whether the known offset should be applied. For the ExpectationSynchronization and EqualnessMatchingSynchronization the known offset will be added to the calculated deltaT. The known offset will always be used by the OffsetSynchronization.

Returns:: True if the offset will be used, else False.
Return type:: boolean

GetRecordingGroupName()¶

Returns the name of the recording group for this synchronization.

Returns:: The name of the recording group
Return type:: str

GetRecordingSignal()¶

Returns the signalName and signalType of the recording signal for synchronization. The type will be either “PHY” (interpreted as number) or “RAW” (raw values).

Returns:: Dictionary with keys “signalName”, “signalType”
Return type:: dict[str, str]

GetResolution()¶

Returns the resolution (step size) at which the synchronization offset is determined.

Returns:: Resolution (step size) for the synchronization as expression
Return type:: str

GetTimeLimit()¶

Returns the time stamp relative to the first time stamp (of the recording group and master recording group) until that the running synchronization will be evaluated. If the time limit is reached, the synchronization will fail.

Returns:: The relative time limit as expression
Return type:: str

GetType()¶

Returns the type of this synchronization.

Returns:: The type of this synchronization (can be ‘Offset’, ‘Expectation’, ‘EqualnessMatching’ or ‘LeastSquares’, ‘AutosarTime’)
Return type:: str

IsConsiderNegativeEnabled()¶

Returns whether the consideration of negative correlations is enabled.

Returns:: True if feature is active, False otherwise
Return type:: bool

IsFirstSampleDifferenceCorrected()¶

Returns whether the parameter maxDeltaT is corrected by the difference of the time stamps of the first samples (of the recording group and master recording group). Suppose that the time axes to be synchronized start at 20s and 50s, respectively. Then activating this option acts as if maxDeltaT was increased by 30s.

Returns:: The setting for the interpretation of maxDeltaT
Return type:: boolean

IsMinCorrelationEnabled()¶

Returns whether a comparison with a minimum necessary correlation coefficient is performed.

Returns:: True if feature is active, False otherwise
Return type:: bool

SetFirstSampleDifferenceCorrected(isCorrected)¶

Sets whether the parameter maxDeltaT is corrected by the difference of the time stamps of the first samples (of the recording group and master recording group). Suppose that the time axes to be synchronized start at 20s and 50s, respectively. Then activating this option acts as if maxDeltaT was increased by 30s.

Parameters:

isCorrected : boolean¶: The setting for the interpretation of maxDeltaT

SetMaster(recordingGroup)¶

Sets the master recording group for the synchronization.

Parameters:

recordingGroup¶: The master recording group.

SetMasterSignal(signalName, signalType='PHY')¶

Sets name and type of the master signal for the synchronization. The type must be either “PHY” (interpreted as number, default) or “RAW” (raw values).

Parameters:

signalName : str¶: Name of the master signal for synchronization
signalType : str¶: Type of the master signal for synchronization

SetMaxDeltaT(maxDeltaT)¶

Sets the bound for deltaT to the value maxDeltaT. If deltaT is found to be greater than this bound, the synchronization will fail.

Parameters:

maxDeltaT : str¶: The maximum for deltaT as expression

SetMinCorrelation(minCorrelation)¶

Sets the minimum necessary correlation coefficient for the synchronization.

Parameters:

minCorrelation : str¶: Minimum necessary correlation coefficient

SetOffset(offset)¶

Sets (known) offset. The offset will be added to the calculated deltaT. By default, it is only used for the OffsetSynchronization.

Parameters:

offset : str¶: The (known) offset as expression

SetOffsetUsed(used)¶

Parameters:

used : boolean¶: True if the offset should be used, else False.

SetRecordingSignal(signalName, signalType='PHY')¶

Sets name and type of the recording signal to be synchronized with the master signal. The type must be either “PHY” (interpreted as number, default) or “RAW” (raw values).

Parameters:

signalName : str¶: Name of the master signal for synchronization
signalType : str¶: Type of the master signal for synchronization

SetResolution(resolution)¶

Sets the resolution (step size) at which the synchronization offset is determined.

Parameters:

resolution : str¶: Resolution (step size) for the synchronization as an expression

SetTimeLimit(timeLimit)¶

Sets the time stamp relative to the first time stamp (of the recording group and master recording group) until that the running synchronization will be evaluated. If the time limit is reached, the synchronization will fail.

Parameters:

timeLimit : str¶: The relative time limit as expression