neutronpy package

Members

data.data.Data([Q, h, k, l, e, temp, …])	Data class for handling multi-dimensional scattering data.
energy.Energy([energy, wavelength, …])	Class containing the most commonly used properties of a neutron beam given some initial input, e.g.
lsfit.Fitter(residuals[, derivatives, data, …])	Wrapper for LMFIT, which is a high-level extension for scipy.optimize.leastsq.
instrument.instrument.Instrument(*args, **kwargs)	An object that represents either a Triple Axis Spectrometer instrument or a Time of Flight Instrument configuration, including a sample.
crystal.lattice.Lattice(a, b, c, alpha, …)	Class to describe a generic lattice system defined by lattice six parameters, (three constants and three angles).
crystal.material.Material(crystal)	Class for the Material being supplied for the structure factor calculation
crystal.sample.Sample(a, b, c, alpha, beta, …)	Private class containing sample information.

Submodules

• neutronpy.constants module
  • neutronpy.constants.magnetic_ion_j
  • neutronpy.constants.periodic_table
  • neutronpy.constants.scattering_lengths
  • neutronpy.constants.symmetry
  • neutronpy.constants.JOULES_TO_MEV
  • neutronpy.constants.BOLTZMANN_IN_MEV_K
  • neutronpy.constants.N_A
• neutronpy.crystal module
  • neutronpy.crystal.Lattice
    • neutronpy.crystal.Lattice.get_d_spacing
    • neutronpy.crystal.Lattice.get_q
    • neutronpy.crystal.Lattice.get_two_theta
    • neutronpy.crystal.Lattice.get_angle_between_planes
  • neutronpy.crystal.MagneticFormFactor
    • neutronpy.crystal.MagneticFormFactor.calc_mag_form_fac
  • neutronpy.crystal.Material
    • neutronpy.crystal.Material.calc_nuc_str_fac
    • neutronpy.crystal.Material.calc_mag_str_fac
    • neutronpy.crystal.Material.calc_mag_int_vec
    • neutronpy.crystal.Material.calc_incoh_elas_xs
    • neutronpy.crystal.Material.calc_optimal_thickness
    • neutronpy.crystal.Material.plot_unit_cell
    • neutronpy.crystal.Material.get_angle_between_planes
    • neutronpy.crystal.Material.get_d_spacing
    • neutronpy.crystal.Material.get_q
    • neutronpy.crystal.Material.get_two_theta
    • neutronpy.crystal.Material.get_phi
    • neutronpy.crystal.Material.N_atoms
  • neutronpy.crystal.NuclearStructureFactor
    • neutronpy.crystal.NuclearStructureFactor.calc_nuc_str_fac
  • neutronpy.crystal.Sample
    • neutronpy.crystal.Sample.get_d_spacing
    • neutronpy.crystal.Sample.get_q
    • neutronpy.crystal.Sample.get_two_theta
    • neutronpy.crystal.Sample.get_angle_between_planes
    • neutronpy.crystal.Sample.get_phi
  • neutronpy.crystal.SpaceGroup
    • neutronpy.crystal.SpaceGroup.symmetrize_position
• neutronpy.data module
  • neutronpy.data.Data
    • neutronpy.data.Data.bin
    • neutronpy.data.Data.combine_data
    • neutronpy.data.Data.subtract_background
    • neutronpy.data.Data.integrate
    • neutronpy.data.Data.position
    • neutronpy.data.Data.width
    • neutronpy.data.Data.estimate_background
    • neutronpy.data.Data.subtract_background
    • neutronpy.data.Data.dynamic_susceptibility
    • neutronpy.data.Data.scattering_function
    • neutronpy.data.Data.plot
    • neutronpy.data.Data.plot_volume
    • neutronpy.data.Data.plot_contour
    • neutronpy.data.Data.plot_line
    • neutronpy.data.Data.get_keys
    • neutronpy.data.Data.get_bounds
  • neutronpy.data.Analysis
    • neutronpy.data.Analysis.integrate
    • neutronpy.data.Analysis.position
    • neutronpy.data.Analysis.width
    • neutronpy.data.Analysis.scattering_function
    • neutronpy.data.Analysis.dynamic_susceptibility
    • neutronpy.data.Analysis.estimate_background
    • neutronpy.data.Analysis.get_keys
    • neutronpy.data.Analysis.get_bounds
  • neutronpy.data.PlotData
    • neutronpy.data.PlotData.plot
    • neutronpy.data.PlotData.plot_line
    • neutronpy.data.PlotData.plot_contour
    • neutronpy.data.PlotData.plot_volume
  • neutronpy.data.Scans
    • neutronpy.data.Scans.waterfall
    • neutronpy.data.Scans.pcolor
    • neutronpy.data.Scans.func_col
    • neutronpy.data.Scans.min_col
    • neutronpy.data.Scans.max_col
    • neutronpy.data.Scans.mean_col
    • neutronpy.data.Scans.update
    • neutronpy.data.Scans.scans_check
• neutronpy.energy module
  • neutronpy.energy.Energy
• neutronpy.fileio module
  • neutronpy.fileio.detect_filetype
  • neutronpy.fileio.load_data
  • neutronpy.fileio.load_instrument
  • neutronpy.fileio.save_data
• neutronpy.functions module
  • neutronpy.functions.gaussian
  • neutronpy.functions.gaussian2d
  • neutronpy.functions.lorentzian
  • neutronpy.functions.voigt
  • neutronpy.functions.resolution
  • neutronpy.functions.gaussian_ring
• neutronpy.gui module
  • neutronpy.gui.launch
• neutronpy.instrument module
  • neutronpy.instrument.Instrument
  • neutronpy.instrument.TripleAxisInstrument
    • neutronpy.instrument.TripleAxisInstrument.calc_resolution
    • neutronpy.instrument.TripleAxisInstrument.calc_resolution_in_Q_coords
    • neutronpy.instrument.TripleAxisInstrument.calc_projections
    • neutronpy.instrument.TripleAxisInstrument.get_angles_and_Q
    • neutronpy.instrument.TripleAxisInstrument.get_lattice
    • neutronpy.instrument.TripleAxisInstrument.get_resolution_params
    • neutronpy.instrument.TripleAxisInstrument.get_resolution
    • neutronpy.instrument.TripleAxisInstrument.plot_projections
    • neutronpy.instrument.TripleAxisInstrument.plot_ellipsoid
    • neutronpy.instrument.TripleAxisInstrument.plot_instrument
    • neutronpy.instrument.TripleAxisInstrument.resolution_convolution
    • neutronpy.instrument.TripleAxisInstrument.resolution_convolution_SMA
    • neutronpy.instrument.TripleAxisInstrument.plot_slice
  • neutronpy.instrument.TimeOfFlightInstrument
    • neutronpy.instrument.TimeOfFlightInstrument.calc_resolution
    • neutronpy.instrument.TimeOfFlightInstrument.calc_resolution_in_Q_coords
    • neutronpy.instrument.TimeOfFlightInstrument.calc_projections
    • neutronpy.instrument.TimeOfFlightInstrument.get_resolution_params
    • neutronpy.instrument.TimeOfFlightInstrument.get_resolution
    • neutronpy.instrument.TimeOfFlightInstrument.plot_projections
    • neutronpy.instrument.TimeOfFlightInstrument.plot_ellipsoid
    • neutronpy.instrument.TimeOfFlightInstrument.plot_instrument
    • neutronpy.instrument.TimeOfFlightInstrument.plot_slice
  • neutronpy.instrument.GeneralInstrument
    • neutronpy.instrument.GeneralInstrument.calc_projections
    • neutronpy.instrument.GeneralInstrument.get_resolution_params
    • neutronpy.instrument.GeneralInstrument.get_resolution
  • neutronpy.instrument.PlotInstrument
    • neutronpy.instrument.PlotInstrument.plot_projections
    • neutronpy.instrument.PlotInstrument.plot_ellipsoid
    • neutronpy.instrument.PlotInstrument.plot_instrument
    • neutronpy.instrument.PlotInstrument.plot_slice
  • neutronpy.instrument.Monochromator
  • neutronpy.instrument.Analyzer
  • neutronpy.instrument.Chopper
  • neutronpy.instrument.Guide
  • neutronpy.instrument.Detector
  • neutronpy.instrument.Goniometer
    • neutronpy.instrument.Goniometer.u_phi
  • neutronpy.instrument.GetTau
  • neutronpy.instrument.get_angle_ki_Q
  • neutronpy.instrument.get_kfree
  • neutronpy.instrument.chop
  • neutronpy.instrument.get_bragg_widths
• neutronpy.lsfit module
  • neutronpy.lsfit.Fitter
    • neutronpy.lsfit.Fitter.fit
    • neutronpy.lsfit.Fitter.plot
    • neutronpy.lsfit.Fitter.build_param_table
    • neutronpy.lsfit.Fitter.__call__
• neutronpy.models module
  • neutronpy.models.simple_harmonic_oscillator
  • neutronpy.models.damped_harmonic_oscillator
  • neutronpy.models.acoustic_phonon_dispersion
  • neutronpy.models.ferromagnetic_disperion
  • neutronpy.models.antiferromagnetic_disperion
• neutronpy.spurion module
  • neutronpy.spurion.aluminum

Module contents

NeutronPy: open source python library for neutron scattering data analysis