finesse.frequency.Frequency

Overview

class finesse.frequency.Frequency(name, sim, symbol, index=None, audio=False, audio_carrier_index=None, audio_order=0)

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.

Properties

Frequency.audio_carrier

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

Frequency.audio_carrier_index

The carrier frequency.

Frequency.audio_order

Audio modulation order of this frequency.

Frequency.f

Frequency.index

Index of the frequency object.

Frequency.is_audio

Is this an audio sideband frequency?

Frequency.name

Name of the frequency object.

Frequency.symbol