popsynth.selection_probability.spatial_selection module¶

class popsynth.selection_probability.spatial_selection.SpatialSelection(name: str)[source]¶

__init__(name: str) → None[source]¶

A generic spatial selection.

Parameters:	name (str) – Name of the selection

set_spatial_distribution(spatial_distribtuion: popsynth.distribution.SpatialDistribution) → None[source]¶

Set the spatial distribution for the selection.

Parameters:	spatial_distribution (`SpatialDistribution`) – The spatial_distribution

class popsynth.selection_probability.spatial_selection.GalacticPlaneSelection(name: str = 'galactic plane selector')[source]¶

__init__(name: str = 'galactic plane selector')[source]¶

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