.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "MODULES 1p"
.TH MODULES 1p 2024-02-05 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
PDL::Modules \- A guide to PDL's module reference.
.SH DESCRIPTION
.IX Header "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.
.SH "LOOKING FOR A FUNCTION?"
.IX Header "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:
.PP
.Vb 6
\& 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.
.Ve
.PP
To learn more about the PDL shell, see perldl or pdl2.
.SH FOUNDATION
.IX Header "FOUNDATION"
.IP "perldl or pdl2" 5
.IX Item "perldl or pdl2"
Learn about the PDL shell.
.SS Functions
.IX Subsection "Functions"
.IP PDL::Core 5
.IX Item "PDL::Core"
Core module (e.g. creating ndarrays).
.IP PDL::Basic 5
.IX Item "PDL::Basic"
Simplified interface to the more general PDL::Primitive.
.IP PDL::Ops 5
.IX Item "PDL::Ops"
Basic operators (e.g. arithmetic, comparisons, etc.).
.IP PDL::Ufunc 5
.IX Item "PDL::Ufunc"
Functions that accumulate along a dimension (e.g. sum, max).
.SS "Other Features"
.IX Subsection "Other Features"
.IP PDL::AutoLoader 5
.IX Item "PDL::AutoLoader"
MATLAB-style function autoloader.
.IP PDL::Slices 5
.IX Item "PDL::Slices"
Indexing and slices. How to access a subset of an ndarray.
.IP PDL::NiceSlice 5
.IX Item "PDL::NiceSlice"
Nicer syntax for slices.
.SH MISCELLANEOUS
.IX Header "MISCELLANEOUS"
.IP PDL::Primitive 5
.IX Item "PDL::Primitive"
Fundamental operations on ndarrays.
.IP PDL::Bad 5
.IX Item "PDL::Bad"
Bad value support.
.IP PDL::Reduce 5
.IX Item "PDL::Reduce"
A 'reduce' function for PDL.
.IP PDL::Lite 5
.IX Item "PDL::Lite"
Minimum PDL module OO loader.
.IP PDL::LiteF 5
.IX Item "PDL::LiteF"
Minimum PDL module function loader.
.IP PDL::Extended 5
.IX Item "PDL::Extended"
Extended Mathematical Operators.
.IP PDL::Func 5
.IX Item "PDL::Func"
Interpolation-related functions.
.SH GRAPHICS
.IX Header "GRAPHICS"
.IP PDL::Graphics::PGPLOT 5
.IX Item "PDL::Graphics::PGPLOT"
PGPLOT library.
.IP PDL::Graphics::PLplot 5
.IX Item "PDL::Graphics::PLplot"
PLplot library.
.SS "3D Graphics"
.IX Subsection "3D Graphics"
.IP PDL::Graphics::TriD 5
.IX Item "PDL::Graphics::TriD"
3D graphics core module.
.IP PDL::Graphics::TriD::Rout 5
.IX Item "PDL::Graphics::TriD::Rout"
Helper routines for 3D graphics.
.IP PDL::Graphics::TriD::Contours 5
.IX Item "PDL::Graphics::TriD::Contours"
3D surface contours.
.SS "Helper Modules"
.IX Subsection "Helper Modules"
.IP PDL::Graphics::LUT 5
.IX Item "PDL::Graphics::LUT"
Look-up tables.
.IP PDL::Graphics::IIS 5
.IX Item "PDL::Graphics::IIS"
Display images on IIS devices.
.IP PDL::Graphics::Limits 5
.IX Item "PDL::Graphics::Limits"
Derive data limits for display purposes.
.SH "IMAGE PROCESSING"
.IX Header "IMAGE PROCESSING"
.IP PDL::Compression 5
.IX Item "PDL::Compression"
Compression utilities.
.IP PDL::Image2D 5
.IX Item "PDL::Image2D"
2\-dimensional image processing.
.IP PDL::ImageND 5
.IX Item "PDL::ImageND"
N\-dimensional image processing.
.IP PDL::ImageRGB 5
.IX Item "PDL::ImageRGB"
RGB image data handling.
.SH "NUMERICAL METHODS"
.IX Header "NUMERICAL METHODS"
.IP PDL::FFT 5
.IX Item "PDL::FFT"
Fast Fourier Transform (native implementation).
.IP PDL::FFTW 5
.IX Item "PDL::FFTW"
PDL interface to the FFTW library.
.IP PDL::Filter::LinPred 5
.IX Item "PDL::Filter::LinPred"
Linear predictive filtering.
.IP PDL::Filter::Linear 5
.IX Item "PDL::Filter::Linear"
Linear filtering.
.IP PDL::Opt::Simplex 5
.IX Item "PDL::Opt::Simplex"
Simplex optimization routines.
.IP PDL::Minuit 5
.IX Item "PDL::Minuit"
PDL interface to the Minuit library.
.IP PDL::Slatec 5
.IX Item "PDL::Slatec"
PDL interface to the Slatec library.
.SH "COORDINATE TRANSFORMATIONS"
.IX Header "COORDINATE TRANSFORMATIONS"
.IP PDL::Transform 5
.IX Item "PDL::Transform"
Coordinate transforms, image warping, and N\-D functions.
.IP PDL::Transform::Cartography 5
.IX Item "PDL::Transform::Cartography"
Cartographic projections.
.IP PDL::Transform::Proj4 5
.IX Item "PDL::Transform::Proj4"
PDL interface to the Proj4 projection library.
.SH "IO FUNCTIONS"
.IX Header "IO FUNCTIONS"
.IP PDL::IO 5
.IX Item "PDL::IO"
Overview of IO functions.
.IP PDL::IO::Dumper 5
.IX Item "PDL::IO::Dumper"
Data dumper.
.IP PDL::IO::FastRaw 5
.IX Item "PDL::IO::FastRaw"
Fast storage format (outdated).
.IP PDL::IO::FlexRaw 5
.IX Item "PDL::IO::FlexRaw"
Flexible storage format.
.IP PDL::IO::Rout 5
.IX Item "PDL::IO::Rout"
Misc IO routines.
.IP PDL::IO::Sortable 5
.IX Item "PDL::IO::Sortable"
Support for Perl's 'Storable' module.
.SS "Image Formats"
.IX Subsection "Image Formats"
.IP PDL::IO::FITS 5
.IX Item "PDL::IO::FITS"
PDL support for FITS images.
.IP PDL::IO::PNM 5
.IX Item "PDL::IO::PNM"
PDL support for PNM images.
.IP PDL::IO::GD 5
.IX Item "PDL::IO::GD"
PDL interface to the GD image library.
.IP PDL::IO::HDF 5
.IX Item "PDL::IO::HDF"
PDL interface to the HDH4 image library.
.IP PDL::IO::NetPBM 5
.IX Item "PDL::IO::NetPBM"
PDL interface to the NetPBM image library.
.IP PDL::IO::NDF 5
.IX Item "PDL::IO::NDF"
PDL interface to the Starlink image library. Available
as a separate CPAN download.
.SH "2D MATRICES"
.IX Header "2D MATRICES"
.IP PDL::Matrix 5
.IX Item "PDL::Matrix"
Convenience class for 2D matrix work.
.IP PDL::MatrixOps 5
.IX Item "PDL::MatrixOps"
Additional matrix operators.
.SH "GNU SCIENTIFIC LIBRARY"
.IX Header "GNU SCIENTIFIC LIBRARY"
.IP PDL::GSL::DIFF 5
.IX Item "PDL::GSL::DIFF"
Numerical differentiation.
.IP PDL::GSL::INTEG 5
.IX Item "PDL::GSL::INTEG"
Numerical integration.
.IP PDL::GSL::INTERP 5
.IX Item "PDL::GSL::INTERP"
Interpolation.
.IP PDL::GSL::MROOT 5
.IX Item "PDL::GSL::MROOT"
Multidimensional root-finding.
.IP PDL::GSL::RNG 5
.IX Item "PDL::GSL::RNG"
RNG and randist.
.SS "Special Functions"
.IX Subsection "Special Functions"
.IP PDL::GSLSF::AIRY 5
.IX Item "PDL::GSLSF::AIRY"
.PD 0
.IP PDL::GSLSF::BESSEL 5
.IX Item "PDL::GSLSF::BESSEL"
.IP PDL::GSLSF::CLAUSEN 5
.IX Item "PDL::GSLSF::CLAUSEN"
.IP PDL::GSLSF::COULOMB 5
.IX Item "PDL::GSLSF::COULOMB"
.IP PDL::GSLSF::COUPLING 5
.IX Item "PDL::GSLSF::COUPLING"
.IP PDL::GSLSF::DAWSON 5
.IX Item "PDL::GSLSF::DAWSON"
.IP PDL::GSLSF::DEBYE 5
.IX Item "PDL::GSLSF::DEBYE"
.IP PDL::GSLSF::DILOG 5
.IX Item "PDL::GSLSF::DILOG"
.IP PDL::GSLSF::ELEMENTARY 5
.IX Item "PDL::GSLSF::ELEMENTARY"
.IP PDL::GSLSF::ELLINT 5
.IX Item "PDL::GSLSF::ELLINT"
.IP PDL::GSLSF::ELLJAC 5
.IX Item "PDL::GSLSF::ELLJAC"
.IP PDL::GSLSF::ERF 5
.IX Item "PDL::GSLSF::ERF"
.IP PDL::GSLSF::EXP 5
.IX Item "PDL::GSLSF::EXP"
.IP PDL::GSLSF::EXPINT 5
.IX Item "PDL::GSLSF::EXPINT"
.IP PDL::GSLSF::FERMI_DIRAC 5
.IX Item "PDL::GSLSF::FERMI_DIRAC"
.IP PDL::GSLSF::GAMMA 5
.IX Item "PDL::GSLSF::GAMMA"
.IP PDL::GSLSF::GEGENBAUER 5
.IX Item "PDL::GSLSF::GEGENBAUER"
.IP PDL::GSLSF::HYPERG 5
.IX Item "PDL::GSLSF::HYPERG"
.IP PDL::GSLSF::LAGUERRE 5
.IX Item "PDL::GSLSF::LAGUERRE"
.IP PDL::GSLSF::LEGENDRE 5
.IX Item "PDL::GSLSF::LEGENDRE"
.IP PDL::GSLSF::LOG 5
.IX Item "PDL::GSLSF::LOG"
.IP PDL::GSLSF::POLY 5
.IX Item "PDL::GSLSF::POLY"
.IP PDL::GSLSF::POW_INT 5
.IX Item "PDL::GSLSF::POW_INT"
.IP PDL::GSLSF::PSI 5
.IX Item "PDL::GSLSF::PSI"
.IP PDL::GSLSF::SYNCHROTRON 5
.IX Item "PDL::GSLSF::SYNCHROTRON"
.IP PDL::GSLSF::TRANSPORT 5
.IX Item "PDL::GSLSF::TRANSPORT"
.IP PDL::GSLSF::TRIG 5
.IX Item "PDL::GSLSF::TRIG"
.IP PDL::GSLSF::ZETA 5
.IX Item "PDL::GSLSF::ZETA"
.PD
.SH "FITTING FUNCTIONS"
.IX Header "FITTING FUNCTIONS"
.IP PDL::Fit::Gaussian 5
.IX Item "PDL::Fit::Gaussian"
Fit gaussian curves.
.IP PDL::Fit::Polynomial 5
.IX Item "PDL::Fit::Polynomial"
Fit polynomials.
.IP PDL::Fit::Linfit 5
.IX Item "PDL::Fit::Linfit"
Fit linear combinations of functions.
.IP PDL::Fit::LM 5
.IX Item "PDL::Fit::LM"
Fit functions using the Levenberg-Marquardt algorithm.
.SH ADVANCED
.IX Header "ADVANCED"
.IP PDL::Dbg 5
.IX Item "PDL::Dbg"
PDL debugger.
.IP PDL::DiskCache 5
.IX Item "PDL::DiskCache"
Manage many ndarrays through a disk cache.
.IP PDL::CallExt 5
.IX Item "PDL::CallExt"
Call external functions.
.IP PDL::Objects 5
.IX Item "PDL::Objects"
If you want to sub-class from PDL (note: incomplete).
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2010 Daniel Carrera (dcarrera@gmail.com). You can distribute
and/or modify this document under the same terms as the current Perl
license.
.PP
See: http://dev.perl.org/licenses/