The Survey Module

class atelier.survey.Survey(obj_df, lum_colname, redsh_colname, sky_area, selection_function=None, lum_range=None, redsh_range=None, conf_interval='poisson')

Survey class is a container to hold information on the sources of a particular astronomical survey.

It is used primarily to forward observational data in the calculation of luminosity function fits.

obj_df

Data frame with information on astronomical sources in the survey.

Type:

pandas.DataFrame

lum_colname

The name of the data frame column holding the luminosity (absolute magnitude) information of the sources in the survey.

Type:

string

redsh_colname

The name of the data frame column holding the redshift information of the sources in the survey.

Type:

string

sky_area

Sky area the survey covers in square degrees

Type:

float

selection_function

Selection function of the survey (default = None).

Type:

lumfun.selfun.QsoSelectionFunction

calc_binned_lumfun_PC2000(lum_edges, redsh_edges, cosmology, kcorrection=None, app_mag_lim=None, **kwargs)

Calculation of the binned luminosity function based on the method outlined in Page & Carrera 2000

ADS Link: https://ui.adsabs.harvard.edu/abs/2000MNRAS.311..433P/abstract

This function is very similar to the other method for calculating the binned luminosity function below.

Parameters:

• lum_edges –

• redsh_edges –

• cosmology –

• kcorrection –

• app_mag_lim –

Returns:

atelier.survey.return_poisson_confidence(n, bound_low=0.15865, bound_upp=0.84135)

Return the Poisson confidence interval boundaries for the lower and upper bound given a number of events n.

The default values for ther lower and upper bounds are equivalent to the 1 sigma confidence interval of a normal distribution.

Parameters:

• n –

• n_sigma –

Returns: