Skip to content

← utilities package

GetTimeShifts

Retrieve the time shifts between a chunk's time axis and another set of timestamps.

Version 0.1.1

Ports/Properties

data

Data to process.

verbose name
Data
default value
None
port type
DataPort
value type
Packet (can be None)
data direction
IN

offset

TimeShift offset

verbose name
Offset
default value
None
port type
DataPort
value type
float (can be None)
data direction
OUT

scale

Timeshift scale

verbose name
Scale
default value
None
port type
DataPort
value type
float (can be None)
data direction
OUT

timestamp_pairs

Pairs of timestamps used to calculate piecewise interpolation. Used by ShiftTimestamps node. Returns a nested array of floats: [[other, this], [other, this], ...].

verbose name
Timestamp Pairs
default value
None
port type
ListPort
value type
list (can be None)

other_source

The source of timestamps from the 'other' clock that will be compared to the timestamps in the time axis. Set this to 'data' to use the values in the data tensor (chunk.block.data). Any other string will be assumed to be the name of an instance axis field containing the timestamps.

verbose name
Other Source
default value
data
port type
StringPort
value type
str (can be None)

allow_scaling

If the other timestamp source was in different units (i.e . not in seconds) then set this to True to allow the scale-factor to be != 1.

verbose name
Allow Scaling
default value
False
port type
BoolPort
value type
bool (can be None)

return_inverse

When False (default), this node returns the offset (and scale factor) to transform a time vector from the clock used for the timestamps defined in other_source to the clock used for the time axis timestamps. If set to True, then the offset (and scale factor) will transform the time vector from the time axis clock, into the other_source clock.

verbose name
Return Inverse
default value
False
port type
BoolPort
value type
bool (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

verbose name
Set Breakpoint (Debug Only)
default value
False
port type
BoolPort
value type
bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

verbose name
Metadata
default value
{}
port type
DictPort
value type
dict (can be None)