Physics::UEMColumn::Element - Base class for "optical" elements in a UEM system
package Physics::UEMColumn::MyElement; use Moose; extends 'Physics::UEMColumn::Element';
Physics::UEMColumn::Element is a base class for "optical" elements in a UEM system. Mostly it defines the physical bounds of the element. All objects passed to Physics::UEMColumn::Column via add_element must be subclasses of this base.
add_element
location
The position of the center of the element in the column. Unit: m
length
The full effective length of the element. "Effective" here means the size that the pulse sees; e.g. the length of the pole piece gap of a magnetic lens. Unit: m
cutoff
A number representing the number of lengths away from the the center of the element before the element may be safely ignored. The default is 3.
3
effect
Returns a hash reference of subroutine references defining the effect that the element has on a pulse's width (M_t), length (M_z) and velocity (acc_z). These subroutine references expect arguments of time, pulse position and pulse velocity (t, z, v), they return a number quantifying this effect. The base class simply returns an empty hash reference. This method is intended to be redefined on subclassing.
M_t
M_z
acc_z
t
z
v
http://github.com/jberger/Physics-UEMColumn
Joel Berger, <joel.a.berger@gmail.com>
Copyright (C) 2012-2013 by Joel Berger
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Physics::UEMColumn, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Physics::UEMColumn
CPAN shell
perl -MCPAN -e shell install Physics::UEMColumn
For more information on module installation, please visit the detailed CPAN module installation guide.