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

Make heatmap and panel APIs and actions more consistent with one-another #113

Open
GilesStrong opened this issue May 24, 2022 · 0 comments
Labels
Detectors Issue affects the detectors Functionality Issue adds to the functionality of the package low priority Should be fixed eventually, but isn't urgent

Comments

@GilesStrong
Copy link
Owner

Currently the two classes have similar init args, e.g. init_xyz and init_xy_span, however they can have different conceptual meanings, e.g. init_xy_span in Panel is a 2-tuple of floats specifying the panel dimensions in x and y, but for DetectorHeatMap it is 2-tuple of floats specifying the range in both x and y within which the panels are expected to be found, and the a single width is automatically computed from this.

Additionally, Panel learns xy, z and xy_span using a Gaussian model, and the final parameters can be accessed directly from these. But DetectorHeatMap instead learns mu, sig, norm, and z and the user must interpret them into detector parameters. #112 will help with this.

@GilesStrong GilesStrong added low priority Should be fixed eventually, but isn't urgent Functionality Issue adds to the functionality of the package Detectors Issue affects the detectors labels May 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Detectors Issue affects the detectors Functionality Issue adds to the functionality of the package low priority Should be fixed eventually, but isn't urgent
Projects
None yet
Development

No branches or pull requests

1 participant