NAME

Ifeffit::Demeter - OO interface to Ifeffit for plotting EXAFS data


VERSION

This documentation refers to Ifeffit::Demeter version 0.0.1


SYNOPSIS

  $plot_object = Ifeffit::Demeter::Plot -> new();
  $plot_object -> set({kweight=>3});


DESCRIPTION

This subclass of the Ifeffit::Demeter class is inteded to hold information pertaining to how plots of data and the components of a fit are made.


METHODS

start_plot

This method reinitializes a plot. In terms of Ifeffit, the next plot made after running this method will be a newplot(). Each subsequent plot until the next time start_plot is called will be a plot(). Also, the sequence of colors is reset when this method is called.

  $plotobject -> start_plot;
legend

This is a convenience method for controlling the appearence of the legend in the plot. This will set the legend parameters (key_x, key_y, and key_dy) and return the Ifeffit command to reset the legend.

  $command = $plotobject ->
     legend({key_x=>0.6, key_y=>0.8, key_dy=>0.05});
font

This is a convenience method for controlling the appearence of the text in the plot. This will set the text parameters (font and size) and return the Ifeffit command to reset the text.

  $command = $plotobject -> font({font=>4, size=>1.8})

The available fonts are: 1=sans serif, 2=roman, 3=italic, 4=script. If the font is not one of those numbers, it will fall back to 1. The size cannot be negative. Values larger than around 1.8 are allowed, but are probably a poor idea.


ATTRIBUTES

The following are the attributes of the Plot object. Attempting to access an attribute not on this list will throw an exception.

The type of argument expected in given in parentheses. i.e. number, integer, string, and so on. The default value, if one exists, is given in square brackets.

e_markers (boolean) [0]

If true, than markers will be plotted in energy as appropriate to indicate the positions of E0 and the boundaries of the pre- and post-edge resions.


DIAGNOSTICS

These messages are classified as follows (listed in increasing order of desperation):

    (W) A warning (optional).
    (F) A fatal error (trappable).
key_X must be a positive number

(W) You have tried to set one of the legend parameters to something that is not a positive number. It was reset to its default.

The font must be an integer from 1 to 4.

(W) There are only four types of fonts available and they are numbered 1 through 4. The font was reset to sans-serif, which is number 1.

The size must be a positive number

(W) You have tried to set the font size to something that is not a positive number. It was reset to size 1.2.


SERIALIZATION AND DESERIALIZATION

Describe serialize/deserialize methods

Dump/Load

freeze/thaw

describe file format


CONFIGURATION AND ENVIRONMENT

See the Ifeffit::Demeter manpage for a description of the configuration system.


DEPENDENCIES

See the Ifeffit::Demeter manpage for a list of dependencies.


BUGS AND LIMITATIONS

There are no known bugs in this module.

Please report problems to Bruce Ravel (bravel AT anl DOT gov)

Patches are welcome.


AUTHOR

Bruce Ravel (bravel AT anl DOT gov)

http://cars9.uchicago.edu/~ravel/software/


LICENCE AND COPYRIGHT

Copyright (c) 2006-2007 Bruce Ravel (bravel AT anl DOT gov). All rights reserved.

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

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.