popsynth.selection_probability package

Submodules

• popsynth.selection_probability.flux_selectors module
• popsynth.selection_probability.generic_selectors module
• popsynth.selection_probability.selection_probability module
• popsynth.selection_probability.spatial_selection module

Module contents

class popsynth.selection_probability.HardFluxSelection

Bases: popsynth.selection_probability.generic_selectors.LowerBound

__init__() → None

A hard selection on the observed flux.

Based on LowerBound.

draw(size: int)

class popsynth.selection_probability.SoftFluxSelection

Bases: popsynth.selection_probability.generic_selectors.SoftSelection

__init__() → None

A soft selection on the observed flux.

Based on SoftSelection.

draw(size: int)

class popsynth.selection_probability.BernoulliSelection

Bases: popsynth.selection_probability.selection_probability.SelectionProbability

__init__() → None

A Bernoulli selection with probability as a parameter.

Parameters:probability (SelectionParameter) – Probability for each Bernoulli trial

draw(size: int) → None

probability

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

Bases: popsynth.selection_probability.selection_probability.SelectionProbability

__init__(name: str = 'Hard selection', use_obs_value: bool = False, use_distance: bool = False, use_luminosity: bool = False, use_flux: bool = False)

A hard, lower bound selection on obs_value, distance, luminosity or flux.

Selects values >= boundary.

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.
• boundary (SelectionParameter) – Value of the selection boundary

boundary

draw(size: int) → None

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

Bases: popsynth.selection_probability.selection_probability.SelectionProbability

__init__(name: str = 'Hard selection', use_obs_value: bool = False, use_distance: bool = False, use_luminosity: bool = False, use_flux: bool = False)

A hard, upper bound selection on obs_value, distance, luminosity or flux.

Selects values <= boundary.

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.
• boundary (SelectionParameter) – Value of the selection boundary

boundary

draw(size: int) → None

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

Bases: popsynth.selection_probability.selection_probability.SelectionProbability

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

A soft selection using an inverse logit function either on the log or linear value of the observed_value, distance, luminosity or flux.

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.
• boundary (SelectionParameter) – Center of the inverse logit
• strength (SelectionParameter) – Width of the logit

boundary

draw(size: int, use_log=True) → None

strength

class popsynth.selection_probability.UnitySelection(name='unity')

Bases: popsynth.selection_probability.selection_probability.SelectionProbability

__init__(name='unity')

A selection that returns all selected.

Parameters:name – Name of the selection

draw(size: int) → None

class popsynth.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.

class popsynth.selection_probability.SpatialSelection(name: str)

Bases: popsynth.selection_probability.selection_probability.SelectionProbability

__init__(name: str) → None

A generic spatial selection.

Parameters:name (str) – Name of the selection

set_spatial_distribution(spatial_distribtuion: popsynth.distribution.SpatialDistribution) → None

Set the spatial distribution for the selection.

Parameters:spatial_distribution (SpatialDistribution) – The spatial_distribution

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

Bases: popsynth.selection_probability.selection_probability.SelectionProbability

__init__(name: str = 'box selection', use_obs_value: bool = False, use_distance: bool = False, use_luminosity: bool = False, use_flux: bool = False)

A box selection on observed_value, distance, luminosity or flux.

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.
• vmin (SelectionParameter) – Minimum value of selection
• vmax (SelectionParameter) – Maximum value of selection

draw(size: int) → numpy.ndarray

vmax

vmin

class popsynth.selection_probability.DummySelection

Bases: popsynth.selection_probability.selection_probability.SelectionProbability

__init__()

A Dummy selection for testing.

draw(size=1)

class popsynth.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.GalacticPlaneSelection(name: str = 'galactic plane selector')

Bases: popsynth.selection_probability.spatial_selection.SpatialSelection

__init__(name: str = 'galactic plane selector')

A selection that excludes objects near the galactic plane.

Parameters:

• name (str) – Name of the selection
• b_limit (SelectionParameter) – Limit around Galactic plane to exclude in Galactic latitude and in units of degrees

b_limit

draw(size: int)

class popsynth.selection_probability.DistanceSelection(name: str = 'distance')

Bases: popsynth.selection_probability.spatial_selection.SpatialSelection

__init__(name: str = 'distance')

Select distances

Parameters:

• name (str) – Name of the selection
• min_distance – minimum distance to select
• max_distance – maximum distance to select

draw(size: int)

max_distance

min_distance