Package reflectometry :: Package reduction :: Module refldata :: Class ReflData

Class ReflData

source code

slit1,slit2 (Slit): Presample slits
slit3,slit4 (Slit): Post sample slits
sample: Sample geometry
detector: Detector geometry, efficiency and counts
monitor: Counts and/or durations
polarization: '' unpolarized '+' spin up '-' spin down '++','--' non-spin-flip '-+','+-' spin flip
points: For scanning instruments, the number of measurements.
channels: For time of flight, the number of time channels. For white beam instruments, the number of analysers.
reversed (False): True if the measurement is reversed, in which case sample and detector angles need to be negated and pixel directions reversed when computing pixel coordinates.
roi: Region of interest on the detector.
display_monitor (counts): Default monitor to use when displaying data from this dataset

File details

instrument (string): Name of a particular instrument
probe ('neutron' or 'xray'): Type of radiation used to probe the sample.
path (string): Location of the datafile
entry (string): Entry identifier if more than one entry per file
name (string): Name of the dataset. This may be a combination of filename and entry number.
description (string): Description of the entry.
date (timestamp): Starting date and time of the measurement.
duration (second): Duration of the measurement.
warnings: List of warnings generated when the file was loaded
intent (string): Purpose of the measurement. intensity: Normalization scan for computing absolute reflection specular: Specular intensity measurement q_offset: Background measurement, offset from Qx=0 in Q sample_offset: Background measurement, sample rotated detector_offset: Background measurement, detector moved slice: Slice through Qx-Qz area: Measurement of a region of Qx-Qz plane alignment: Sample alignment measurement other: Some other kind of measurement

Format specific fields (ignored by reduction software)

file (handle): Format specific file handle, for actions like showing the summary, updating the data and reading the frames.

Instance Methods

__init__(self, **kw)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

__str__(self)
str(x)

source code

warn(self, msg)
Record a warning that should be displayed to the user

source code

log(self, msg)
Record corrections that have been applied to the data

source code

apply(self, correction)
Allow alternative syntax: data.apply(correction)

source code

resetQ(self)
Recompute Qx,Qz from geometry and wavelength

source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__

Class Variables
	properties = `['instrument', 'geometry', 'probe', 'points', 'ch...`
	geometry = `'vertical'`
	probe = `'unknown'`
	format = `'unknown'`
	path = `'unknown'`
	entry = `''`
	points = `1`
	channels = `1`
	name = `''`
	description = `''`
	date = `datetime.datetime(1970, 1, 1, 0, 0)`
	duration = `0`
	file = `None`
	attenuator = `1.0`
	polarization = `''`
	reversed = `False`
	warnings = `None`
	messages = `None`
	xlabel = `'Qx'`
	xunits = `'inv A'`
	ylabel = `'Qy'`
	yunits = `'inv A'`
	zlabel = `'Qz'`
	zunits = `'inv A'`

Properties
	dR
	dv
	v
	x
	y
	z
Inherited from `object`: `__class__`

Method Details

init(self, **kw)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

str(self)
(Informal representation operator)

source code

str(x)

Overrides: object.__str__: (inherited documentation)

Class Variable Details

properties

Value:

['instrument',
 'geometry',
 'probe',
 'points',
 'channels',
 'name',
 'description',
 'date',
...

Property Details

dR

Get Method:: _getdR(self)
Set Method:: _setdR(self, dR)

dv

Get Method:: _getdv(self)

v

Get Method:: _getv(self)

x

Get Method:: _getx(self)

y

Get Method:: _gety(self)

z

Get Method:: _getz(self)

Class ReflData

File details

Format specific fields (ignored by reduction software)

__init__(self, **kw) (Constructor)

__str__(self) (Informal representation operator)

properties

dR

dv

v

x

y

z

init(self, **kw)
(Constructor)

str(self)
(Informal representation operator)