DQM_multiple_record

This is the class for computing the DQM for multiple records. It supports to compute an overall DQM for the whole dataset, and compute a set of individual DQMs for each record in the dataset.

class QPrism.Sensor.DQM.DQM_multiple_record

Bases: object

A class represents the data quality matrix for multiple files in one directory.

compute_avg_DQM()

Compute a DQM for the input records under current metrics configuration. The DQM averaged all the metrics that are supported in DQM_single_file. In addition to above metrics, it also computes all the metrics only support DQM_multi_file. The computed DQM consists only one row. If you wish to get the DQM for each individual record, call the compute_individual_DQM method instead. Must call set_input_path before calling this method.

compute_individual_DQM()

Compute a DQM for the input records under current metrics configuration. This computes the DQM for each individual record, and store the DQMs as a list. If you wish to get the averaged DQM with the metrics only support multiple records, call the compute_avg_DQM method instead. Must call set_input_path before calling this method.

get_APD()

Return the APD score for given input data as a str. APD must be included in the DQM class.

get_IRLR()

Return the IRLR score for given input data as a str.

get_MDR()

Return the MDR score for given input data as a str. MDR must be included in the DQM class.

get_RLC()

Return the RLC score for given input data as a str. RLC must be included in the DQM class.

get_SCR()

Return the SCR score for given input data as a str. SCR must be included in the DQM class.

get_SNR()

Return the SNR score for given input data as a str. SNR must be included in the DQM class.

get_SRC()

Return the SRC score for given input data as a str. SRC must be included in the DQM class.

get_VDR()

Return the VDR score for given input data as a str. VDR must be included in the DQM class.

get_VRC()

Return the VRC score for given input data as a str. VRC must be included in the DQM class.

get_avg_DQM()

Return the computed DQM as a list. compute_DQM must be called before this method.

get_avg_fields()

Return a list represents the current included metrics in the multi-file DQM. compute_avg_DQM must be called before this method.

get_individual_DQM()

Return the computed individual DQM as a list. Each element in the list represents a single record. compute_individual DQM must be called before this method.

get_individual_fields()

Return a list represents the current included metrics in the individual file DQM. compute_individual_DQM must be called before this method.

save_avg_DQM_to_file(path: str)

Save the computed DQM as a csv file to the given output path. Must call compute_DQM before calling this.

pathstr

Path to the output file

save_individual_DQM_to_file(path: str)

Save the computed DQM as a csv file to the given output path. Must call compute_DQM before calling this.

pathstr

Path to the output file

set_APD(included: bool)

Set whether APD is included as a metric

includedbool

A bool value to indicate whether APD is included in the result DQM

set_MDR(included: bool)

Set whether MDR is included as a metric

includedbool

A bool value to indicate whether MDR is included in the result DQM

set_RLC(included: bool)

Set whether RLC is included as a metric

includedbool

A bool value to indicate whether RLC is included in the result DQM

set_SCR(included: bool)

Set whether SCR is included as a metric

includedbool

A bool value to indicate whether SCR is included in the result DQM

set_SNR(included: bool)

Set whether SNR is included as a metric

includedbool

A bool value to indicate whether SNR is included in the result DQM

set_SRC(included: bool)

Set whether SRC is included as a metric

includedbool

A bool value to indicate whether SRC is included in the result DQM

set_VDR(included: bool)

Set whether VDR is included as a metric

includedbool

A bool value to indicate whether VDR is included in the result DQM

set_VRC(included: bool)

Set whether VRC is included as a metric

includedbool

A bool value to indicate whether VRC is included in the result DQM

set_input_data(df_list)

Set the input data list of input file.

df_listlist of pd.DataFrame

A list of dataframe, each dataframe represents a single record, all entries in the dataframe should be able to convert to float in order to compute the DQM.