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

rms_region is poorly defined/documented #52

Open
lboogaard opened this issue Nov 22, 2022 · 1 comment
Open

rms_region is poorly defined/documented #52

lboogaard opened this issue Nov 22, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@lboogaard
Copy link
Collaborator

lboogaard commented Nov 22, 2022

The rms_region keyword of findclumps is potentially confusing:

  • it's docstring is unclear: it is a length (in fraction of the spatial cube size on each axis) that defines a central square region in the collapsed slice over which an rms is computed
  • this rms is not actually used in findclumps (as sextractor does its own computation), but only provided in the catalog to have an estimate for the particular kernel/channel combination

In any case the docstring and should be clarfied. We could consider not even exposing this parameter to the user, or (perhaps better), making it more useful (for example, such that the user can define an aread that, for example, avoids the center).

@lboogaard lboogaard added the documentation Improvements or additions to documentation label Nov 22, 2022
@lboogaard
Copy link
Collaborator Author

lboogaard commented Nov 23, 2022

Also: the default value of 0.25 (linear dimension) is quite small, as it leads to only 0.125 of the area being used.
The size of the area is in fact the center +/- rms_region, so it does scale as described.

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

No branches or pull requests

1 participant