sensor_gate

NoiseGenerator.sensor_gate(data_map, sensor_gate_coupling, magnitude=1, gate_data_matrix=None)

Add a gradient due to sensor-gate coupling to data_map.

Parameters:

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

  • sensor_gate_coupling (ndarray[float]) – A vector with length equal to the number of gates, giving the value of the sensor-gate coupling per pixel for each gate.

  • magnitude (float | ndarray[float]) – The total sensor-gate coupling will be multiplied by magnitude. Usually, this value should be set to 1, and the magnitude encoded in sensor_gate_coupling. If an array is passed, it should have the same shape as data_map.

  • 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(sensor_gate_coupling) == len(data_map.shape).

Returns:

data_map with sensor-gate coupling effects added.

Return type:

ndarray[float]