finesse.frequency module

Frequency analysis tools.

class finesse.frequency.Frequency(name, symbol, index=None, *, audio=False, audio_carrier_index=None, audio_carrier_object=None, audio_order=0)[source]

Bases: object

Represents a frequency “bin” with a specific index.

The value of the frequency is calculated from the name of the frequency.

Parameters

namestr: Name of the frequency.
orderint, optional: The order of the frequency, defaults to zero.

audio_carrier[source]

Frequency object for the carrier frequency of this sideband, if it is a sideband.

Getter:: Returns the index of the frequency (read-only).

audio_carrier_index[source]

The carrier frequency.

Getter:: Returns the carrier frequency index (read-only).

audio_order[source]

Audio modulation order of this frequency.

Getter:: Returns the order of the frequency (read-only).

f[source]

index[source]

Index of the frequency object.

Getter:: Returns the index of the frequency (read-only).

is_audio[source]: Is this an audio sideband frequency?

name[source]

Name of the frequency object.

Getter:: Returns the name of the frequency (read-only).

symbol[source]

class finesse.frequency.FrequencyContainer(frequencies, FrequencyContainer carrier_cnt=None)[source]

Bases: object

Contains an array of frequency objects and their associated faster access C struct information.

frequencies

get_frequency_index(self, value)[source]

For a given value (either float or symbolic) return the index of the frequency with the same value.

Parameters

value[number | symbolic]: Frequency value to test for

Returns

indexint: Index for this frequency container

get_info(self, Py_ssize_t index)[source]

size

class finesse.frequency.Fsig(*args, **kwargs)[source]

Bases: ModelElement

This element represents the signal frequency (fsig) used in a model. It is a unique element, which means only one can be added to any given model. This is done automatically with the name fsig. It has a single parameter f for the frequency of the signal.

The signal frequency must be set by the user to enable transfer functions and noise projections to be simulated.

Parameters

namestr: Name of this element
f[float|None]: Signal frequency to use in a model [Hz]. If set to None then no signal frequencies will be modelled in the simulation.

property f[source]: f : [float|None] Signal frequency to use in a model [Hz]. If set to None then no signal frequencies will be modelled in the simulation.

finesse.frequency.generate_frequency_list(model)[source]

For a given model a symbolic list of frequencies is generated. The result can be used to generate a set of frequencies bins to be modelled in a simulation.

This method relies on using Symbol. Using symbolic statements this method attempts to isolate uniqe frequency bins whilst leaving those changing during a simulation present.

Returns

List of Symbol