calc_noisy_map

NoiseGenerator.calc_noisy_map(data_map, latching_data=None, gate_data_matrix=None, *, noise_default=True, white_noise=None, pink_noise=None, coulomb_peak=None, telegraph_noise=None, latching=None, unintended_dot=None, sech_blur=None, sensor_gate=None)

Adds noise to data_map.

Parameters:

  • data_map (ndarray[float]) – The data to apply noise to.

  • latching_data (None or tuple[ndarray[float], ndarray[int], ndarray[bool]]) –

    Additional data used to add realistic latching effects. If this parameter is None, latching will be simulated by shifting each line of data_map by a random amount.

    Alternatively, a tuple (excited_data, dot_charge, are_dots_combined) can be supplied. Here dot_charge and are_dots_combined should give the charge state of the system at each pixel. excited_data should give the sensor readout (or whatever data data_map represents) for an excited state at each pixel. The excited state should be whichever the previous charge state was before the most recent transition.

  • gate_data_matrix (ndarray[float] | None) – A matrix with shape (n_gates, len(data_map.shape)) that indicates how each of the gates changes as one of the axes of data_map changes. By default, an identity matrix will be used – this assumes len(unint_dot_spacing) == len(data_map.shape) and len(sensor_gate_coupling) == len(data_map.shape).

  • noise_default (bool) – Whether to include all noise types (True) or no noise types (False) by default. Individual noise types can then be turned on or off via the parameters white_noise, pink_noise, etc.

  • white_noise (bool | None) – Whether to include white noise.

  • pink_noise (bool | None) – Whether to include pink noise.

  • coulomb_peak (bool | None) – Whether to include coulomb peak effects.

  • telegraph_noise (bool | None) – Whether to include telegraph noise.

  • latching (bool | None) – Whether to include latching effects.

  • unintended_dot (bool | None) – Whether to include unintended dot effects.

  • sech_blur (bool | None) – Whether to include sech blur effects.

  • sensor_gate (bool | None) – Whether to include sensor-gate coupling.

Returns:

data_map with various noise types added.

Return type:

ndarray[float]