sbm.SignalFields.get_coupled_field#

SignalFields.get_coupled_field(scan_field, spin_n_out: float, spin_m_out: float, output_all=False)[source]#

Multiply the scan fields and signal fields to get the detected fields by given cross-linking

Parameters:

  • scan_field (ScanFields) – scan fields instance

  • spin_n_out (float) – spin_n of the output field

  • spin_m_out (float) – spin_m of the output field

Returns:

detected fields by the given cross-linking

Return type:

results (np.ndarray)