Permalink
Browse files

document the Laser object

  • Loading branch information...
1 parent da20f35 commit ee5d67b5fd04cea26c2bc84c0f246e6365042afb @jberger committed Nov 19, 2012
Showing with 45 additions and 1 deletion.
  1. +45 −1 lib/Physics/UEMColumn/Laser.pm
@@ -24,4 +24,48 @@ Physics::UEMColumn::Laser
use Physics::UEMColumn alias => ':standard';
- my $laser = Laser->new()
+ my $laser = Laser->new(
+ energy => '4.75 eV',
+ width => '500 um',
+ duration => '4 ps',
+ );
+
+=head1 DESCRIPTION
+
+L<Physics::UEMColumn::Laser> is a class representing a laser object for L<Physics::UEMColumn>. L<Physics::UEMColumn::Column> objects need a laser object in order to be able create a L<Physics::UEMColumn::Pulse> object.
+
+=head1 ATTRIBUTES
+
+=over
+
+=item C<energy>
+
+A number representing the photon energy of the laser. Unit: J
+
+=item C<width>
+
+A number representing the HW1/eM Gaussian beam width of the laser (at the photocathode). Unit: m
+
+=item C<duration>
+
+A number representing the pulse duration of the laser (at the photocathode). Unit: s
+
+=back
+
+=head1 SOURCE REPOSITORY
+
+L<http://github.com/jberger/Physics-UEMColumn>
+
+=head1 AUTHOR
+
+Joel Berger, E<lt>joel.a.berger@gmail.comE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2012 by Joel Berger
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+
+

0 comments on commit ee5d67b

Please sign in to comment.