Collimator#

class georges.manzoni.elements.Collimator(name: str = '', integrator: ~georges.manzoni.integrators.IntegratorType = <class 'georges.manzoni.integrators.MadXIntegrator'>, *params, **kwargs)[source]#

Bases: Drift

Define a Collimator.

PARAMETERS#

Dictionary containing the parameters of the Collimator with their default values.

Type:: dict

Examples

>>> c1 = Collimator('C1', L=10*_ureg.cm, APERTYPE='ELIPTICAL', APERTURE=[2*_ureg.cm, 3*_ureg.cm])
>>> c1 
    Collimator: {'NAME': 'C1',
                 'AT_ENTRY': <Quantity(0, 'meter')>,
                 'AT_CENTER': <Quantity(0, 'meter')>,
                 'AT_EXIT': <Quantity(0, 'meter')>,
                 'L': <Quantity(10, 'centimeter')>,
                 'APERTYPE': 'ELIPTICAL',
                 'APERTURE': [<Quantity(2, 'centimeter')>, <Quantity(3, 'centimeter')>]}

Command attributes

NAME=''

Primary label for the Manzoni command (default: auto-generated hash).

Type:: str

AT_ENTRY='0 meter'

Entrance position of the element.

Type:: Quantity

AT_CENTER='0 meter'

Entrance position of the element.

Type:: Quantity

AT_EXIT='0 meter'

Exit position of the element.

Type:: Quantity

L='0.0 meter'

Drift length.

Type:: Quantity

APERTYPE='None'

Aperture type (CIRCULAR, ELLIPTICAL, RECTANGULAR or PHASE_SPACE)

Type:: NoneType

APERTURE='[None, None, None, None]'

Type:: list

Default initializer for all Commands.

Attributes Summary

PARAMETERS

Parameters of the element, with their default value and their descriptions.

Attributes Documentation

PARAMETERS: dict = {'APERTURE': ([None, None, None, None], ''), 'APERTYPE': (None, 'Aperture type (CIRCULAR, ELLIPTICAL, RECTANGULAR or PHASE_SPACE)'), 'AT_CENTER': (<Quantity(0, 'meter')>, 'Entrance position of the element.'), 'AT_ENTRY': (<Quantity(0, 'meter')>, 'Entrance position of the element.'), 'AT_EXIT': (<Quantity(0, 'meter')>, 'Exit position of the element.'), 'L': (<Quantity(0.0, 'meter')>, 'Drift length.'), 'NAME': ('', 'Primary label for the Manzoni command (default: auto-generated hash).')}#: Parameters of the element, with their default value and their descriptions.