Time

class auglib.Time(value, unit)[source]

Represent timestamp or timespan.

Different time formats are supported, but calling the object always returns the value expressed as number of samples.

Parameters:
Raises:

ValueError – if unit is not supported

Examples

>>> Time(0.5, "seconds")(sampling_rate=8)
4
>>> Time(1000, "ms")(sampling_rate=8)
8
>>> Time(16, "samples")()
16
>>> Time(0.5, "relative")(length=64)
32
>>> # generate randomized values
>>> import auglib
>>> auglib.seed(0)
>>> t = Time(observe.FloatUni(0.25, 0.75), "relative")
>>> t(length=64)
33
>>> t(length=64)
38

__call__()

Time.__call__(*, sampling_rate=None, length=None, allow_negative=False)[source]

Convert timestamp or timespan to number of samples.

If unit is set to 'samples', no argument must be given. In case of 'relative', a value for length has to be provided. In any other case, a value for sampling_rate is required.

Parameters:

  • sampling_rate (int) – sampling rate in Hz

  • length (int) – reference point if unit is relative (in number of samples)

  • allow_negative (bool) – allow negative values

Return type:

int

Returns:

number of samples

Raises:

  • ValueError – if allow_negative is False and computed value is negative

  • ValueError – if length is not provided, but unit is 'samples'

  • ValueError – if sampling_rate is not provided, but unit is not 'samples' or 'relative'

  • ValueError – if sampling_rate is not an integer or not greater than zero

arguments

Time.arguments

Returns arguments that are serialized.

Returns:

Dictionary of arguments and their values.

Raises:

RuntimeError – if arguments are found that are not assigned to attributes of the same name

Examples

>>> import audobject.testing
>>> o = audobject.testing.TestObject("test", point=(1, 1))
>>> o.arguments
{'name': 'test', 'point': (1, 1)}

borrowed_arguments

Time.borrowed_arguments

Returns borrowed arguments.

Returns:

Dictionary with borrowed arguments.

from_dict()

static Time.from_dict(d, root=None, **kwargs)
Return type:

audobject.core.object.Object

from_yaml()

static Time.from_yaml(path_or_stream, **kwargs)
Return type:

audobject.core.object.Object

from_yaml_s()

static Time.from_yaml_s(yaml_string, **kwargs)
Return type:

audobject.core.object.Object

hidden_arguments

Time.hidden_arguments

Returns hidden arguments.

Returns:

List with names of hidden arguments.

id

Time.id

Object identifier.

The ID of an object ID is created from its non-hidden arguments.

Returns:

object identifier

Examples

>>> class Foo(Object):
...     def __init__(self, bar: str):
...         self.bar = bar
>>> foo1 = Foo("I am unique!")
>>> foo1.id
'893df240-babe-d796-cdf1-c436171b7a96'
>>> foo2 = Foo("I am different!")
>>> foo2.id
'9303f2a5-bfc9-e5ff-0ffa-a9846e2d2190'
>>> foo3 = Foo("I am unique!")
>>> foo1.id == foo3.id
True

is_loaded_from_dict

Time.is_loaded_from_dict

Check if object was loaded from a dictionary.

Returns True if object was initialized from a dictionary, e.g. after loading it from a YAML file.

Returns:

True if object was loaded from a dictionary,

otherwise False

resolvers

Time.resolvers

Return resolvers.

Returns:

Dictionary with resolvers.

short_id

Time.short_id

Short object identifier.

The short ID consists of eight characters and is created from its non-hidden arguments.

Returns:

short object identifier

Examples

>>> class Foo(Object):
...     def __init__(self, bar: str):
...         self.bar = bar
>>> foo1 = Foo("I am unique!")
>>> foo1.id
'893df240-babe-d796-cdf1-c436171b7a96'
>>> foo1.short_id
'171b7a96'
>>> foo2 = Foo("I am different!")
>>> foo2.short_id
'6e2d2190'
>>> foo3 = Foo("I am unique!")
>>> foo1.short_id == foo3.short_id
True

to_dict()

Time.to_dict(*, include_version=True, flatten=False, root=None)

Converts object to a dictionary.

Includes items from audobject.Object.arguments. If an argument has a resolver, its value is encoded. Usually, the object can be re-instantiated using audobject.Object.from_dict(). However, if flatten=True, this is not possible.

Parameters:

  • include_version (bool) – add version to class name

  • flatten (bool) – flatten the dictionary

  • root (str) – if file is written to disk, set to target directory

Return type:

collections.abc.Mapping[str, typing.Union[bool, datetime.datetime, dict, float, int, list, None, str]]

Returns:

dictionary that represent the object

Examples

>>> import audobject.testing
>>> o = audobject.testing.TestObject("test", point=(1, 1))
>>> o.to_dict(include_version=False)
{'$audobject.core.testing.TestObject': {'name': 'test', 'point': [1, 1]}}
>>> o.to_dict(flatten=True)
{'name': 'test', 'point.0': 1, 'point.1': 1}

to_yaml()

Time.to_yaml(path_or_stream, *, include_version=True)

Save object to YAML file.

Parameters:

  • path_or_stream (str | io.IOBase) – file path or stream

  • include_version (bool) – add version to class name

to_yaml_s()

Time.to_yaml_s(*, include_version=True)

Convert object to YAML string.

Parameters:

include_version (bool) – add version to class name

Return type:

str

Returns:

YAML string

Examples

>>> import audobject.testing
>>> o = audobject.testing.TestObject("test", point=(1, 1))
>>> print(o.to_yaml_s(include_version=False))
$audobject.core.testing.TestObject:
  name: test
  point:
  - 1
  - 1