IPeak¶

This a python binding to the C++ class Mantid::API::IPeak.

class mantid.api.IPeak¶

__init__()¶

Raises an exception This class cannot be instantiated from Python

findDetector((IPeak)self) → bool :¶

Using the instrument set in the peak, perform ray tracing to find the exact detector.

getBinCount((IPeak)self) → float :¶

Return the # of counts in the bin at its peak

getCol((IPeak)self) → int :¶

For RectangularDetectors only, returns the column (x) of the pixel of the detector.

getDSpacing((IPeak)self) → float :¶

Calculate the d-spacing of the peak, in 1/Angstroms

getDetPos((IPeak)self) → V3D :¶

Return the detector position vector

getDetectorID((IPeak)self) → int :¶

Get the ID of the detector at the center of the peak

getFinalEnergy((IPeak)self) → float :¶

Get the final neutron energy

getH((IPeak)self) → float :¶

Get the H index of the peak

getHKL((IPeak)self) → V3D :¶

Get HKL as a V3D object

getInitialEnergy((IPeak)self) → float :¶

Get the initial (incident) neutron energy

getIntensity((IPeak)self) → float :¶

Return the integrated peak intensity

getK((IPeak)self) → float :¶

Get the K index of the peak

getL((IPeak)self) → float :¶

Get the L index of the peak

getL1((IPeak)self) → float :¶

Return the L1 flight path length (source to sample), in meters.

getL2((IPeak)self) → float :¶

Return the L2 flight path length (sample to detector), in meters.

getMonitorCount((IPeak)self) → float :¶

Get the monitor count set for this peak

getPeakShape((IPeak)self) → PeakShape :¶

Get the peak shape

getQLabFrame((IPeak)self) → V3D :¶

Return the Q change (of the lattice, k_i - k_f) for this peak. The Q is in the Lab frame: the goniometer rotation was NOT taken out. Note: There is no 2*pi factor used, so |Q| = 1/wavelength.

getQSampleFrame((IPeak)self) → V3D :¶

Return the Q change (of the lattice, k_i - k_f) for this peak.The Q is in the Sample frame: the goniometer rotation WAS taken out.

getRow((IPeak)self) → int :¶

For RectangularDetectors only, returns the row (y) of the pixel of the detector.

getRunNumber((IPeak)self) → int :¶

Return the run number this peak was measured at

getScattering((IPeak)self) → float :¶

Calculate the scattering angle of the peak

getSigmaIntensity((IPeak)self) → float :¶

Return the error on the integrated peak intensity

getTOF((IPeak)self) → float :¶

Calculate the time of flight (in microseconds) of the neutrons for this peak

getWavelength((IPeak)self) → float :¶

Return the incident wavelength

setBinCount((IPeak)self, (float)bin_count) → None :¶

Set the # of counts in the bin at its peak

setDetectorID((IPeak)self, (int)det_id) → None :¶

Set the detector ID and look up and cache values related to it.

setFinalEnergy((IPeak)self, (float)final_energy) → None :¶

Set the final neutron energy

setGoniometerMatrix((IPeak)self, (object)goniometerMatrix) → None :¶

Set the goniometer of the peak

setH((IPeak)self, (float)h) → None :¶

Get the H index of the peak

setHKL((IPeak)self, (float)h, (float)k, (float)l) → None :¶

Set the HKL values of this peak

setInitialEnergy((IPeak)self, (float)initial_energy) → None :¶

Set the initial (incident) neutron energy

setIntensity((IPeak)self, (float)intensity) → None :¶

Set the integrated peak intensity

setK((IPeak)self, (float)k) → None :¶

Get the K index of the peak

setL((IPeak)self, (float)l) → None :¶

Get the L index of the peak

setMonitorCount((IPeak)self, (float)monitor_count) → None :¶

Set the monitor count for this peak

setQLabFrame((IPeak)self, (V3D)qlab_frame) → None :¶

Set the peak using the peak’s position in reciprocal space, in the lab frame.

setQLabFrame( (IPeak)self, (V3D)qlab_frame, (float)distance) -> None :

Set the peak using the peak’s position in reciprocal space, in the lab frame. Detector distance explicitly supplied.

setQSampleFrame((IPeak)self, (V3D)qsample_frame) → None :¶

Set the peak using the peak’s position in reciprocal space, in the sample frame.

setQSampleFrame( (IPeak)self, (V3D)qsample_frame, (float)distance) -> None :

Set the peak using the peak’s position in reciprocal space, in the sample frame. Detector distance explicitly supplied.

setRunNumber((IPeak)self, (int)run_number) → None :¶

Set the run number that measured this peak

setSigmaIntensity((IPeak)self, (float)sigma_intensity) → None :¶

Set the error on the integrated peak intensity

setWavelength((IPeak)self, (float)wave_length) → None :¶

Set the incident wavelength of the neutron. Calculates the energy from this assuming elastic scattering.