Package reflectometry :: Package reduction :: Module ratiocor :: Class WaterIntensity

Class WaterIntensity

source code

Compute the incident intensity assuming that data measures a reflection off water.

D2O = percentage is the portion that is deuterated, from 0 to 100. probe = 'neutron' or 'xray'

Returns a correction object that can be applied to data.

Instance Methods

__init__(self, D2O=0, probe=None, background=0)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

apply(self, data)
Apply the correction to the dataset, modifying the dataset in the process.

source code

__str__(self)
Name of the correction, and enough detail to record in the reduced data log.

source code

Inherited from correction.Correction: __call__, __or__, __ror__

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

Class Variables
Inherited from `correction.Correction`: `properties`

Properties
	D2O
	probe
Inherited from `object`: `__class__`

Method Details

init(self, D2O=0, probe=None, background=0)
(Constructor)

source code

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

Overrides: object.__init__: (inherited documentation)

apply(self, data)

source code


Apply the correction to the dataset, modifying the dataset
in the process.  The data is returned, allowing users to
apply multiple corrections in one step:
     C2(C1(data))
Each correction will automatically be logged in the data using
data.log(str(Correction))

Overrides: correction.Correction.apply: (inherited documentation)

str(self)
(Informal representation operator)

source code

Name of the correction, and enough detail to record in the reduced data log.

Overrides: object.__str__: (inherited documentation)

Property Details

D2O

Get Method:: _getD2O(self)
Set Method:: _setD2O(self, D2O)

probe

Get Method:: _getprobe(self)
Set Method:: _setprobe(self, probe)

Class WaterIntensity

__init__(self, D2O=0, probe=None, background=0) (Constructor)

apply(self, data)

__str__(self) (Informal representation operator)

D2O

probe

init(self, D2O=0, probe=None, background=0)
(Constructor)

str(self)
(Informal representation operator)