neutronpy.energy.Energy

class neutronpy.energy.Energy(energy=None, wavelength=None, velocity=None, wavevector=None, temperature=None, frequency=None)[source]

Class containing the most commonly used properties of a neutron beam given some initial input, e.g. energy, wavelength, velocity, wavevector, temperature, or frequency. At least one input must be supplied.

Parameters:
energy : float

Neutron energy in millielectron volts (meV)

wavelength : float

Neutron wavelength in angstroms (Å)

velocity : float

Neutron velocity in meters per second (m/s)

wavevector : float

Neutron wavevector k in inverse angstroms (1/Å)

temperature : float

Neutron temperature in kelvin (K)

frequency : float

Neutron frequency in terahertz (THz)

Returns:
Energy object

The energy object containing the properties of the neutron beam

Attributes:
energy

Energy of the neutron in meV

wavelength

Wavelength of the neutron in Å

wavevector

Wavevector k of the neutron in 1/Å

velocity

Velocity of the neutron in m/s

temperature

Temperature of the neutron in Kelvin

frequency

Frequency of the neutron in THz

values

Prints all of the properties of the Neutron beam