paraqeet.signal.waveform.LocalOscillator#

class paraqeet.signal.waveform.LocalOscillator(frequency=None)[source]#

Bases: Waveform

A local oscillators carrier signal.

_lo_freqQuantity

The frequency of the carrier signal.

Parameters:

frequency (Quantity | None)

__init__(frequency=None)[source]#
Parameters:

frequency (Quantity | None)

Return type:

None

Methods

__init__([frequency])

get_parameters()

Return device parameters.

get_time_and_parameter_gradient(times)

Compute the double derivative with respect to parameter and time.

get_time_gradient(times)

Compute a signals time derivative.

get_value(times)

Evaluate a carrier signal from an input time vector.

get_value_and_gradient(times)

Return the gradient wrt to frequency of carrier signal.

set_all_optimizable_parameters(all_params)

Set all optimizable parameters in the optimization.

set_optimizable_parameters(params)

Set optimizable parameters for optimization.

Attributes

all_optimizable_parameters

Get the optimizable parameters

frequency

Get The frequency of the constant oscillating tone.

name

Get the name of the parameter.

optimizable_parameters

Get the optimizable parameters

property all_optimizable_parameters: list[Quantity]#

Get the optimizable parameters

Returns:

The list of all the optimizable parameters considered in the optimization

Return type:

list[Quantity]

property frequency: Quantity#

Get The frequency of the constant oscillating tone.

Returns:

The frequency of the tone.

Return type:

Quantity

get_parameters()[source]#

Return device parameters.

Returns:

Returns the carrier signal frequency.

Return type:

list[Quantity]

get_time_and_parameter_gradient(times)[source]#

Compute the double derivative with respect to parameter and time.

This function computes $\frac{\partial^2 \Omega}{\partial t \partial alpha}$ for a pulse $\Omega(t)$ and parameter $\alpha$.

Parameters:

times (Array) – One-dimensional vector of timestamps.

Returns:

Returns a vector signals time derivative.

Return type:

Array

get_time_gradient(times)[source]#

Compute a signals time derivative.

Parameters:

times (Array) – One-dimensional vector of timestamps.

Returns:

Returns a vector signals time derivative.

Return type:

Array or JitWrapped

get_value(times)[source]#

Evaluate a carrier signal from an input time vector.

Parameters:

times (Array) – One-dimensional vector of timestamps.

Returns:

Returns a vector carrier signal.

Return type:

Array

get_value_and_gradient(times)[source]#

Return the gradient wrt to frequency of carrier signal.

Parameters:

times (Array) – Array of time points to evaluate gradients at.

Returns:

Gradient of tone wrt to frequency.

Return type:

Array

property name: str | None#

Get the name of the parameter.

Returns:

Name of the parameter.

Return type:

str | None

property optimizable_parameters: list[Quantity]#

Get the optimizable parameters

Returns:

The list of optimizable parameters associated with the object.

Return type:

list[Quantity]

set_all_optimizable_parameters(all_params)[source]#

Set all optimizable parameters in the optimization.

Parameters:
  • params (List[Quantity]) – List of optimizable parameters to be set.

  • all_params (list[Quantity])

Return type:

None

set_optimizable_parameters(params)[source]#

Set optimizable parameters for optimization.

Parameters:

params (list[Quantity]) – Input list of parameters to be set.

Return type:

None