neutronpy.instrument.instrument.Instrument

class neutronpy.instrument.instrument.Instrument(*args, **kwargs)[source]

An object that represents either a Triple Axis Spectrometer instrument or a Time of Flight Instrument configuration, including a sample.

Parameters:
args : arg, optional

Any valid positional arguments for the desired instrument class

instrument_type : str, optional

Used to select Triple Axis instrument ‘tas’ or time of flight instrument ‘tof’. Default: ‘tas’

engine : str, optional

Used to select the engine for resolution calculations. Default: ‘neutronpy’ for ‘tas’ instruments, and ‘takin’ for ‘tof’ instruments.

kwargs : kwarg, optional

Any valid keyword arguments for the desired instrument class