Skip to content

Latest commit

 

History

History
59 lines (31 loc) · 1.36 KB

README.pod

File metadata and controls

59 lines (31 loc) · 1.36 KB

NAME

PDL::SampleData - Easy access to data used in the PDL examples and the PDL::Book.

SYNOPSIS

use PDL::ShareDir ':all';
my $file = get_file('m51.fits');
my $pdl = get_pdl('m51.fits');

DESCRIPTION

PDL::SampleData allows easy access to the data needed to follow along with the examples and the PDL::Book.

FUNCTIONS

Nothing is exported by default. Any of the following functions may be explicitly imported, or import them all with the tag :all.

get_file( filename )

Takes the name (with extension) of the file requested. On success it returns the absolute path to the file requested. On failure a warning is issued and undef is returned.

get_pdl( filename )

Takes the name (with extension) of the file requested. On success it returns the data as a PDL object. On failure a warning is issued and a undef is returned.

sample_files()

Takes no arguments, returns the sample data files that are available by using get_*.

SEE ALSO

SOURCE REPOSITORY

http://github.com/PDLPorters/PDL-SampleData

AUTHOR

Joel Berger, <joel.a.berger@gmail.com>

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.