• NAME
• VERSION
• SYNOPSIS
• DESCRIPTION
• ATTRIBUTES
• DEPENDENCIES
• BUGS AND LIMITATIONS
• AUTHOR
• LICENCE AND COPYRIGHT

NAME

Demeter::PeakFit::LineShape - A lineshape object for peak fitting in Demeter

VERSION

This documentation refers to Demeter version 0.9.26.

SYNOPSIS

DESCRIPTION

ATTRIBUTES

name

The string used in a plot lagend.

parent

The PeakFit function to which this LineShape belongs.

function

The form of the function, like Linear or Gaussian.

peaked

A flag that is true if the function associated with this object is a peak-like function.

Lines, step-like functions, and other non-peaked functions are set to 0. All others are set to 1.

np

The number of parameters used by the specified functional form.

xaxis

This is usually set to "energy" and is used by the plotting templates.

yaxis

This is usually set to "func" and is used by the plotting templates.

xmin

This is set to the lower bound fitting range when the fit method of the PeakFit object is called.

xmax

This is set to the lower bound fitting range when the fit method of the PeakFit object is called.

a0 through a7

The guessed (before the fit) and best-fit (after) values of the parameters of the function. Note that height is an alias for a0, center for a1, and hwhm for a2 -- all of which is convenient for peak-like function. Not all of these are used for any given function. For instance, a Voigt only uses a0 through a3.

e0 through e7

The uncertainties (0 before the fit) of the parameters of the function. Note that eheight is an alias for e0, ecenter for e1, and ehwhm for e2 -- all of which is convenient for peak-like function.

fix0 through fix7

Flags indicating whether to fix the associated value in a fit. Note that fixheight is an alias for fix0, fixcenter for fix1, and fixhwhm for fix2 -- all of which is convenient for peak-like function.

area

After the fit, this is filled with a measure of the peak area for a Peak-like function.

DEPENDENCIES

Demeter's dependencies are in the Build.PL file.

BUGS AND LIMITATIONS

• The function attribute retains an explicit reference to Fityk.

• Need better aliasing of parameter names for add and reporting.

Please report problems to the Ifeffit Mailing List (http://cars9.uchicago.edu/mailman/listinfo/ifeffit/)

Patches are welcome.

AUTHOR

Bruce Ravel (http://bruceravel.github.io/home)

http://bruceravel.github.io/demeter/

LICENCE AND COPYRIGHT

Copyright (c) 2006-2018 Bruce Ravel (http://bruceravel.github.io/home). All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlgpl.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.