• NAME
• VERSION
• SYNOPSIS
• DESCRIPTION
• ATTRIBUTES
• METHODS
• SERIALIZATION AND DESERIALIZATION
• CONFIGURATION AND ENVIRONMENT
• DEPENDENCIES
• BUGS AND LIMITATIONS
• AUTHOR
• LICENCE AND COPYRIGHT

NAME

Demeter::Diff - Difference spectra

VERSION

This documentation refers to Demeter version 0.9.26.

SYNOPSIS

  my $prj = Demeter::Data::Prj->new(file=>'athena.prj');
  my $stan = $prj->record(1);
  my $data = $prj->record(2);
  my $diff = Demeter::Diff->new(data=>$data, standard=>$stan);
  $diff->diff;
  $diff->plot;
  $diff->pause;

DESCRIPTION

Compute the difference spectrum between two Demeter::Data objects and compute the integrated area of a region of the difference spectrum.

ATTRIBUTES

data

The Data group from which this difference spectrum is made.

standard

The Data group subtracted from the data.

xmin

The lower bound of the integration range. For a difference in energy, this number is relative to E0.

xmax

The upper bound of the integration range. For a difference in energy, this number is relative to E0.

invert

When true, swap the data and standard when calculating the difference spectrum.

plotspectra

When true, include the data and standard in the plot when calling the plot method.

area

After the difference is made, the integrated area between xmin and xmax will be stored in this attribute.

METHODS

diff

Compute the difference spectrum and integrated area.

  $diff_object -> diff;

plot

Make a plot of the difference spectrum.

  $diff_object -> plot;

make_name

A method for dynamically generating the name attribute of the Data object made from the Diff object.

  d = name of data
  s = name of standard
  f = the form of the data from which the difference is made
  n = the xmin value
  x = the xmax value
  a = the integrated are
  % = a literal % sign

The default value is diff %d - %s, which expands into something like

   diff dataname - standardname

SERIALIZATION AND DESERIALIZATION

Good question ...

CONFIGURATION AND ENVIRONMENT

See Demeter::Config for a description of the configuration system. See the lcf configuration group for the relevant parameters.

DEPENDENCIES

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

BUGS AND LIMITATIONS

• Need better error checking

• Difference spectra of things other than norm(E); space attribute

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.