determine_final_classes#

cogsworth.classify.determine_final_classes(population=None, bpp=None, kick_info=None, orbits=None, potential=None)[source]#

Determine the classes of each member of a population at the last point in the evolution (usually present day).

Either supply a Population class or each individual table separately

Parameters:
populationPopulation, optional

A full population class created from the pop module, by default None

bppDataFrame

Evolutionary history of each binary

kick_infoDataFrame

Information about the kicks that occur for each binary

orbitslist of Orbit

The orbits of each binary within the galaxy. Disrupted binaries should have two entries (for both stars), where the secondary is appended in sequence to the full list.

galactic_potentialPotential, optional

Galactic potential to use for evolving the orbits of binaries

Returns:
classesDataFrame

A DataFrame with a boolean column for each class and a row for each binary. Run list_classes() to see the available classes and their criteria.

Raises:
ValueError

If either population is None OR any another parameter is None