Table of Contents

Class: SimplePeaks experiment/peaks.py

Stand-alone peak storage class.

Acts as a list of information records of peaks. Information stored is:

i

rough intensity

sigi

rough standard deviation in intensity

x

vertical pixel coordinate of the peak

y

horizontal pixel coordinate of the peak

mmx

horizontal mm coordinate of the peak

mmy

vertical mm coordinate of the peak

mmxid

horizontal mm coordinate of the peak if the detector alignment would be ideal

mmyid

vertical mm coordinate of the peak if the detector alignment would be ideal

radius

for strong peaks, an estimate for the single sigma spot radius

highpixel

the highest pixel value in the peak

Optionally, a record of extra data can be stored as the rec attribute.

Methods   
__delitem__
__getitem__
__getstate__
__init__
__len__
__setstate__
addpeak
clean
get
  __delitem__ 
__delitem__ ( self,  i )

List emulation, delete element i

  __getitem__ 
__getitem__ ( self,  i )

List emulation, retrieve element i

  __getstate__ 
__getstate__ ( self )

Return the object in a storable form

  __init__ 
__init__ (
        self,
        p=None,
        dx=None,
        theta=None,
        dis=None,
        hardware=None,
        rotaxis=None,
        )

  1. Builds an empty list.

    arguments:

    p

    the position of the detector (only dx and theta are used)

    dis

    distortion calibration object

    rotaxis

    the direction of the rotation axis (needed to calculate chi)

    alternative arguments if p is not given:

    dx

    the dx position of the detector

    theta

    the theta position of the detector

    hardware

    the hardware connection object

    This class does not use the p argument (subclasses do), but the dis argument is required for proper operation.

  __len__ 
__len__ ( self )

List emulation, return number of peaks

  __setstate__ 
__setstate__ ( self,  state )

Return the state of the object from the storable form

  addpeak 
addpeak (
        self,
        x,
        y,
        i,
        sigi,
        rec=None,
        highpixel=None,
        radius=None,
        **kw,
        )

Add a peak at x,y with intensity i+/-sigi.

  clean 
clean ( self )

Empty the peak list

  get 
get ( self )

Retrieve the peak list out of the object


Table of Contents

This document was automatically generated on Fri Jul 3 09:28:36 2009 by HappyDoc version WORKING