Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improving ivec and iboot defaults in ipmag.aniso_magic/ipmag.plot_aniso #702

Open
Swanson-Hysell opened this issue Sep 13, 2023 · 0 comments

Comments

@Swanson-Hysell
Copy link
Member

Currently ipmag.aniso_magic() via the ipmag.plot_aniso() function is set up so that the ivec parameter only works when iboot is also true. It is nested inside of the if iboot: statement.

This functionality is confusing and in conflict with the description of the parameters.

  • ivec (confidence bound parameter): if True - plot bootstrapped eigenvectors instead of ellipses
  • iboot (confidence bound parameter): if True - bootstrap ellipses

It makes sense to have it be that ivec can be chosen independent of iboot.

Additionally, the bootstrap eigenvalue confidence plot is only shown when ivec=True and not for iboot=True if ivec=False. It probably makes sense for the default behavior to be that when either iboot=True or ivec=True that the bootstrap eigenvalue confidence plot is shown.

PmagPy version: 4.2.115

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant