misc
hktkzyx_toolbox.misc
¶
hktkzyx_toolbox.misc.si_formatter(value: Union[float, int], significant_figures = 4, unit: str = None)
¶
Return value with SI prefix.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value |
Union[float, int] |
Value. |
required |
significant_figures |
int |
Significant figures of output, by default 4 |
4 |
unit |
str |
Unit of the value, by default None |
None |
Examples:
'2.100 kHz'
Returns:
| Type | Description |
|---|---|
str |
hktkzyx_toolbox.misc.si_prefix_selector(value: Union[float, int]) -> Tuple[Union[float, int], Union[str, NoneType], Union[str]]
¶
Return scaled value, SI symbol, and prefix.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value |
Union[float, int] |
Value. |
required |
Examples:
(2.1, None, None)
Returns:
| Type | Description |
|---|---|
Tuple[Union[float, int], Union[str, NoneType], Union[str]] |
Scaled value. |