Home       Trees       Indices       Help   
Reflectometry
Package reflectometry :: Package reduction :: Module polcor :: Class PolarizationEfficiency

Class PolarizationEfficiency

source code

Polarization efficiency correction object. Create a correction object from a polarized direct beam measurement and apply it to measured data.

E.g.,
eff = PolarizationEfficiency(beam) data.apply(eff)
Instance Methods
 
__init__(self, **kw)
Define the polarization efficiency correction for the beam		 source code
 
set(self, **kw)
Update a set of correction parameters.		 source code
 
apply(self, data)
Apply the correction to the data		 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
  properties = ['FRbalance', 'min_efficiency', 'min_intensity', ...
  min_efficiency = 0.7
Minimum efficiency cutoff
  min_intensity = 0.01
Minimum intensity cutoff
  clip = True
Perform clipping to keep efficiencies physical
  spinflip = True
Correct both spinflip and non-spinflip data if available
Properties
  beam
measured beam intensity
  FRbalance
relative balance of front to back efficiency
  x
  y
  F
  R
  beta

Inherited from object: __class__

Method Details

__init__(self, **kw)
(Constructor)

source code 

Define the polarization efficiency correction for the beam

Keywords:
beam: measured beam intensity for all four cross sections FRbalance: portion of efficiency to assign to front versus rear clip: [True|False] force efficiencies below 100% spinflip: [True|False] compute spinflip correction
Overrides: object.__init__

apply(self, data)

source code 
Apply the correction to the data
Overrides: correction.Correction.apply

__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)

Class Variable Details

properties

Value:
['FRbalance', 'min_efficiency', 'min_intensity', 'clip', 'spinflip']

Property Details

beam

measured beam intensity
Get Method:
_getbeam(self)
Set Method:
_setbeam(self, beam)

FRbalance

relative balance of front to back efficiency
Get Method:
_getFRbalance(self)
Set Method:
_setFRbalance(self, val)

x

Get Method:
unreachable.x(self)

y

Get Method:
unreachable.y(self)

F

Get Method:
unreachable.F(self)

R

Get Method:
unreachable.R(self)

beta

Get Method:
unreachable.beta(self)

   Home       Trees       Indices       Help   
Reflectometry
Generated by Epydoc 3.0.1 on Tue Mar 17 14:21:52 2009 http://epydoc.sourceforge.net