XlsAnalysisExportFilter#

class pyCGM2.Processing.exporter.XlsAnalysisExportFilter#

Filter for exporting an analysis instance as a spreadsheet.

The exported spreadsheet can be organized either by row (in ‘Advanced’ mode) or by column (in ‘Basic’ mode). In ‘Advanced’ mode, a row consists of 101 columns representing a time-normalized cycle.

analysis#

An instance of Analysis to be exported.

Type:

Analysis

__init__()#

Methods

__init__()

export(outputName[, path, excelFormat, mode])

Export the analysis instance as a spreadsheet.

setAnalysisInstance(analysisInstance)

Set the analysis instance to be exported.

export(outputName: str, path: str | None = None, excelFormat: str = 'xls', mode: str = 'Advanced')#

Export the analysis instance as a spreadsheet.

Parameters:
  • outputName (str) – The base filename for the output file, without extension.

  • path (Optional[str]) – The directory path for the output file. If None, the current directory is used.

  • excelFormat (str) – The format of the output file (‘xls’ or ‘xlsx’).

  • mode (str) – The structure mode of the spreadsheet (‘Advanced’ or ‘Basic’).

setAnalysisInstance(analysisInstance: Analysis)#

Set the analysis instance to be exported.

Parameters:

analysisInstance (Analysis) – An instance of Analysis.