#include <SineSubtract.h>

Public Member Functions
	SineFitterLimits (double maxA_relative_to_guess_=4, double minA_relative_to_guess_=0.25, double max_n_df_relative_to_guess_=1, double phase_start_error_=TMath::Pi()/16, double amp_start_error_=0.1, double freq_start_error_=0.1)

Public Attributes
double	maxA_relative_to_guess

double	minA_relative_to_guess

double	max_n_df_relative_to_guess

double	phase_start_error

double	amp_start_error

double	freq_start_error

Detailed Description

The SineFitterLimits class holds a few constraints that are used to limit the parameter space of the fit.

The things that may be contrained are

How far each fit amplitude trace can deviate from the guess (two multiplicative factors)
How far the fit frequency can deviate from the guess, in terms of fnyq / nsamples.

Any value set to zero means no limit on that parameter.

I can't think of a good way to constrain the phase.

Member Data Documentation

◆ amp_start_error

double FFTtools::SineFitterLimits::amp_start_error

The fractional starting error of the amplitude

◆ freq_start_error

double FFTtools::SineFitterLimits::freq_start_error

The error, as a fraction of df, of the frequency estimate

◆ max_n_df_relative_to_guess

double FFTtools::SineFitterLimits::max_n_df_relative_to_guess

The maximum multiplative factor of fnyq/nsamples the fit frequency can deviate from the guess. Negative to disable, 0 to fix frequency. Note that if either min or max is 0, then it will be fixed.

◆ maxA_relative_to_guess

double FFTtools::SineFitterLimits::maxA_relative_to_guess

The maximum multiplicative factor the amplitudes can deviate from the guess. Negative to disable, 0 to fix amplitude.

◆ minA_relative_to_guess

double FFTtools::SineFitterLimits::minA_relative_to_guess

The minimum multiplicative factor the amplitudes can deviate from the guess. Negative to disable, 0 to fix amplitude. Note that if either min or max is 0, then it will be fixed.

◆ phase_start_error

double FFTtools::SineFitterLimits::phase_start_error

The starting error of the phase, in radians

The documentation for this class was generated from the following file:

include/SineSubtract.h

Public Member Functions

Public Attributes