AnalysisExportFilter

class pyCGM2.Processing.exporter.AnalysisExportFilter

Filter for exporting an Analysis instance as a JSON file.

analysis

An instance of Analysis to be exported.

Type:

Analysis

__init__()

Methods

__init__()
export(outputName[, path])	Export the Analysis instance as a JSON file.
setAnalysisInstance(analysisInstance)	Set the Analysis instance to be exported.

export(outputName: str, path: str | None = None)

Export the Analysis instance as a JSON file.

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.

Returns:

Dict[str, Any] – The dictionary object that is written to the JSON file.

setAnalysisInstance(analysisInstance: Analysis)

Set the Analysis instance to be exported.

Parameters:

analysisInstance (Analysis) – An instance of Analysis.