| Description | Perl tools for X-ray Absorption Spectroscopy |
Demeter::Path::Sanity - Sanity checks for path parameter values
This documentation refers to Demeter version 0.9.26.
my ($isok, $reason) = $pathobject -> is_reasonable("e0");
print $reason if (not $is_ok);
==> The absolute value of e0 for "path label" is greater than 10 evThis module provides a series of rules for determining the appropriateness of fitted path parameter values. These rules are all configurable, but tend to be checks on the magnitude and/or parity of the evaluated parameter. See the warnings configuration group.
The user should never need to call the methods explicitly since they are called automatically whenever a fit or a sum is performed. However they are documented here so that the scope of such checks made is clearly understood.
These rules are among the criteria used to evaluate the fit happiness. See <Demeter::Fit::Happiness>.
Test are made on the reasonableness of the e0, s02, delr, sigma2, ei, third, and fourth path parameters, as defined by the warnings configuration group.
The only method intended for external use is is_reasonable, as shown in the "SYNOPIS". It returns a two-element list, the first element being a flag indicating whether the path parameter passed its tests and the second being an explanation of the problem, if one is found.
See Demeter::Config for a description of the configuration system. See the warnings configuration group.
Demeter's dependencies are in the Build.PL file.
Please report problems to the Ifeffit Mailing List (http://cars9.uchicago.edu/mailman/listinfo/ifeffit/)
Patches are welcome.
Bruce Ravel (http://bruceravel.github.io/home)
http://bruceravel.github.io/demeter/
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.