synthpop.modules.post_processing.additional_cuts

Post-processing module to make additional cuts to the catalog.

Classes

AdditionalCuts

Post-processing module to make additional cuts on which stars are included in the catalog.

Module Contents

class synthpop.modules.post_processing.additional_cuts.AdditionalCuts(model, logger, standard_cuts=None, difference_cuts=None, **kwargs)

Bases: synthpop.modules.post_processing._post_processing.PostProcessing

Post-processing module to make additional cuts on which stars are included in the catalog. These may be based on a minimum or maximum value for any column(s), or a minimum or maximum value of the difference between any column pair(s).

Attributes

standard_cutslist

list of cuts to make by data column name, cut type, and cut limit; e.g. [[‘param_name1’, ‘cut_type1’, cut_limit1], [‘param_name2’, ‘cut_type2’, cut_limit2]], where ‘param_nameN’ can be any column in the DataFrame, ‘cut_typeN’ must be ‘min’ or ‘max’, and cutlimitN should be the int or float value to cut at.

difference_cutslist

list of cuts to make based on column value differences (e.g. color); e.g. [[‘param_name1a’, ‘param_name1b’, ‘cut_type1’, cut_limit1], [‘param_name2a’, ‘param_name2b’, ‘cut_type2’, cut_limit2]], where ‘param_nameNm’ can be any column in the DataFrame, ‘cut_typeN’ must be ‘min’ or ‘max’, and cutlimitN should be the int or float value to cut at.

standard_cuts = None

difference_cuts = None

do_post_processing(dataframe: pandas.DataFrame) → pandas.DataFrame

Make the cuts and return the modified catalog.