sarkas.tools.observables.VelocityAutoCorrelationFunction.select_random_indices
sarkas.tools.observables.VelocityAutoCorrelationFunction.select_random_indices#
- VelocityAutoCorrelationFunction.select_random_indices(no_ptcls_per_species=None)[source]#
Randomly select a given number of indices that indicate the particles to be used to average the VACF. The random number of indices is stored in
particles_id.- Parameters
no_ptcls_per_species (list, int, optional) – List containing the number of particles to randomly select for each species. If None it uses
no_ptcls_per_speciesattribute which is equal to [10] by default.- Raises
_ – ValueError: If the chosen no_ptcls_per_species is less than the total number of particles in
species_num.
Notes
If the length of
no_ptcls_per_speciesis less than the length ofspecies_num, it selects the minimum ofno_ptcls_per_speciesto be used for all species.