popsynth.selection_probability.selection_probability module

class popsynth.selection_probability.selection_probability.DummySelection

Bases: popsynth.selection_probability.selection_probability.SelectionProbability

__init__()

A Dummy selection for testing.

draw(size=1)

class popsynth.selection_probability.selection_probability.SelectionParameter(default: Optional[float] = None, vmin: Optional[float] = None, vmax: Optional[float] = None, free: bool = True)

Bases: popsynth.utils.meta.Parameter

class popsynth.selection_probability.selection_probability.SelectionProbability(name: str = 'name', use_obs_value: bool = False, use_distance: bool = False, use_luminosity: bool = False, use_flux: bool = False)

Bases: object

__init__(name: str = 'name', use_obs_value: bool = False, use_distance: bool = False, use_luminosity: bool = False, use_flux: bool = False) → None

Base class for selections on a population.

Parameters:

• name (str) – Name of the selection
• use_obs_value (bool) – If True, make selection on observed_value. False by default.
• use_distance (bool) – If True make selection on distance. False by default.
• use_luminosity (bool) – If True make selection on luminosity. False by default.
• use_flux (bool) – If True make selection on flux. False by default.

classmethod draw(size: int) → None

n_non_selected

n_objects

n_selected

name

non_selection_index

parameters

reset()

Reset the selector.

select(size: int)

selection

selection_index

set_distance(distance: numpy.ndarray) → None

Set the distance of the selection.

set_luminosity(luminosity: numpy.ndarray) → None

Set the luminosity of the selection.

set_observed_flux(observed_flux: numpy.ndarray) → None

Set the observed flux of the selection.

set_observed_value(observed_value: numpy.ndarray) → None

Set the observed value of the selection.