Skip to content

Question about the super-Gaussian function #195

@tomasstolker

Description

@tomasstolker

Hello AMICAL team!

The super-Gaussian function that is used for the windowing of AMI data is typically provided in some sort of form like exp(-r^4/r_0), of what I could find in a few articles.

Sorry if I may have misunderstood, but when I looked at the super_gaussian function in the tools module of AMICAL, the window function seemed somewhat different so I was wondering if this is an adjusted form that works better than the "original" form? Effectively the implementation in AMICAL seems to scale as exp(-r^6) instead of exp(-r^4)?

I wanted to suggest to add a reference and/or a few details about this in the documentation, since this seems differently provided in the AMICAL reference and then also incorrectly adopted into e.g. Blakely et al. 2022. Also, the amplitude a=1 in those two publications seems a typo since the constant should probably be before the exp term?

The description of the window parameter in the docstring seems also not fully accurate since it is described as the FWHM of the Gaussian. I think that it might be the HWHM instead? Or perhaps half of a standard deviation? Since in the argument that is provided to super_gaussian is sigma=2*window. I wasn't fully sure how to interpret that. Adding a docstring would also be helpful here.

The actual windowing seems to work fine though 😊 and when I plot the window profile then it looks reasonable (i.e. it has a sharp slope around the specified window value).

I would be happy to create a PR if that would be helpful. Just let me know in that case.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions