Skip to content

Commit 20d3da9

Browse files
committed
Add constant PacketNodeOrder
1 parent 23cd021 commit 20d3da9

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

src/ptwt/constants.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,14 @@
5151
Choose ``gramschmidt`` if ``qr`` runs out of memory.
5252
"""
5353

54+
PacketNodeOrder = Literal["freq", "natural"]
55+
"""
56+
This is a type literal for the order of wavelet packet tree nodes.
57+
58+
- frequency order (``freq``)
59+
- natural order (``natural``)
60+
"""
61+
5462

5563
class WaveletDetailTuple2d(NamedTuple):
5664
"""Detail coefficients of a 2d wavelet transform for a given level.

src/ptwt/packets.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
from .constants import (
1717
ExtendedBoundaryMode,
1818
OrthogonalizeMethod,
19+
PacketNodeOrder,
1920
WaveletCoeff2d,
2021
WaveletCoeffNd,
2122
WaveletDetailTuple2d,
@@ -205,7 +206,7 @@ def _get_waverec(
205206
return partial(waverec, wavelet=self.wavelet, axis=self.axis)
206207

207208
@staticmethod
208-
def get_level(level: int, order: Literal["freq", "natural"] = "freq") -> list[str]:
209+
def get_level(level: int, order: PacketNodeOrder = "freq") -> list[str]:
209210
"""Return the paths to the filter tree nodes.
210211
211212
Args:
@@ -540,7 +541,7 @@ def get_level(level: int, order: Literal["natural"]) -> list[str]: ...
540541

541542
@staticmethod
542543
def get_level(
543-
level: int, order: Literal["freq", "natural"] = "freq"
544+
level: int, order: PacketNodeOrder = "freq"
544545
) -> Union[list[str], list[list[str]]]:
545546
"""Return the paths to the filter tree nodes.
546547

0 commit comments

Comments
 (0)