The Sdc1Scorer class

class ska_sdc.sdc1.sdc1_scorer.Sdc1Scorer(sub_df, truth_df, freq)

The SDC1 scorer class.

Parameters:
  • sub_df (pandas.DataFrame) – The submission catalogue DataFrame of detected sources and properties
  • truth_path (pandas.DataFrame) – The truth catalogue DataFrame
  • freq (int) – Image frequency band (560, 1400 or 9200 MHz)
classmethod from_txt(sub_path, truth_path, freq, sub_skiprows=1, truth_skiprows=0)

Create an SDC1 scorer class from two source catalogues in text format.

Parameters:
  • sub_path (str) – The path of the submission catalogue of detected sources and properties
  • truth_path (str) – The path of the truth catalogue
  • freq (int) – Image frequency band (560, 1400 or 9200 MHz)
  • sub_skiprows (int, optional) – Number of rows to skip in submission catalogue. Defaults to 1.
  • truth_skiprows (int, optional) – Number of rows to skip in truth catalogue. Defaults to 0.
run(mode=0, train=False, detail=False)

Run the scoring pipeline.

Parameters:
  • mode (int, optional) – 0 or 1 to use core or centroid positions for scoring
  • train (bool, optional) – If True, will only evaluate score based on training area, else will exclude training area
  • detail (bool, optional) – If True, will return the catalogue of matches and per source scores.
Returns:

The calculated

SDC1 score object

Return type:

ska_sdc.sdc1.models.sdc1_score.Sdc1Score

score

Get the resulting Sdc1Score object.

Returns:The calculated SDC1 score object
Return type:ska_sdc.sdc1.models.sdc1_score.Sdc1Score