BGlib.be.translators.df_utils.be_utils.requires_conjugate

BGlib.be.translators.df_utils.be_utils.requires_conjugate(chosen_spectra, default_q=10, cores=None)[source]

Determines whether or not the conjugate of the data needs to be taken based on the quality factor

Parameters:
  • chosen_spectra (2D complex numpy array) – N random spectra arranged as [instance, frequency]

  • default_q (unsigned int, Optional) – Default value of Q factor that the SHO guess function results in for poor guesses

  • cores (uint, Optional) – Number of CPU cores to use for the SHO guess. Default = None - ask pyUSID.processing.comp_utils.recommend_cpu_cores for automatic assignment

Returns:

do_conjugate – Whether or not to take the conjugate of the data

Return type:

Boolean