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

ll renamed to low_loss in create-model #105

Open
maclariz opened this issue Feb 11, 2025 · 1 comment
Open

ll renamed to low_loss in create-model #105

maclariz opened this issue Feb 11, 2025 · 1 comment
Labels
type: bug Something isn't working

Comments

@maclariz
Copy link

Documentation at https://hyperspy.org/exspy/user_guide/eels.html has:

m = s.create_model(ll=ll)

However ll gives an error when using. At:

https://hyperspy.org/exspy/reference/signals.html#exspy.signals.EELSSpectrum.create_model

the function definition in top line gives:

create_model(low_loss=None, auto_background=True, auto_add_edges=True, GOS='dft', gos_file_path=None, dictionary=None)

which is correct. But documentation below still says:

ll (None or EELSSpectrum) – If an EELSSpectrum is provided, it will be assumed that it is a low-loss EELS spectrum, and it will be used to simulate the effect of multiple scattering by convolving it with the EELS spectrum.

Please complete the renaming consistently throughout

@maclariz maclariz added the type: bug Something isn't working label Feb 11, 2025
@ericpre
Copy link
Member

ericpre commented Feb 11, 2025

Thank you @maclariz, the docstring needs fixing indeed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants