paraqeet.signal.envelopes.FlatTopGaussianEnvelope#

class paraqeet.signal.envelopes.FlatTopGaussianEnvelope(amplitude=None, t_up=None, t_down=None, ramp_time=None, t_final=None)[source]#

Bases: Envelope

A flat-top Gaussian envelope.

_amplitude: Quantity: The amplitude of the envelope.
_t_up: Quantity: The start time of constant section of the envelope.
_t_down: Quantity: The end time of constant section of the envelope.
_ramp_time: Quantity: The rate of ramp up and ramp down of the envelope.
_t_final: Quantity: The length in time of the envelope. Used only if any of t_up, t_down, and ramp_time are none.
_gradient_function: Callable | None: The function to calculate the gradient with respect to a set of previously defined parameters.
_grad_arg_nums: tuple[int, …]: The identifying indices of which parameters to calculate the gradient with respect to.

Parameters:

amplitude (Quantity | None)
t_up (Quantity | None)
t_down (Quantity | None)
ramp_time (Quantity | None)
t_final (Quantity | None)

__init__(amplitude=None, t_up=None, t_down=None, ramp_time=None, t_final=None)[source]#

Parameters:

amplitude (Quantity | None)
t_up (Quantity | None)
t_down (Quantity | None)
ramp_time (Quantity | None)
t_final (Quantity | None)

Methods

`__init__`([amplitude, t_up, t_down, ...])
`get_parameters`()	Get all parameters of the system.
`get_time_and_parameter_gradient`(times)	Compute the double derivative with respect to parameter and time.
`get_time_gradient`(times)	Compute a signal envelopes time derivative.
`get_value`(times)	Get the output of the device on time stamps.
`get_value_and_gradient`(times)	Return the gradient wrt dimensionless parameters.
`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
`amplitude`	Get the amplitude of the system.
`name`	Get the name of the parameter.
`optimizable_parameters`	Get the optimizable parameters
`t_final`	Get the length of the tone.

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 amplitude: Quantity#

Get the amplitude of the system.

Returns:: Amplitude of the system.
Return type:: Quantity

get_parameters()[source]#: Get all parameters of the system.

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 signal envelopes time derivative.

Parameters:: times (Array) – One-dimensional vector of timestamps.
Returns:: Returns a vector signals time derivative.
Return type:: Array

get_value(times)[source]#

Get the output of the device on time stamps.

Parameters:: times (Array) – One-dimensional vector of timestamps.
Returns:: Returns the output of the device.
Return type:: Array

get_value_and_gradient(times)[source]#

Return the gradient wrt dimensionless parameters.

Parameters:: times (Array) – One-dimensional vector of timestamps.
Returns:: Returns the gradient wrt dimensionless parameters.
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

property t_final: Quantity#

Get the length of the tone.

Returns:: Length in time of the tone.
Return type:: Quantity