ParallaxSurvey#
- class agabpylib.simulation.parallaxsurveys.ParallaxSurvey(numberOfStars, minDistance, maxDistance, surveyLimit=inf)#
Bases:
objectBase class for simulating a parallax survey. The survey is assumed to have been conducted for a set of stars distributed in space between some minimum aand maximum distance value, according to some spatial distribution to be defined by the sub-classes. Likewise the distribution in apparent magnitudes is assumed to be specified by the sub-classes.
- numberOfStars#
Number of stars to simulate
- Type:
int
- numberOfStarsInSurvey#
Number of stars that ends up in the survey after taking the magnitude limit into account.
- Type:
int
- minDistance#
Minumum distance of the simulated stars (pc)
- Type:
float
- maxDistance#
Maximum distance of the simulated stars (pc)
- Type:
float
- minParallax#
Minimum parallax of the simulated star (mas, 1000/maxDistance)
- Type:
float
- maxParallax#
Maximum parallax of the simulated star (mas, 1000/minDistance)
- Type:
float
- apparentMagnitudeLimit#
Apparent magnitude limit of the survey
- Type:
float
- seed#
Random number seed
- Type:
int
- rng#
Random number generator.
- Type:
numpy.random.Generator
Methods Summary
Get the random number seed that was used for the Monte Carlo simulations.
setRandomNumberSeed(seed)(Re-)Set the random number seed for the simulations.
Methods Documentation
- getRandomNumberSeed()#
Get the random number seed that was used for the Monte Carlo simulations.
- Returns:
seed – The random number seed used. None means the seed was set automatically.
- Return type:
int
- setRandomNumberSeed(seed)#
(Re-)Set the random number seed for the simulations.
- Parameters:
seed (seed - Value of random number) –