MODULE REFERENCE

window

anomx.data.processing.dtw.window

DTW Windows

CRWindow

CRWindow(n: int, m: int, ranges: np.ndarray | None = None)

Bases: Window

Compressed row representation window. Stores the range of active grid cells in each column. Any window with contiguous columns can be expressed as a CRWindow. Supports efficient iterative construction and updates.

Signature parameters
Parameter	Type	Default
`n`	`int`	`required`
`m`	`int`	`required`
`ranges`	`np.ndarray \| None`	`None`

Parameters

n: The width of the window, must be equal to the length of series1
m: The height of the window, must be equal to the length of series2
ranges: The ranges of active cells within a column [[start_column0, end_column0], ...] with shape (n, 2) and where start >= 0 and end <= m.

Members

lengthattribute

# CRWindow.length Source ↗

length: int

column_rangesattribute

# CRWindow.column_ranges Source ↗

column_ranges: array.array

add_rangemethod

# CRWindow.add_range Source ↗

add_range(column: int, start: int, end: int)

Extends the active cells in the column by the range (start,end). Ranges smaller than the current one are ignored. Note (1, m+1), not (0,m) corresponds to an entire column.

Parameters

column: Column int index
start: Row element int index where start >= 1 and start <= end
end: Row element int index where end >= 1 and end <= m+1

Signature parameters
Parameter	Type	Default
`column`	`int`	`required`
`start`	`int`	`required`
`end`	`int`	`required`

addmethod

# CRWindow.add Source ↗

add(elem: tuple[int, int])

Marks a grid cell as active.

Parameters

elem: Tuple of grid cell index (column, row)

Signature parameters
Parameter	Type	Default
`elem`	`tuple[int, int]`	`required`

column_lengthmethod

# CRWindow.column_length Source ↗

column_length(column: int) -> int

Signature parameters
Parameter	Type	Default
`column`	`int`	`required`

Returns int

column_indexmethod

# CRWindow.column_index Source ↗

column_index(elem: tuple[int, int]) -> int

Signature parameters
Parameter	Type	Default
`elem`	`tuple[int, int]`	`required`

Returns int

column_lengthsmethod

# CRWindow.column_lengths Source ↗

column_lengths() -> np.ndarray

Returns np.ndarray

Inherited members

init_sizeWindow

classView source ↗

Itakura

Itakura(max_slope: float)

Bases: CRWindow

Forms the Itakura parallelogram, where max_slope determines the slope of the steeper side.

Examples

>>>                                      x
>>>                                  xxxx
>>>                   B           xxxxxx
>>>                         xxxxxxxxxxx
>>>                     xxxxxxxxxxxxxx
>>>                 xxxxxxxxxxxxxxxxx
>>>              xxxxxxxxxxxxxxxxxxxx     C
>>>            xxxxxxxxxxxxxxxxxxxxx
>>>           xxxxxxxxxxxxxxxxxxxxx
>>>          xxxxxxxxxxxxxxxxxxxxx
>>>     A   xxxxxxxxxxxxxxxxxxxxx
>>>        xxxxxxxxxxxxxxxxxxxxx
>>>       xxxxxxxxxxxxxxxxxxxxx
>>>      xxxxxxxxxxxxxxxxxxxx
>>>     xxxxxxxxxxxxxxxx       D
>>>     xxxxxxxxxxxx
>>>    xxxxxxxxx
>>>   xxxxxx
>>>  xxx
>>> x

Signature parameters
Parameter	Type	Default
`max_slope`	`float`	`required`

Parameters

max_slope: The slope of the steeper parallelogram side.

Members

init_sizemethod

# Itakura.init_size Source ↗

init_size(n: int, m: int)

Signature parameters
Parameter	Type	Default
`n`	`int`	`required`
`m`	`int`	`required`

Inherited members

add_rangeCRWindow addCRWindow column_lengthCRWindow column_indexCRWindow column_lengthsCRWindow

classView source ↗

NoWindow

NoWindow

Bases: Window

Window covers the entire grid, meaning every possible alignment between series1 and series2 is considered.

Members

column_indexmethod

# NoWindow.column_index Source ↗

column_index(elem: tuple[int, int])

Signature parameters
Parameter	Type	Default
`elem`	`tuple[int, int]`	`required`

column_lengthmethod

# NoWindow.column_length Source ↗

column_length(column: int) -> int

Signature parameters
Parameter	Type	Default
`column`	`int`	`required`

Returns int

column_lengthsmethod

# NoWindow.column_lengths Source ↗

column_lengths() -> np.ndarray

Returns np.ndarray

Inherited members

init_sizeWindow

classView source ↗

SakoeChiba

SakoeChiba(window_size: int)

Bases: CRWindow

Forms a diagonal window where window_size controls the maximum allowed shift between the two series. If both time-series have the same time axis, window_size corresponds to the maximum number of time periods

Signature parameters
Parameter	Type	Default
`window_size`	`int`	`required`

Parameters

window_size: The maximum allowed shift between the two series used in DTW.

Members

init_sizemethod

# SakoeChiba.init_size Source ↗

init_size(n: int, m: int)

Signature parameters
Parameter	Type	Default
`n`	`int`	`required`
`m`	`int`	`required`

Inherited members

add_rangeCRWindow addCRWindow column_lengthCRWindow column_indexCRWindow column_lengthsCRWindow

classView source ↗

Window

Window

Bases: ABC

Members

nattribute

# Window.n Source ↗

n: int

mattribute

# Window.m Source ↗

m: int

init_sizemethod

# Window.init_size Source ↗

init_size(n: int, m: int)

Called by dtw to initialize the window to a certain size.

Parameters

n: The width of the window, must be equal to the length of series1 used for DTW
m: The height of the window, must be equal to the length of series2 used for DTW

Signature parameters
Parameter	Type	Default
`n`	`int`	`required`
`m`	`int`	`required`

column_indexmethod

# Window.column_index Source ↗

column_index(elem: tuple[int, int]) -> int

Gives the number of active grid cells before row element j, in column i.

Parameters

elem: (i,j) index, where i indexes columns and j rows

Returns

int: The number of active grid cells before row element j, in column i, If (i,j) is not an active grid cell returns -1

Signature parameters
Parameter	Type	Default
`elem`	`tuple[int, int]`	`required`

Returns int

column_lengthmethod

# Window.column_length Source ↗

column_length(column: int) -> int

Gives the number of active grid cells in a column.

Parameters

column: A column in the window, must be within 0 < column < n+1

Returns

int: The number of active grid cells in a column.

Signature parameters
Parameter	Type	Default
`column`	`int`	`required`

Returns int

column_lengthsmethod

# Window.column_lengths Source ↗

column_lengths() -> np.ndarray

Gives the number of activate grid cells in each column.

Returns

np.ndarray of shape (n+1,): The number of active grid cells in each column.

Returns np.ndarray

functionView source ↗

gtz

gtz(value)

Signature parameters
Parameter	Type	Default
`value`	`—`	`required`