Command Index

Alphabetical index of every VARTOOLS command, with links to the CLI reference and (where applicable) the pyvartools Python-API reference.

The CLI column links to the command's section in the appropriate cli/*.md page; the Python column links to its entry in the per-category pages under python/commands/. Commands flagged (USERLIB extension) require the -L option to load the corresponding library (see Extension Commands).

Searching

The search box (top right) matches command names, descriptions, and doc content simultaneously, and may help in finding a command whose exact name is uncertain.

Command	Description	CLI	Python API
-addfitskeyword	Add a custom keyword to the output-light-curve FITS header	CLI	Python
-addnoise	Add simulated white / red / correlated noise to light curves	CLI	Python
-alarm	Alarm statistic (Kovacs, Bakos & Noyes 2005)	CLI	Python
-aov	Phase-binned Analysis of Variance period search	CLI	Python
-aov_harm	Multi-harmonic Analysis of Variance period search	CLI	Python
-autocorrelation	Discrete autocorrelation function	CLI	Python
-binlc	Bin the light curve by time	CLI	Python
-BLS	Box-fitting Least Squares transit search	CLI	Python
-BLSFixDurTc	BLS with fixed transit duration and epoch	CLI	Python
-BLSFixPer	BLS at a fixed period	CLI	Python
-BLSFixPerDurTc	BLS with fixed period, duration, and epoch	CLI	Python
-changeerror	Replace the formal per-point uncertainty	CLI	Python
-changevariable	Reassign the internal t / mag / err / id roles	CLI	Python
-chi2	Weighted χ² relative to the mean	CLI	Python
-chi2bin	Binned weighted χ² for several bin sizes	CLI	Python
-clip	Sigma-clip outliers from the light curve	CLI	Python
-converttime	Convert between JD / MJD / HJD / BJD time systems	CLI	Python
-copylc	Replicate the in-memory light curve N times	CLI	Python
-decorr	Polynomial decorrelation against external signals (deprecated; use -linfit)	CLI	Python
-dftclean	Discrete Fourier Transform + CLEAN power spectrum	CLI	Python
-difffluxtomag	Convert ISIS differential flux to magnitude	CLI	Python
-ensemblerescalesig	Rescale all light curves' errors so ⟨χ²/dof⟩ = 1	CLI	Python
-expr	Evaluate an analytic expression; create or update a variable	CLI	Python
-fastchi2	Palmer's fast χ² periodogram (USERLIB extension)	CLI	Python
-FFT	Fast Fourier transform (evenly-sampled data)	CLI	Python
-findblends	Identify nearby variables that may blend into the target	CLI	Python
-fluxtomag	Convert flux to magnitude	CLI	Python
-fourierfilter	Full-band Fourier high/low/band-pass filter with optional analytic filter and edge tapering	CLI	Python
-ftuneven	Complex Fourier transform of unevenly sampled data (USERLIB extension)	CLI	Python
-GetLSAmpThresh	Minimum detectable amplitude at a given period (LS-based)	CLI	Python
-hatpiflag	Combine HATPI quality flags into a single binary flag (USERLIB extension)	CLI	Python
-if	Conditional block (-if / -elif / -else / -fi)	CLI	Python
-IFFT	Inverse fast Fourier transform	CLI	Python
-Injectharm	Inject a harmonic (sinusoidal) signal	CLI	Python
-Injecttransit	Inject a Mandel-Agol transit model	CLI	Python
-jktebop	JKTEBOP detached eclipsing binary model (USERLIB extension)	CLI	Python
-Jstet	Stetson J variability statistic	CLI	Python
-harmonicfilter	Fit and subtract a harmonic (Fourier) model	CLI	Python
-linfit	Linear regression against a user-specified basis	CLI	Python
-LS	Generalized Lomb-Scargle periodogram	CLI	Python
-macula	Macula rotation + spot light-curve model (USERLIB extension)	CLI	Python
-magadd	Add a constant offset to the magnitudes (USERLIB extension)	CLI	Python
-MandelAgolTransit	Mandel & Agol analytic transit model	CLI	Python
-match	Match observations across light curves by time or string ID	CLI	Python
-medianfilter	Running-median high-pass or low-pass filter	CLI	Python
-microlens	Point-source gravitational microlensing model	CLI	Python
-nonlinfit	Levenberg-Marquardt / MCMC nonlinear-model fitting	CLI	Python
-o	Write the (possibly modified) light curve to a file	CLI	Python
-Phase	Replace the time column with phase-folded coordinates	CLI	Python
-print	Emit user-computed scalars as columns in the statistics table	CLI	Python
-python	Run embedded Python code on each light curve	CLI	Python
-R	Run embedded R code on each light curve	CLI	Python
-resample	Interpolate the light curve onto a new time grid	CLI	Python
-rescalesig	Rescale per-point errors to make χ²/dof = 1	CLI	Python
-restorelc	Restore a light-curve state saved by -savelc	CLI	Python
-restoretimes	Undo a prior -restricttimes filter	CLI	Python
-restricttimes	Filter observations by JD range, JD list, image ID, or expression	CLI	Python
-rms	Mean magnitude, RMS, and expected RMS	CLI	Python
-rmsbin	Binned RMS for several bin sizes	CLI	Python
-savelc	Checkpoint the in-memory light curve for later -restorelc	CLI	Python
-SoftenedTransit	Protopapas softened-transit empirical model	CLI	Python
-sortlc	Sort the light curve by time (or another variable)	CLI	Python
-splinedetrend	Spline-based detrending (USERLIB extension)	CLI	Python
-Starspot	Star-spot rotational modulation model	CLI	Python
-stats	Compute arbitrary summary statistics on any variable	CLI	Python
-stitch	Stitch multi-segment light curves at offsets (USERLIB extension)	CLI	Python
-SYSREM	Systematic-error removal (Tamuz, Mazeh & Zucker 2005)	CLI	Python
-TFA	Trend Filtering Algorithm (Kovacs, Bakos & Noyes 2005)	CLI	Python
-TFA_SR	TFA with signal-reconstruction	CLI	Python
-wwz	Weighted Wavelet Z-transform (Foster 1996)	CLI	Python

Python helper classes

These are not CLI commands but are pyvartools-side helpers that appear in the Python API docs:

Class / helper	Description
Output	Auxiliary-output-file control passed to save_*=... parameters