Skip to content

Base Frequency class

timecave.data_generation.frequency_modulation.BaseFrequency()

Base class for frequency modulation.

This class provides a base for implementing frequency modulation techniques.

Methods:

Name Description
modulate

Adjusts the frequency based on the given time.
Source code in timecave/data_generation/frequency_modulation.py 
46
47
def __init__(self) -> None:
    pass

modulate(time) abstractmethod

Adjusts the frequency based on the given time.

This method should be implemented by subclasses to perform frequency modulation.

Parameters:

Name Type Description Default
time int

Number of timesteps for which modulation is meant to be performed.

 required

Returns:

Type Description
array

Each entry of the array corresponds to the frequency at the given timestep.

Raises:

Type Description
NotImplementedError

This method must be implemented by subclasses.
Source code in timecave/data_generation/frequency_modulation.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
@abstractmethod
def modulate(self, time: int) -> np.array:
    """
    Adjusts the frequency based on the given time.

    This method should be implemented by subclasses to perform frequency modulation.

    Parameters
    ----------
    time : int
        Number of timesteps for which modulation is meant to be performed.

    Returns
    -------
    np.array
        Each entry of the array corresponds to the frequency at the given timestep.

    Raises
    ------
    NotImplementedError
        This method must be implemented by subclasses.
    """
    raise NotImplementedError("Subclasses must implement modulate method!")