Implement new `Corrector` API design
See original GitHub issueDuring a brainstorm today (by @christinahedges, @nksaunders, @barentsen), we provisionally decided to deprecate LightCurve.correct()
in favor of an object-oriented approach centered on an abstract Corrector
class which has three key methods:
Corrector(**data_required):
.correct(**options) -> LightCurve
.diagnose(**options) -> Figure
.interact() -> Bokeh widget
Specific implementations of this class would include SFFCorrector
, PLDCorrector
, and PCACorrector
. The rationale behind removing lc.correct()
is three-fold:
- Different correction methods require different input data and different options, which is difficult to expose as a single method.
- Forcing pixel-level decomposition (PLD) methods to operate on a LightCurve objects is awkward because the method requires pixel-level data.
- By exposing
Corrector
class objects, we will encourage users to research the correction methods being applied and, if necessary, develop their ownCorrector
subclass.
In summary, the old syntax:
lc_corrected = lc.correct(method="sff", **options)
…will be replaced by the new syntax:
lc_corrected = SFFCorrector(lc, centroids).correct(**options)
Issue Analytics
- State:
- Created 5 years ago
- Comments:6 (1 by maintainers)
Top Results From Across the Web
Advanced REST API Design - Medium
This method is easy to design, implement and remember. ... Clients will need to be updated to use the new API endpoints.
Read more >Build Grammarly API Opensource Grammar Correction ...
... We'll learn how to build an open source Grammarly API alternative for Grammar Correction in Python. We'll use Gramformer...
Read more >Building a Spell Checking Web API in ASP.NET Core
The sample implements the Web API controller SpellController: ... In the method Check, a new instance of the spell checker is created and...
Read more >Spell checker framework - Android Developers
The Android platform offers a spelling checker framework that lets you implement and access spell checking in your application.
Read more >How to Build Consistent, Meaningful APIs with Postman
Designing API First · Fork the gopher-holes-unlimited repo and clone it onto your machine · In your Postman workspace, hit New > API...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
I’d like to leave this open until we have added a
diagnose()
method to both SFFCorrector and PLDCorrector. (Even if all it does for now is return an informative summary plot.)Closing this issue due to inactivity. Improvements on the
Corrector
classes continue to be made, e.g. over in #525.