sorcha.modules.PPStats

Functions

stats(observations, statsfilename, outpath, sconfigs)

Write a summary statistics file including whether each object was linked

Module Contents

stats(observations, statsfilename, outpath, sconfigs, return_only=False)[source]

Write a summary statistics file including whether each object was linked or not within miniDifi, their number of observations, min/max phase angles, min/max trailed source magnitudes, and median trailed source magnitudes per filter

Parameters:

  • observations (Pandas dataframe) -- Pandas dataframe of observations

  • statsfilename (string) -- Stem filename to write summary stats file to

  • outpath (string) -- Directory pathway for output file

  • sconfigs (dataclass) -- Dataclass of configuration file arguments.

  • return_only (bool) -- Ignore writing result to disk and return DataFrame

Return type:

None or pandas.DataFrame