Survey

class compass.model.Survey(survey, survey_bandfilter_colname)

Bases: object

Creates odds ratio table based on the observational data of candidates and the field star models.

Based on the target name returns a dataframe containing all the survey data to this target and calculates the proper motion.

Parameters:

survey (pandas.DataFrame) –
Contains survey data. Necessary columns are:
- Main_ID: Host star name.
- final_uuid: Unique identifier of the two measurements of the same candidate.
- dRA: Relative distance candidate-hoststar in mas.
- dRA_err: Respective error.
- dDEC: Relative distance candidate-hoststar in mas.
- dDEC_err: Respective error.
- mag0: Magnitude of the candidate.
survey_bandfilter_colname (str) – Column name of survey magnitudes, e.g. ‘mag0’

Returns:

pandas.DataFrame – Contains the filtered survey data.

Methods Summary

`get_true_companions`([threshold])	Return all candidates with a odds ratio greater than the threshold.
`set_evaluated_fieldstar_models`([...])	Evaluate the field star models with candidate data.
`set_fieldstar_models`(binning_band_trafo, ...)	Build for each host star given in survey a field star model.

Methods Documentation

get_true_companions(threshold=0)

Return all candidates with a odds ratio greater than the threshold.

Parameters:: threshold (float) – Odds ratio greater than the threshold will be returned.
Returns:: pandas.DataFrame – Candidates with r_tcb>threshold.

set_evaluated_fieldstar_models(sigma_cc_min=0, sigma_model_min=0)

Evaluate the field star models with candidate data.

Parameters:

sigma_cc_min (float) – Minimum sigma for the candidates likelihoods.
sigma_model_min (float) – Minimum sigma for the field star model likelihoods.

set_fieldstar_models(binning_band_trafo, binning_band, cone_radius=0.3, binsize=200, std_fit='exp')

Build for each host star given in survey a field star model.

Parameters: