Reports.V1Report

Reports.V1Report#

Reports.V1Report.py

class PreProcessing(ssd, **kwargs)#

Bases: object

A class to prepare the V1 report. This class is used to prepare the V1 report by running the necessary steps in a separate thread. It uses a progress set to track the progress of the report generation.

ssd#

The SecSaxsData object containing the data.

Type:

SecSaxsData

kwargs#

Additional keyword arguments for configuration.

Type:

dict

num_steps#

The number of steps to be performed.

Type:

int

rgcurves#

The tuple containing the molecular and ATSAS Rg curves.

Type:

tuple of ICurve

decomposition#

The decomposition object containing the components.

Type:

Decomposition

pairedranges#

The list of paired ranges for the components.

Type:

list of PairedRange

Initialize the PreProcessing class.

Parameters:

  • ssd (SecSaxsData) – The SecSaxsData object containing the data.

  • kwargs (dict) – Additional keyword arguments for configuration.

run(pu, debug=False)#

Run the preprocessing steps to prepare the V1 report. This method performs the necessary preprocessing steps to prepare the V1 report. It updates the progress unit as each step is completed.

Parameters:

  • pu (ProgressUnit) – The progress unit to track the progress of the report generation.

  • debug (bool, optional) – If True, print debug information.

make_v1report(ssd, **kwargs)#

Make the V1 report using the provided SecSaxsData and parameters. This function generates the V1 analysis report and saves it to an Excel file.

Parameters:

  • ssd (SecSaxsData) – The SecSaxsData object containing the data.

  • kwargs (dict) – Additional keyword arguments for configuration.

Return type:

None

make_v1report_runner(pu_list, ssd, preproc, env_info, kwargs)#

The runner function for generating the V1 report. This function is executed in a separate thread to generate the V1 report. It performs the necessary preprocessing and report generation steps.

Parameters:

  • pu_list (list of ProgressUnit) – The list of progress units to track the progress of the report generation.

  • ssd (SecSaxsData) – The SecSaxsData object containing the data.

  • preproc (PreProcessing) – The PreProcessing object to prepare the report.

  • env_info (EnvironmentInfo) – Information about the environment, including Excel and ATSAS availability.

  • kwargs (dict) – Additional keyword arguments for configuration.

Return type:

None

Contents