Report#

class pyCGM2.Report.report.Report(name='gaitReport')#

Word report made of analysis, intra-comparison and inter-comparison sections.

Parameters:

name (str, optional) – Report name. Defaults to "gaitReport".

__init__(name='gaitReport')#

Methods

__init__([name])

add_analysisSection(sectionTitle)

Add an analysis section.

add_interComparison(sectionTitle)

Add an inter-comparison section.

add_intraComparison(sectionTitle)

Add an intra-comparison section.

add_pageToAnalysis(analysisIndex, page, ...)

Add a page (or a list of pages) to an analysis section.

add_pageToInterComparison(comparisonIndex, ...)

Add a page (or a list of pages) to an inter-comparison section.

add_pageToIntraComparison(comparisonIndex, ...)

Add a page (or a list of pages) to an intra-comparison section.

generateWord(templatePathFile, doc_path, ...)

Generate the Word document from a docx template.
add_analysisSection(sectionTitle)#

Add an analysis section.

Parameters:

sectionTitle (str) – Title of the section.

add_interComparison(sectionTitle)#

Add an inter-comparison section.

Parameters:

sectionTitle (str) – Title of the section.

add_intraComparison(sectionTitle)#

Add an intra-comparison section.

Parameters:

sectionTitle (str) – Title of the section.

add_pageToAnalysis(analysisIndex, page, pageTiltle)#

Add a page (or a list of pages) to an analysis section.

Parameters:

  • analysisIndex (int) – Index of the section (starting at 1).

  • page (str | list) – Image filename(s) of the page(s).

  • pageTiltle (str) – Page title.

add_pageToInterComparison(comparisonIndex, page, pageTiltle)#

Add a page (or a list of pages) to an inter-comparison section.

Parameters:

  • analysisIndex (int) – Index of the section (starting at 1).

  • page (str | list) – Image filename(s) of the page(s).

  • pageTiltle (str) – Page title.

add_pageToIntraComparison(comparisonIndex, page, pageTiltle)#

Add a page (or a list of pages) to an intra-comparison section.

Parameters:

  • analysisIndex (int) – Index of the section (starting at 1).

  • page (str | list) – Image filename(s) of the page(s).

  • pageTiltle (str) – Page title.

generateWord(templatePathFile, doc_path, component_path, processedInfos=None)#

Generate the Word document from a docx template.

Parameters:

  • templatePathFile (str) – Path of the docx template.

  • doc_path (str) – Path of the output document.

  • component_path (str) – Folder of the page images.

  • processedInfos (dict, optional) – Additional information passed to the template.