Frequency and Time

class torii.hdl.time.Frequency(value: float) → None

Represents a frequency in whole or fractional Hertz.

Parameters:

value (float) – The frequency in Hertz.

Attributes:

  • period (torii.hdl.time.Period) – Converts this frequency into a Torii Period.

  • gigahertz (float) – Returns this frequency in Gigahertz as a float literal.

  • megahertz (float) – Returns this frequency in Megahertz as a float literal.

  • kilohertz (float) – Returns this frequency in Kilohertz as a float literal.

  • hertz (float) – Returns this frequency in Hertz as a float literal.

property period: Period

Convert this Frequency into a Period

property gigahertz: float

This frequency in Gigahertz (10^9 Hertz)

property megahertz: float

This frequency in Megahertz (10^6 Hertz)

property kilohertz: float

This frequency in Kilohertz (10^3 Hertz)

property hertz: float

This frequency in Hertz

torii.hdl.time.GHz: Final = <torii.hdl.time._UnitHelper object>

Unit constant for Gigahertz (10^9 Hertz).

See the documentation for Frequency for more information on frequency units.

Example

>>> 1 * GHz
<Frequency: 1GHz>
>>> GHz(5)
<Frequency: 5GHz>
torii.hdl.time.MHz: Final = <torii.hdl.time._UnitHelper object>

Unit constant for Megahertz (10^6 Hertz).

See the documentation for Frequency for more information on frequency units.

Example

>>> 1 * MHz
<Frequency: 1MHz>
>>> MHz(5)
<Frequency: 5MHz>
torii.hdl.time.kHz: Final = <torii.hdl.time._UnitHelper object>

Unit constant for Kilohertz (10^3 Hertz).

See the documentation for Frequency for more information on frequency units.

Example

>>> 1 * kHz
<Frequency: 1kHz>
>>> kHz(5)
<Frequency: 5kHz>
torii.hdl.time.Hz: Final = <torii.hdl.time._UnitHelper object>

Unit constant for Hertz.

See the documentation for Frequency for more information on frequency units.

Example

>>> 1 * Hz
<Frequency: 1Hz>
>>> Hz(5)
<Frequency: 5Hz>
class torii.hdl.time.Period(value: float) → None

Represents a period in whole or fractional Seconds.

Parameters:

value (float) – The period in Seconds.

Attributes:

  • frequency (torii.hdl.time.Frequency) – Converts this period into a Torii Frequency.

  • seconds (float) – Returns this period in Seconds as a float literal.

  • milliseconds (float) – Returns this period in Milliseconds as a float literal.

  • microseconds (float) – Returns this period in Microseconds as a float literal.

  • nanoseconds (float) – Returns this period in Nanoseconds as a float literal.

  • picoseconds (float) – Returns this period in Picoseconds as a float literal.

property frequency: Frequency

Convert this Period into a Frequency

property seconds: float

This period in Seconds

property milliseconds: float

This period in Milliseconds (10^-3 Seconds)

property microseconds: float

This period in Microseconds (10^-6 Seconds)

property nanoseconds: float

This period in Nanoseconds (10^-9 Seconds)

property picoseconds: float

This period in Picoseconds (10^-12 Seconds)

torii.hdl.time.s: Final = <torii.hdl.time._UnitHelper object>

Unit constant for Seconds (10^0 Seconds).

See the documentation for Period for more information on period units.

Example

>>> 1 * s
<Period: 1s>
>>> s(5)
<Period: 5s>
torii.hdl.time.ms: Final = <torii.hdl.time._UnitHelper object>

Unit constant for Milliseconds (10^-3 Seconds).

See the documentation for Period for more information on period units.

Example

>>> 1 * ms
<Period: 1ms>
>>> ms(5)
<Period: 5ms>
torii.hdl.time.us: Final = <torii.hdl.time._UnitHelper object>

Unit constant for Microseconds (10^-6 Seconds).

See the documentation for Period for more information on period units.

Example

>>> 1 * us
<Period: 1us>
>>> us(5)
<Period: 5us>
torii.hdl.time.ns: Final = <torii.hdl.time._UnitHelper object>

Unit constant for Nanoseconds (10^-9 Seconds).

See the documentation for Period for more information on period units.

Example

>>> 1 * ns
<Period: 1ns>
>>> ns(5)
<Period: 5ns>