SciSalt manual contents

• SciSalt User Manual
  • Introduction
    • Prerequisites
      • Python 3
      • HDF5 and h5py
      • NumPy and SciPy
      • PyQt4
    • Installation
      • From PyPI
      • From the tarball release
      • Installing the development version
  • Visualization
    • Matplotlib
      • Introduction
      • Recommended Setup
      • Creating Axes
        • Basic
        • Advanced
      • Plotting
        • Images
• SciSalt Reference
  • Visualization Modules
    • imageprocess
      • Conversion
        • scisalt.imageprocess.pdf2png
    • matplotlib
      • Setting Up
        • scisalt.matplotlib.setup_axes
        • scisalt.matplotlib.setup_figure
      • Plotting
        • scisalt.matplotlib.NonUniformImage
        • scisalt.matplotlib.NonUniformImage_axes
        • scisalt.matplotlib.addlabel
        • scisalt.matplotlib.axesfontsize
        • scisalt.matplotlib.colorbar
        • scisalt.matplotlib.contour
        • scisalt.matplotlib.figure
        • scisalt.matplotlib.hist
        • scisalt.matplotlib.hist2d
        • scisalt.matplotlib.imshow
        • scisalt.matplotlib.imshow_batch
        • scisalt.matplotlib.less_labels
        • scisalt.matplotlib.pcolor_axes
        • scisalt.matplotlib.plot
        • scisalt.matplotlib.plot_featured
        • scisalt.matplotlib.quiver
      • Interactive Plotting
        • scisalt.matplotlib.Imshow_Slider
          • scisalt.matplotlib.Imshow_Slider.AxesImage
          • scisalt.matplotlib.Imshow_Slider.ax
          • scisalt.matplotlib.Imshow_Slider.clim_max
          • scisalt.matplotlib.Imshow_Slider.clim_min
          • scisalt.matplotlib.Imshow_Slider.image
          • scisalt.matplotlib.Imshow_Slider.imgmax
          • scisalt.matplotlib.Imshow_Slider.imgmin
          • scisalt.matplotlib.Imshow_Slider.set_cmap
        • scisalt.matplotlib.Imshow_Slider_Array
          • scisalt.matplotlib.Imshow_Slider_Array.AxesImage
          • scisalt.matplotlib.Imshow_Slider_Array.ax
          • scisalt.matplotlib.Imshow_Slider_Array.clim_max
          • scisalt.matplotlib.Imshow_Slider_Array.clim_min
          • scisalt.matplotlib.Imshow_Slider_Array.image
          • scisalt.matplotlib.Imshow_Slider_Array.images
          • scisalt.matplotlib.Imshow_Slider_Array.imgmax
          • scisalt.matplotlib.Imshow_Slider_Array.imgmin
          • scisalt.matplotlib.Imshow_Slider_Array.num_imgs
          • scisalt.matplotlib.Imshow_Slider_Array.set_cmap
        • scisalt.matplotlib.RectangleSelector
          • scisalt.matplotlib.RectangleSelector.RectangleSelector
          • scisalt.matplotlib.RectangleSelector.ax
          • scisalt.matplotlib.RectangleSelector.eclick
          • scisalt.matplotlib.RectangleSelector.erelease
          • scisalt.matplotlib.RectangleSelector.height
          • scisalt.matplotlib.RectangleSelector.parent
          • scisalt.matplotlib.RectangleSelector.selfunc
          • scisalt.matplotlib.RectangleSelector.selfunc_results
          • scisalt.matplotlib.RectangleSelector.verbose
          • scisalt.matplotlib.RectangleSelector.width
          • scisalt.matplotlib.RectangleSelector.x0
          • scisalt.matplotlib.RectangleSelector.x1
          • scisalt.matplotlib.RectangleSelector.xslice
          • scisalt.matplotlib.RectangleSelector.y0
          • scisalt.matplotlib.RectangleSelector.y1
          • scisalt.matplotlib.RectangleSelector.yslice
      • Utilities
        • scisalt.matplotlib.rgb2gray
        • scisalt.matplotlib.savefig
        • scisalt.matplotlib.scaled_figsize
        • scisalt.matplotlib.showfig
  • Science Modules
    • PWFA
      • Beam Classes
        • scisalt.PWFA.RoundBeam
          • scisalt.PWFA.RoundBeam.E
          • scisalt.PWFA.RoundBeam.dE
          • scisalt.PWFA.RoundBeam.emit
          • scisalt.PWFA.RoundBeam.emit_n
          • scisalt.PWFA.RoundBeam.nb0
          • scisalt.PWFA.RoundBeam.s_r
        • scisalt.PWFA.EllipseBeam
          • scisalt.PWFA.EllipseBeam.E
          • scisalt.PWFA.EllipseBeam.alpha
          • scisalt.PWFA.EllipseBeam.beta
          • scisalt.PWFA.EllipseBeam.dE
          • scisalt.PWFA.EllipseBeam.emit
          • scisalt.PWFA.EllipseBeam.emit_n
          • scisalt.PWFA.EllipseBeam.nb0
          • scisalt.PWFA.EllipseBeam.sx
          • scisalt.PWFA.EllipseBeam.sxp
          • scisalt.PWFA.EllipseBeam.sxxp
          • scisalt.PWFA.EllipseBeam.set_Courant_Snyder
          • scisalt.PWFA.EllipseBeam.set_moments
        • scisalt.PWFA.GaussPartBeam
          • scisalt.PWFA.GaussPartBeam.E
          • scisalt.PWFA.GaussPartBeam.alpha
          • scisalt.PWFA.GaussPartBeam.beta
          • scisalt.PWFA.GaussPartBeam.cov
          • scisalt.PWFA.GaussPartBeam.delta
          • scisalt.PWFA.GaussPartBeam.emit
          • scisalt.PWFA.GaussPartBeam.mean
          • scisalt.PWFA.GaussPartBeam.nparts
          • scisalt.PWFA.GaussPartBeam.sig_delta
          • scisalt.PWFA.GaussPartBeam.x
          • scisalt.PWFA.GaussPartBeam.xp
      • Ion Classes
        • scisalt.PWFA.Ions1D
          • scisalt.PWFA.Ions1D.A
          • scisalt.PWFA.Ions1D.N_e
          • scisalt.PWFA.Ions1D.atol
          • scisalt.PWFA.Ions1D.dims
          • scisalt.PWFA.Ions1D.k
          • scisalt.PWFA.Ions1D.k_small
          • scisalt.PWFA.Ions1D.lambda_small
          • scisalt.PWFA.Ions1D.m
          • scisalt.PWFA.Ions1D.nb0
          • scisalt.PWFA.Ions1D.q_label
          • scisalt.PWFA.Ions1D.rtol
          • scisalt.PWFA.Ions1D.sig_x
          • scisalt.PWFA.Ions1D.sig_xi
          • scisalt.PWFA.Ions1D.sig_y
          • scisalt.PWFA.Ions1D.species
          • scisalt.PWFA.Ions1D.h
          • scisalt.PWFA.Ions1D.lambda_large
          • scisalt.PWFA.Ions1D.omega_big
          • scisalt.PWFA.Ions1D.q
        • scisalt.PWFA.Ions2D
          • scisalt.PWFA.Ions2D.A
          • scisalt.PWFA.Ions2D.N_e
          • scisalt.PWFA.Ions2D.atol
          • scisalt.PWFA.Ions2D.dims
          • scisalt.PWFA.Ions2D.k
          • scisalt.PWFA.Ions2D.k_small
          • scisalt.PWFA.Ions2D.lambda_small
          • scisalt.PWFA.Ions2D.m
          • scisalt.PWFA.Ions2D.nb0
          • scisalt.PWFA.Ions2D.q_label
          • scisalt.PWFA.Ions2D.rtol
          • scisalt.PWFA.Ions2D.sig_r
          • scisalt.PWFA.Ions2D.sig_xi
          • scisalt.PWFA.Ions2D.species
          • scisalt.PWFA.Ions2D.h
          • scisalt.PWFA.Ions2D.lambda_large
          • scisalt.PWFA.Ions2D.omega_big
          • scisalt.PWFA.Ions2D.q
          • scisalt.PWFA.Ions2D.r_large
          • scisalt.PWFA.Ions2D.r_small
      • Matching Classes
        • scisalt.PWFA.Match
          • scisalt.PWFA.Match.emit
          • scisalt.PWFA.Match.emit_n
          • scisalt.PWFA.Match.gamma
          • scisalt.PWFA.Match.sigma
          • scisalt.PWFA.Match.sigma_prime
          • scisalt.PWFA.Match.beta
        • scisalt.PWFA.MatchPlasma
          • scisalt.PWFA.MatchPlasma.beta
          • scisalt.PWFA.MatchPlasma.emit_n
          • scisalt.PWFA.MatchPlasma.gamma
          • scisalt.PWFA.MatchPlasma.n_p
          • scisalt.PWFA.MatchPlasma.n_p_cgs
          • scisalt.PWFA.MatchPlasma.plasma
      • Plasma Class
        • scisalt.PWFA.Plasma
          • scisalt.PWFA.Plasma.E_rest
          • scisalt.PWFA.Plasma.m
          • scisalt.PWFA.Plasma.n_p
          • scisalt.PWFA.Plasma.n_p_cgs
          • scisalt.PWFA.Plasma.species
          • scisalt.PWFA.Plasma.w_p
          • scisalt.PWFA.Plasma.k_ion
      • Simulation Classes
        • scisalt.PWFA.SimBeam
          • scisalt.PWFA.SimBeam.beam
          • scisalt.PWFA.SimBeam.beta
          • scisalt.PWFA.SimBeam.divsq
          • scisalt.PWFA.SimBeam.emit
          • scisalt.PWFA.SimBeam.phi
          • scisalt.PWFA.SimBeam.plas
          • scisalt.PWFA.SimBeam.s
          • scisalt.PWFA.SimBeam.spotsq
          • scisalt.PWFA.SimBeam.x
          • scisalt.PWFA.SimBeam.xp
          • scisalt.PWFA.SimBeam.xxp
          • scisalt.PWFA.SimBeam.ion_force
    • accelphys
      • Conversions
        • scisalt.accelphys.BDES2K
        • scisalt.accelphys.K2BDES
      • Fitting
        • scisalt.accelphys.fitimageslice
    • facettools
      • Elog
        • scisalt.facettools.print2elog
  • Programming Modules
    • logging
    • qt
      • Opening GUI Elements
      • Helper Objects
  • Utility Modules
    • utils
      • SSH
        • scisalt.utils.githubtunnel
      • Programming
        • scisalt.utils.progressbar
          • scisalt.utils.progressbar.step
    • h5
      • Exploration
        • scisalt.h5.keys
      • Extraction
        • scisalt.h5.get
  • Mathematics Modules
    • numpy
      • Functions
        • scisalt.numpy.gaussian
        • scisalt.numpy.frexp10
      • Vectors
        • scisalt.numpy.linspaceborders
        • scisalt.numpy.linspacestep
    • scipy
      • Fitting and Modeling
        • scisalt.scipy.GaussResults
          • scisalt.scipy.GaussResults.background
          • scisalt.scipy.GaussResults.chisq_red
          • scisalt.scipy.GaussResults.func
          • scisalt.scipy.GaussResults.p0
          • scisalt.scipy.GaussResults.pcov
          • scisalt.scipy.GaussResults.popt
          • scisalt.scipy.GaussResults.sigma_y
          • scisalt.scipy.GaussResults.use_error
          • scisalt.scipy.GaussResults.variance
          • scisalt.scipy.GaussResults.x
          • scisalt.scipy.GaussResults.y
          • scisalt.scipy.GaussResults.plot
        • scisalt.scipy.LinLsqFit
          • scisalt.scipy.LinLsqFit.X
          • scisalt.scipy.LinLsqFit.X_unweighted
          • scisalt.scipy.LinLsqFit.beta
          • scisalt.scipy.LinLsqFit.chisq_red
          • scisalt.scipy.LinLsqFit.covar
          • scisalt.scipy.LinLsqFit.y
          • scisalt.scipy.LinLsqFit.y_error
          • scisalt.scipy.LinLsqFit.y_fit
          • scisalt.scipy.LinLsqFit.y_unweighted
      • Statistics
        • scisalt.scipy.chisquare
        • scisalt.scipy.curve_fit_unscaled
      • Fourier Analysis
        • scisalt.scipy.fft
• Changelog
  • 1.7.1 (2015-11-24)
  • 1.7.0 (2015-11-24)
  • 1.6.0 (2015-08-31)
  • 1.5.0 (2015-08-31)
  • 1.4.4 (2015-08-10)
  • 1.4.3 (2015-08-05)
  • 1.4.0 (2015-07-31)
    • scisalt.accelphys
    • scisalt.logging
    • scisalt.matplotlib
    • scisalt.scipy
    • scisalt.utils
  • 1.3.0 (2015-07-22)
    • scisalt.matplotlib
    • scisalt.utils
  • 1.2.1 (2015-07-15)
  • 1.2.0 (2015-07-15)
    • scisalt.matplotlib
  • 1.1.1 (2015-07-12)
• Glossary
  • Jargon