Plotly Plots

plotly_plots

plot_heatmap

plot_heatmap(
    dataframe: DataFrame,
    report_settings: ReportSettings = ReportSettings(),
) -> str

Render a heatmap plot.

Parameters:

• dataframe (DataFrame) –

  The data to plot.

• report_settings (ReportSettings, default: ReportSettings() ) –

  Report settings.

Returns:

• str –

  HTML string of the rendered report including the heatmap plot.

Source code in trajectopy\visualization\plotly_plots.py

def plot_heatmap(dataframe: pd.DataFrame, report_settings: ReportSettings = ReportSettings()) -> str:
    """
    Render a heatmap plot.

    Args:
        dataframe: The data to plot.
        report_settings: Report settings.

    Returns:
        HTML string of the rendered report including the heatmap plot.
    """
    fig = px.imshow(
        dataframe,
        text_auto=".2f",
        color_continuous_scale="RdBu_r",
        range_color=[-1, 1],
        title="Correlation Matrix",
        aspect="auto",
    )

    fig.update_layout(height=report_settings.single_plot_height)

    return plot(fig, output_type="div", config=report_settings.single_plot_export.to_config())

plot_alignment_table

plot_alignment_table(
    alignment_parameters: AlignmentParameters,
    report_settings: ReportSettings = ReportSettings(),
) -> str

Render a heatmap plot.

Parameters:

• alignment_parameters (AlignmentParameters) –

  Alignment parameters.

• report_settings (ReportSettings, default: ReportSettings() ) –

  Report settings. Defaults to ReportSettings().

Returns:

• str –

  HTML string of the rendered report including the heatmap plot.

Source code in trajectopy\visualization\plotly_plots.py

def plot_alignment_table(
    alignment_parameters: AlignmentParameters, report_settings: ReportSettings = ReportSettings()
) -> str:
    """
    Render a heatmap plot.

    Args:
        alignment_parameters (AlignmentParameters): Alignment parameters.
        report_settings (ReportSettings, optional): Report settings. Defaults to ReportSettings().

    Returns:
        HTML string of the rendered report including the heatmap plot.
    """

    def extract_value(param_string: str) -> str:
        return param_string.split("=")[1].split("s-dev")[0].strip()

    def extract_std(param_string: str) -> str:
        return param_string.split(":")[-1].strip()

    labels = alignment_parameters.params_labels(enabled_only=True, lower_case=False)
    alignment_data = [
        go.Table(
            header=dict(values=["Parameter", "Value", "Standard Deviation"]),
            cells=dict(
                values=[
                    labels,
                    [extract_value(param_string) for param_string in alignment_parameters.to_string_list()],
                    [extract_std(param_string) for param_string in alignment_parameters.to_string_list()],
                ],
            ),
            name="Alignment Parameters",
        )
    ]
    fig = go.Figure(data=alignment_data)
    return plot(fig, output_type="div", config=report_settings.single_plot_export.to_config())