Public Member Functions | Public Attributes | List of all members
FFTtools::SineFitterLimits Class Reference

#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

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

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

Definition at line 132 of file SineSubtract.h.

Collaboration diagram for FFTtools::SineFitterLimits:
Collaboration graph
[legend]

Member Data Documentation

double FFTtools::SineFitterLimits::amp_start_error

The fractional starting error of the amplitude

Definition at line 149 of file SineSubtract.h.

double FFTtools::SineFitterLimits::freq_start_error

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

Definition at line 152 of file SineSubtract.h.

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.

Definition at line 143 of file SineSubtract.h.

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.

Definition at line 137 of file SineSubtract.h.

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.

Definition at line 140 of file SineSubtract.h.

double FFTtools::SineFitterLimits::phase_start_error

The starting error of the phase, in radians

Definition at line 146 of file SineSubtract.h.


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