agencyenterprise / neurotechdevkit

Neurotech Development Kit (NDK)
https://agencyenterprise.github.io/neurotechdevkit/
Apache License 2.0
115 stars 10 forks source link

Add 'clim' parameters to enable control over the color scale of pressure plots. #166

Open stmartin opened 10 months ago

stmartin commented 10 months ago

Describe the new feature or enhancement

It would be beneficial to include a 'clim' parameter in 'render_steady_state_amplitudes' to allow for control over the color limits of the pressure plots. This feature would be useful for all image plots utilizing a color scale.

This feature would facilitate the comparison of simulation plots across different scenarios by ensuring they use a consistent color scale. The current implementation can be misleading in its interpretation, as it automatically adjusts the color scale limits.

Describe your proposed implementation

def render_steady_state_amplitudes(
        self,
        show_sources: bool = True,
        show_target: bool = True,
        show_material_outlines: bool = True,
        clim: Tuple[float, float] = None,
    )