c3.signal.pulse

Module Contents

c3.signal.pulse.comp_reg_deco(func)[source]

Decorator for making registry of functions

class c3.signal.pulse.Envelope(name: str, desc: str = ' ', comment: str = ' ', params: Dict[str, c3.c3objs.Quantity] = {}, shape: Union[Callable, str] = None, use_t_before=False)[source]

Bases: c3.c3objs.C3obj

Inheritance diagram of c3.signal.pulse.Envelope

Represents the envelopes shaping a pulse.

Parameters

shape (Callable) – function evaluating the shape in time

write_config(self, filepath: str) None[source]

Write dictionary to a HJSON file.

__str__(self) str[source]

Return str(self).

__repr__(self) str[source]

Return repr(self).

compute_mask(self, ts, t_end) tensorflow.Tensor[source]

Compute a mask to cut out a signal after t_final.

Parameters

ts (tf.Tensor) – Vector of time steps.

Returns

[description]

Return type

tf.Tensor

class c3.signal.pulse.EnvelopeDrag(name: str, desc: str = ' ', comment: str = ' ', params: dict = {}, shape: types.FunctionType = None, use_t_before=False)[source]

Bases: Envelope

Inheritance diagram of c3.signal.pulse.EnvelopeDrag

Represents the envelopes shaping a pulse.

Parameters

shape (Callable) – function evaluating the shape in time

write_config(self, filepath: str) None

Write dictionary to a HJSON file.

__str__(self) str

Return str(self).

__repr__(self) str

Return repr(self).

compute_mask(self, ts, t_end) tensorflow.Tensor

Compute a mask to cut out a signal after t_final.

Parameters

ts (tf.Tensor) – Vector of time steps.

Returns

[description]

Return type

tf.Tensor

class c3.signal.pulse.EnvelopeNetZero(name: str, desc: str = ' ', comment: str = ' ', params: dict = {}, shape: types.FunctionType = None, use_t_before=False)[source]

Bases: Envelope

Inheritance diagram of c3.signal.pulse.EnvelopeNetZero

Represents the envelopes shaping a pulse.

Parameters
  • shape (function) – function evaluating the shape in time

  • params (dict) – Parameters of the envelope Note: t_final

get_shape_values(self, ts)[source]

Return the value of the shape function at the specified times.

Parameters
  • ts (tf.Tensor) – Vector of time samples.

  • t_before (tf.float64) – Offset the beginning of the shape by this time.

write_config(self, filepath: str) None

Write dictionary to a HJSON file.

__str__(self) str

Return str(self).

__repr__(self) str

Return repr(self).

compute_mask(self, ts, t_end) tensorflow.Tensor

Compute a mask to cut out a signal after t_final.

Parameters

ts (tf.Tensor) – Vector of time steps.

Returns

[description]

Return type

tf.Tensor

class c3.signal.pulse.Carrier(name: str, desc: str = ' ', comment: str = ' ', params: dict = {})[source]

Bases: c3.c3objs.C3obj

Inheritance diagram of c3.signal.pulse.Carrier

Represents the carrier of a pulse.

write_config(self, filepath: str) None[source]

Write dictionary to a HJSON file.

__repr__(self) str[source]

Return repr(self).

__str__(self) str

Return str(self).