Analyser

Analyser.Analyser

Generic analyser object.

Analyser.Analyser.__init__

param - position

Position of analyser in meters

Analyser.Analyser.plot

param - ax

Axis object into which the analyser is plotted

Analyser.FlatAnalyser

Simple flat analyser.

Analyser.FlatAnalyser.__init__

param - Position

Position of object (default [0,0,0])

Analyser.FlatAnalyser.plot

param - ax

Axis object into which the analyser is plotted

Analyser Object and Methods

class Analyser.Analyser(position, direction, d_spacing=3.35, mosaicity=60)[source]

Generic analyser object. Base class from which all analysers must inherit.

Parameters

  • position (-) – Position of analyser in meters

  • direction (-) – Direction of analyser

  • d_spacing (-) – The d spacing in Angstrom (default 3.35)

  • mosaicity (-) – The standard deviation of mosaicity in arcminutes (default 60)

__init__(position, direction, d_spacing=3.35, mosaicity=60)[source]
Parameters

  • position (-) – Position of analyser in meters

  • direction (-) – Direction of analyser

  • d_spacing (-) – The d spacing in Angstrom (default 3.35)

  • mosaicity (-) – The standard deviation of mosaicity in arcminutes (default 60)

plot(ax, offset=(0.0, 0.0, 0.0))[source]
Parameters

ax (-) – Axis object into which the analyser is plotted

Kwargs:

  • offset (3vector): Offset of analuser due to bank position (default [0,0,0])

>>> GenericAnalyser = Analyser(position=(0.0,1.0,0.0),direction=(1.0,0,0))
>>> GenericAnalyser.plot(ax)

FlatAnalyser Object and Methods

class Analyser.FlatAnalyser(position, direction, d_spacing=3.35, mosaicity=60, width=0.05, height=0.1)[source]

Simple flat analyser.

Parameters

  • Position (-) – Position of object (default [0,0,0])

  • Direction (-) – Direction along which the object points (default [0,0,1])

Kwargs:

  • d_spacing (float): D spacing of analyser in Angstrom

  • mosaicity (float): Mosaicity in arcminutes

  • length (float): Length of detector tube in meters (default 0.25)

  • pixels (int): Number of pixels (default 456)

  • diameter (float): Diameter of tube in meters (default 0.02)

Raises

  • - AttributeError –

  • - NotImplementedError –

__init__(position, direction, d_spacing=3.35, mosaicity=60, width=0.05, height=0.1)[source]
Parameters

  • Position (-) – Position of object (default [0,0,0])

  • Direction (-) – Direction along which the object points (default [0,0,1])

Kwargs:

  • d_spacing (float): D spacing of analyser in Angstrom

  • mosaicity (float): Mosaicity in arcminutes

  • length (float): Length of detector tube in meters (default 0.25)

  • pixels (int): Number of pixels (default 456)

  • diameter (float): Diameter of tube in meters (default 0.02)

Raises

  • - AttributeError –

  • - NotImplementedError –

plot(ax, offset=array([0, 0, 0]), n=100)[source]
Parameters

ax (-) – Axis object into which the analyser is plotted

Kwargs:

  • offset (3vector): Offset of detector due to bank position (default [0,0,0])

  • n (int): Number of points on the surface to be plotted (default 100)

>>> Analyser = FlatAnalyser(position=(0.0,1.0,0.0),direction=(1.0,0,0))
>>> Analyser.plot(ax,offset=(0.0,0.0,0.0),n=100)