NAME

PDL::Modules - A guide to PDL's module reference.

DESCRIPTION

This page serves as a table of contents for PDL's module documentation. This page does not list every single PDL module. It only shows the ones intended for PDL users, while omitting those which are deemed "for internal use only". If you wish to see a comprehensive list of all documentation, please see the PDL::Index page.

LOOKING FOR A FUNCTION?

If you want to search for a function name, you should use the PDL shell along with the "help" or "apropos" command (to do a fuzzy search). For example:

pdl> apropos xval
xlinvals        X axis values between endpoints (see xvals).
xlogvals        X axis values logarithmicly spaced...
xvals           Fills an ndarray with X index values...
yvals           Fills an ndarray with Y index values. See the CAVEAT for xvals.
zvals           Fills an ndarray with Z index values. See the CAVEAT for xvals.

To learn more about the PDL shell, see perldl or pdl2.

FOUNDATION

perldl or pdl2: Learn about the PDL shell.

Functions

PDL::Core: Core module (e.g. creating ndarrays).
PDL::Basic: Simplified interface to the more general PDL::Primitive.
PDL::Ops: Basic operators (e.g. arithmetic, comparisons, etc.).
PDL::Ufunc: Functions that accumulate along a dimension (e.g. sum, max).

Other Features

PDL::AutoLoader: MATLAB-style function autoloader.
PDL::Slices: Indexing and slices. How to access a subset of an ndarray.
PDL::NiceSlice: Nicer syntax for slices.

MISCELLANEOUS

PDL::Primitive: Fundamental operations on ndarrays.
PDL::Bad: Bad value support.
PDL::Reduce: A 'reduce' function for PDL.
PDL::Lite: Minimum PDL module OO loader.
PDL::LiteF: Minimum PDL module function loader.
PDL::Extended: Extended Mathematical Operators.
PDL::Func: Interpolation-related functions.

GRAPHICS

PDL::Graphics::PGPLOT: PGPLOT library.
PDL::Graphics::PLplot: PLplot library.

3D Graphics

PDL::Graphics::TriD: 3D graphics core module.
PDL::Graphics::TriD::Rout: Helper routines for 3D graphics.
PDL::Graphics::TriD::Contours: 3D surface contours.

Helper Modules

PDL::Graphics::LUT: Look-up tables.
PDL::Graphics::IIS: Display images on IIS devices.
PDL::Graphics::Limits: Derive data limits for display purposes.

IMAGE PROCESSING

PDL::Compression: Compression utilities.
PDL::Image2D: 2-dimensional image processing.
PDL::ImageND: N-dimensional image processing.
PDL::ImageRGB: RGB image data handling.

NUMERICAL METHODS

PDL::FFT: Fast Fourier Transform (native implementation).
PDL::FFTW: PDL interface to the FFTW library.
PDL::Filter::LinPred: Linear predictive filtering.
PDL::Filter::Linear: Linear filtering.
PDL::Opt::Simplex: Simplex optimization routines.
PDL::Minuit: PDL interface to the Minuit library.
PDL::Slatec: PDL interface to the Slatec library.

COORDINATE TRANSFORMATIONS

PDL::Transform: Coordinate transforms, image warping, and N-D functions.
PDL::Transform::Cartography: Cartographic projections.
PDL::Transform::Proj4: PDL interface to the Proj4 projection library.

IO FUNCTIONS

PDL::IO: Overview of IO functions.
PDL::IO::Dumper: Data dumper.
PDL::IO::FastRaw: Fast storage format (outdated).
PDL::IO::FlexRaw: Flexible storage format.
PDL::IO::Rout: Misc IO routines.
PDL::IO::Sortable: Support for Perl's 'Storable' module.

Image Formats

PDL::IO::FITS: PDL support for FITS images.
PDL::IO::PNM: PDL support for PNM images.
PDL::IO::GD: PDL interface to the GD image library.
PDL::IO::HDF: PDL interface to the HDH4 image library.
PDL::IO::NetPBM: PDL interface to the NetPBM image library.
PDL::IO::NDF: PDL interface to the Starlink image library. Available as a separate CPAN download.

2D MATRICES

PDL::Matrix: Convenience class for 2D matrix work.
PDL::MatrixOps: Additional matrix operators.

GNU SCIENTIFIC LIBRARY

PDL::GSL::DIFF: Numerical differentiation.
PDL::GSL::INTEG: Numerical integration.
PDL::GSL::INTERP: Interpolation.
PDL::GSL::MROOT: Multidimensional root-finding.
PDL::GSL::RNG: RNG and randist.

Special Functions

PDL::GSLSF::AIRY
PDL::GSLSF::BESSEL
PDL::GSLSF::CLAUSEN
PDL::GSLSF::COULOMB
PDL::GSLSF::COUPLING
PDL::GSLSF::DAWSON
PDL::GSLSF::DEBYE
PDL::GSLSF::DILOG
PDL::GSLSF::ELEMENTARY
PDL::GSLSF::ELLINT
PDL::GSLSF::ELLJAC
PDL::GSLSF::ERF
PDL::GSLSF::EXP
PDL::GSLSF::EXPINT
PDL::GSLSF::FERMI_DIRAC
PDL::GSLSF::GAMMA
PDL::GSLSF::GEGENBAUER
PDL::GSLSF::HYPERG
PDL::GSLSF::LAGUERRE
PDL::GSLSF::LEGENDRE
PDL::GSLSF::LOG
PDL::GSLSF::POLY
PDL::GSLSF::POW_INT
PDL::GSLSF::PSI
PDL::GSLSF::SYNCHROTRON
PDL::GSLSF::TRANSPORT
PDL::GSLSF::TRIG
PDL::GSLSF::ZETA

FITTING FUNCTIONS

PDL::Fit::Gaussian: Fit gaussian curves.
PDL::Fit::Polynomial: Fit polynomials.
PDL::Fit::Linfit: Fit linear combinations of functions.
PDL::Fit::LM: Fit functions using the Levenberg-Marquardt algorithm.

ADVANCED

PDL::Dbg: PDL debugger.
PDL::DiskCache: Manage many ndarrays through a disk cache.
PDL::CallExt: Call external functions.
PDL::Objects: If you want to sub-class from PDL (note: incomplete).

COPYRIGHT

See: http://dev.perl.org/licenses/

To install PDL, copy and paste the appropriate command in to your terminal.

cpanm

cpanm PDL

CPAN shell

perl -MCPAN -e shell
install PDL

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)