Testfitpeaks: Difference between revisions
Jump to navigation
Jump to search
imported>Jeremy (Importing text file) |
imported>Jeremy (Importing text file) |
||
| Line 1: | Line 1: | ||
===Purpose=== | ===Purpose=== | ||
Demo calls to the FITPEAKS function. | Demo calls to the FITPEAKS function. | ||
===Synopsis=== | ===Synopsis=== | ||
:[peakdef,fval,exitflag,output] = testfitpeaks(test) | :[peakdef,fval,exitflag,output] = testfitpeaks(test) | ||
===Description=== | ===Description=== | ||
TESTFITPEAKS is a set of example calls to FITPEAKS. Editing this M-file provides some insight into how the peak fitting utilities can be used. | TESTFITPEAKS is a set of example calls to FITPEAKS. Editing this M-file provides some insight into how the peak fitting utilities can be used. | ||
No input is required. | No input is required. | ||
====OPTIONAL INPUTS==== | ====OPTIONAL INPUTS==== | ||
* '''test''' = calls different peak fitting examples. | * '''test''' = calls different peak fitting examples. | ||
* '''test''' = 1 fits a single Gaussian peak. | * '''test''' = 1 fits a single Gaussian peak. | ||
* '''test''' = 2 fits two Gaussian peaks. | * '''test''' = 2 fits two Gaussian peaks. | ||
* '''test''' = 3 fits a single Lorentzian peak. | * '''test''' = 3 fits a single Lorentzian peak. | ||
* '''test''' = 4 fits two Lorentzian peaks. | * '''test''' = 4 fits two Lorentzian peaks. | ||
* '''test''' = 5 fits a Gaussian and Lorentzian peak. | * '''test''' = 5 fits a Gaussian and Lorentzian peak. | ||
* '''test''' = 6 fits a single PVoigt2 peak. | * '''test''' = 6 fits a single PVoigt2 peak. | ||
* '''test''' = 7 fits a Gaussian and a PVoigt2 peak. | * '''test''' = 7 fits a Gaussian and a PVoigt2 peak. | ||
* '''test''' = 8 fits a Gaussian and a PVoigt1 peak. | * '''test''' = 8 fits a Gaussian and a PVoigt1 peak. | ||
* '''test''' = 9 fits a single PVoigt1 peak. | * '''test''' = 9 fits a single PVoigt1 peak. | ||
====OUTPUTS==== | ====OUTPUTS==== | ||
* '''peakdef''' = The input peak structure (peakdef) with parameters changed to correspond to the best fit values. | * '''peakdef''' = The input peak structure (peakdef) with parameters changed to correspond to the best fit values. | ||
* '''fval''' = Scalar value of the objective function evaluated at termination of FITPEAKS. | * '''fval''' = Scalar value of the objective function evaluated at termination of FITPEAKS. | ||
* '''exitflag''' = Describes the exit condition (see LMOPTIMIZEBND). | * '''exitflag''' = Describes the exit condition (see LMOPTIMIZEBND). | ||
* '''out''' = Structure array with information on the optimization/fitting (see LMOPTIMIZEBND). | * '''out''' = Structure array with information on the optimization/fitting (see LMOPTIMIZEBND). | ||
===See Also=== | ===See Also=== | ||
[[fitpeaks]], [[peakfunction]], [[peakstruct]] | [[fitpeaks]], [[peakfunction]], [[peakstruct]] | ||
Revision as of 14:27, 3 September 2008
Purpose
Demo calls to the FITPEAKS function.
Synopsis
- [peakdef,fval,exitflag,output] = testfitpeaks(test)
Description
TESTFITPEAKS is a set of example calls to FITPEAKS. Editing this M-file provides some insight into how the peak fitting utilities can be used.
No input is required.
OPTIONAL INPUTS
- test = calls different peak fitting examples.
- test = 1 fits a single Gaussian peak.
- test = 2 fits two Gaussian peaks.
- test = 3 fits a single Lorentzian peak.
- test = 4 fits two Lorentzian peaks.
- test = 5 fits a Gaussian and Lorentzian peak.
- test = 6 fits a single PVoigt2 peak.
- test = 7 fits a Gaussian and a PVoigt2 peak.
- test = 8 fits a Gaussian and a PVoigt1 peak.
- test = 9 fits a single PVoigt1 peak.
OUTPUTS
- peakdef = The input peak structure (peakdef) with parameters changed to correspond to the best fit values.
- fval = Scalar value of the objective function evaluated at termination of FITPEAKS.
- exitflag = Describes the exit condition (see LMOPTIMIZEBND).
- out = Structure array with information on the optimization/fitting (see LMOPTIMIZEBND).