GenerateDatasetReport package

Subpackages

• Common package
  • Submodules
  • LOGS_solutions.GenerateDatasetReport.Common.FileHandler module
    • FileHandler
      • FileHandler.clean_csv_text()
      • FileHandler.clean_filename()
  • LOGS_solutions.GenerateDatasetReport.Common.PathValidator module
    • PathValidator
      • PathValidator.validate_path()
  • Module contents

Submodules

LOGS_solutions.GenerateDatasetReport.DatasetReportGenerator module

class LOGS_solutions.GenerateDatasetReport.DatasetReportGenerator.DatasetReportGenerator(logs, dataset_id, target_path, param_category=None, excluded_tracks=[], separate_complex_plots=True)

Bases: object

Generates a Report of one datasets.

create_datasets_report()

Creates the reports of the datasets.

generate_qr_code()

Generates a QR code for the dataset. Used in the HTML report.

Parameters:

dataset_id – The ID of the dataset for which the QR code should be generated.

Return type:

Path

get_base_url(api_url)

Returns the URL of the dataset. :param api_url: The API-URL of the dataset.

Return type:

str

Returns:

The URL of the dataset.

get_graph(dataset)

Generates a list of images using matplotlib and a dictionary containing the counts of the tracks and their types. Images are returned in a form suitable for websites or other text-based environments (Base64-encoded).

Parameters:

• dataset (Dataset) – dataset of the track

• prefix – first part of the file name

Return type:

Tuple[List, Dict[str, int]]

Returns:

Tuple with the list of images and a dictionary with the number of track types

plot_image(track)

Generates the image of one image track.

Parameters:

track (TrackImage) – Image track

Return type:

Figure

Returns:

The figure of the image.

plot_matrix_real(track)

Generates a Heatmap of one matrix track.

Parameters:

track (TrackMatrix) – TrackMatrix track

Return type:

Figure

Returns:

The figure of the heatmap.

plot_table(track)

Generates a table of one table track.

Parameters:

track (TrackTable) – table track

Return type:

Figure

Returns:

The figure of the table.

plot_xy_complex(formatter_axis, track, sep_part=None)

Generates a 1D plot of one XY_complex track.

Parameters:

• formatter_axis (ScalarFormatter) – ScalarFormatter of matplotlib for controlling the scaling and display of numerical values on the axes of a plot.

• track (TrackXYComplex) – XY_real track

• sep_part (Optional[int]) – 0 for real part, 1 for imaginary part, None for both parts

Return type:

Figure

Returns:

The figure of the plot.

plot_xy_real(formatter_axis, track)

Generates a 1D plot of one XY_real track.

Parameters:

• formatter_axis (ScalarFormatter) – ScalarFormatter of matplotlib for controlling the scaling and display of numerical values on the axes of a plot.

• track (TrackXY) – XY_real track

• invert_axes – If True, the axes will be inverted (both will be descending)

Return type:

Figure

Returns:

The figure of the plot.

read_parameter_list(param_list, round_num=0, param_prev=None)

Reads the parameter list and returns a dictionary with the parameters.

Parameters:

• param_list (ParameterList) – The parameter list to read.

• round_num (int) – The current round number, used for recursive calls.

Return type:

Dict[str, Any]

Returns:

A dictionary with the parameters.

read_parameter_table(param_table)

Reads the parameter table and returns a dictionary with the parameters.

Parameters:

param_table (ParameterTable) – The parameter table to read.

Return type:

Dict[str, Any]

Returns:

A dictionary with the parameters.

validate_dataset(dataset)

Validates the given dataset.

Parameters:

dataset (Dataset) – The dataset to validate.

Return type:

bool

Returns:

True if the dataset ID is valid, False otherwise.

Module contents