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

Class WaveletFeatures is confusing #113

Closed
Catarina-Alves opened this issue Apr 11, 2019 · 2 comments · Fixed by #219
Closed

Class WaveletFeatures is confusing #113

Catarina-Alves opened this issue Apr 11, 2019 · 2 comments · Fixed by #219
Assignees
Labels
enhancement Improvement to existing functionality or implementation, including adding a new functions/methods. feature To add a new feature, new standalone files. (High level) pre-v2.0.0 Issues that should be completed prior to public release of v2.0.0 refactor Where a refactoring is required

Comments

@Catarina-Alves
Copy link
Collaborator

Catarina-Alves commented Apr 11, 2019

There are several things in the code that are messy: add-ons to add-ons, missing docstrings, non-clear names, missing functionalities (or functionalities that are there but that are hard to find) and the code does not follow the convention (which is natural as it was written before it).

I propose to improve this class, solving most of these problems (including issues #72, #75, #76, #77, #78 and #112).
This is important for me now as I am verifying the features and it is harder than it should be.

I am going to change mostly what I am using to verify the features but if you have requests/ comments regarding specific parts, please write them here.

@Catarina-Alves Catarina-Alves self-assigned this Apr 11, 2019
@Catarina-Alves Catarina-Alves added enhancement Improvement to existing functionality or implementation, including adding a new functions/methods. new functionality labels Apr 11, 2019
@tallamjr tallamjr self-assigned this Apr 12, 2019
@Catarina-Alves Catarina-Alves added feature To add a new feature, new standalone files. (High level) pre-v2.0.0 Issues that should be completed prior to public release of v2.0.0 refactor Where a refactoring is required labels May 28, 2020
@Catarina-Alves
Copy link
Collaborator Author

This should resolve issues #177, #152, #148, #112, #78, #77, #76, #75, #85, #70
It might also solve issues #107, #91 (in parte), #65

snfeatures restructuring - general:

  • Remove legacy code - any code that is commented out is erased
  • Add more documentation to some functions (e.g. fit_sn)
  • Have more descriptive names (e.g. currently wavelet_decomp performs wavelet decomposition on a single light curve and extract_wavelets performs in all dataset but the names don’t show the similarities/ differences)
  • Be more consistent in naming and overall have better names for variables and functions

snfeatures restructuring - desired functionalities (some already exist):

  • from GP -> calculate full wavelet decomposition
  • from GP -> calculate reduced wavelets
  • from full wavelet decomposition -> calculate reduced wavelets
  • from full wavelet decomposition -> reconstruct light curves
  • from saved PCA -> compute reduced wavelet decomposition with different number of components
  • from saved PCA -> project new data into specific number of components
  • from reduced wavelets -> reconstruct full wavelet decomposition (lossy)
  • from reduced wavelets -> reconstruct light curves
  • from reduced wavelets -> compute reconstruction error

Other:

  • Remove __future__ import
  • Only keep the SVD eigendecomposition because it is the most efficient method

@Catarina-Alves Catarina-Alves pinned this issue May 31, 2020
@Catarina-Alves Catarina-Alves unpinned this issue Jun 3, 2020
@Catarina-Alves Catarina-Alves linked a pull request Jun 15, 2020 that will close this issue
@Catarina-Alves
Copy link
Collaborator Author

Solved with #219.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvement to existing functionality or implementation, including adding a new functions/methods. feature To add a new feature, new standalone files. (High level) pre-v2.0.0 Issues that should be completed prior to public release of v2.0.0 refactor Where a refactoring is required
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants