API Reference

This page is the reference layer for the user guide. For narrative documentation, start with Quickstart, Method overview, and Configuration.

Main workflow

jacscanomaly.Finder([config, fitter, plotter])

Main entry point of jacscanomaly.

jacscanomaly.FinderConfig([fitter_kind, ...])

Configuration object for jacscanomaly.finder.Finder.

jacscanomaly.CandidateCriteria([min_dchi2, ...])

Quality criteria used to accept/reject anomaly candidates.

jacscanomaly.PlanetSignalExtractor(finder[, ...])

Extract strong non-PSPL signal after iteratively refining the baseline.

jacscanomaly.PlanetSignalConfig([...])

Configuration for iterative single-lens refinement and signal extraction.

jacscanomaly.PlanetSignalResult(time, flux, ...)

Result of PlanetSignalExtractor.

jacscanomaly.PlanetSignalTiming([...])

Wall-clock accounting for one extraction, excluding caller setup.

jacscanomaly.PlanetFeatureConfig([...])

Controls peak and dip measurement on an extracted residual signal.

jacscanomaly.PlanetFeatureResult(peaks, dips)

Flat peak/dip measurements for one extracted planet signal.

jacscanomaly.TemplateFreeScanner([config])

Template-free anomaly scanner operating on residual z-score excursions.

jacscanomaly.TemplateFreeSearchConfig([gap, ...])

Configuration for template-free residual anomaly searches.

jacscanomaly.TemplateFreeSearchResult(time, ...)

Result of a template-free residual anomaly search.

FFT search backends

jacscanomaly.PSPLFFTScanner(*[, grid_dt, ...])

FFT matched-filter scanner for PSPL initial values.

jacscanomaly.PSPLFFTSearchResult(candidates, ...)

Ranked PSPL seeds from an FFT template-bank search.

jacscanomaly.PSPLFFTCandidate(t0, teff, u0, ...)

One PSPL seed selected from an FFT profile.

jacscanomaly.PSPLFFTProfile(t0, chi2, ...)

Profiled PSPL likelihood over every t0 grid point.

Result containers

jacscanomaly.AnomalyResult(time, flux, ferr, ...)

Output of scanomaly.finder.Finder.run().

jacscanomaly.BestCandidate(t0, teff, dchi2, ...)

Best anomaly candidate selected from all extracted clusters.

jacscanomaly.CandidateQuality(n_window, ...)

Per-candidate quality diagnostics derived from per-point chi-square improvement.

jacscanomaly.SeasonSummary(season_idx, ...)

Summary of the anomaly scan for a single season.

Plotting

jacscanomaly.AnomalyPlotter()

Plot utilities for scanomaly results.

Single-lens fitting

jacscanomaly.PSPLFitter([maxiter, ...])

PSPL fitter (Point-Source Point-Lens).

jacscanomaly.CPPPSPLFitter([maxiter, ...])

C++ PSPL fitter.

jacscanomaly.FSPLFitter([maxiter, ...])

FSPL fitter (Finite-Source Point-Lens).

jacscanomaly.NativePSPLAnnualParallaxFitter(...)

jacscanomaly.NativeFSPLAnnualParallaxFitter(...)

jacscanomaly.NativePSPLSpaceParallaxFitter(...)

jacscanomaly.NativeFSPLSpaceParallaxFitter(...)

jacscanomaly.BICSingleLensFitter(RA, Dec, ...)

Select PSPL, FSPL, or native FSPL space-parallax by BIC.

jacscanomaly.CVFitter([maxiter, ...])

Cataclysmic-variable-like transient fitter.

jacscanomaly.SingleLensFitResult(time, flux, ...)

Result of a single-lens microlensing fit.

Module reference

jacscanomaly.config

jacscanomaly.criteria

jacscanomaly.finder

jacscanomaly.models

jacscanomaly.seasons

jacscanomaly.extract

jacscanomaly.runner

jacscanomaly.anomaly_models

jacscanomaly.photometry

jacscanomaly.magnification

jacscanomaly.trajectory

jacscanomaly.singlelens_fit

jacscanomaly.singlelens_model

jacscanomaly.template_free

jacscanomaly.planet_signal

jacscanomaly.plot