Skip to content

Eiger legacy

EigerLegacyPacket = TypeAdapter(EigerLegacyHeader | EigerLegacyImage | EigerLegacyEnd) module-attribute

A union type for Eiger Legacy packets

EigerLegacyEnd

Bases: EigerLegacy

Example 
EigerLegacyEnd(
    htype='dseries_end-1.0'
)
Source code in dranspose/data/eiger_legacy.py 
125
126
127
128
129
130
131
132
133
134
135
136
137
class EigerLegacyEnd(EigerLegacy):
    """
    Example:
        ``` py
        EigerLegacyEnd(
            htype='dseries_end-1.0'
        )
        ```
    """

    model_config = ConfigDict(extra="allow")

    htype: Literal["dseries_end-1.0"]

EigerLegacyHeader

Bases: EigerLegacy

Example 
EigerLegacyHeader(
    htype='dheader-1.0'
    header_detail='all'
    series=6
    info={'auto_summation': True,
          'beam_center_x': 0.0,
          'beam_center_y': 0.0,
          'bit_depth_image': 32,
          'bit_depth_readout': 16,
          'chi_increment': 0.0,
          'chi_start': 0.0,
          'compression': 'bslz4',
          'count_time': 0.0099999,
          'countrate_correction_applied': True,
          'countrate_correction_count_cutoff': 83270,
          'data_collection_date': '2024-03-12T15:29:58.142+01:00',
          'description': 'Dectris EIGER2 CdTe 9M',
          'detector_distance': 0.0,
          'detector_number': 'E-18-0000',
          'detector_readout_time': 1e-07,
          'detector_translation': [0.0, 0.0, 0.0],
          'eiger_fw_version': 'release-2022.1.1',
          'element': '',
          'flatfield_correction_applied': True,
          'frame_count_time': 0.00499996,
          'frame_period': 0.00499996,
          'frame_time': 0.01,
          'kappa_increment': 0.0,
          'kappa_start': 0.0,
          'nimages': 3,
          'ntrigger': 1,
          'number_of_excluded_pixels': 683998,
          'omega_increment': 0.0,
          'omega_start': 0.0,
          'phi_increment': 0.0,
          'phi_start': 0.0,
          'photon_energy': 8041.0,
          'pixel_mask_applied': True,
          'roi_mode': '',
          'sensor_material': 'CdTe',
          'sensor_thickness': 0.00075,
          'software_version': '1.8.0',
          'threshold_energy': 4020.5,
          'trigger_mode': 'ints',
          'two_theta_increment': 0.0,
          'two_theta_start': 0.0,
          'virtual_pixel_correction_applied': True,
          'wavelength': 1.5419002416764116,
          'x_pixel_size': 7.5e-05,
          'x_pixels_in_detector': 3108,
          'y_pixel_size': 7.5e-05,
          'y_pixels_in_detector': 3262}
    appendix={'collect_dict': {
                'col_id': 128579,
                'process_dir': '/data/.../process',
                'target_beam_size_factor': 0,
                'ssx_mode': 'test',
                'exp_type': 'test',
                'shape_id': '2DP1',
                'col': 0,
                'row': 0},
              'dozor_dict': {
                'x_pixels_in_detector': 3108,
                'omega_increment': None,
                'count_time': 0.0099999,
                'detector_distance': 0.0,
                'beam_center_y': 0.0,
                'beam_center_x': 0.0,
                'y_pixels_in_detector': 3262,
                'wavelength': 1.541900241676412,
                'countrate_correction_count_cutoff': 83270,
                'x_pixel_size': 7.5e-05}
              }
)
Source code in dranspose/data/eiger_legacy.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class EigerLegacyHeader(EigerLegacy):
    """
    Example:
        ``` py
        EigerLegacyHeader(
            htype='dheader-1.0'
            header_detail='all'
            series=6
            info={'auto_summation': True,
                  'beam_center_x': 0.0,
                  'beam_center_y': 0.0,
                  'bit_depth_image': 32,
                  'bit_depth_readout': 16,
                  'chi_increment': 0.0,
                  'chi_start': 0.0,
                  'compression': 'bslz4',
                  'count_time': 0.0099999,
                  'countrate_correction_applied': True,
                  'countrate_correction_count_cutoff': 83270,
                  'data_collection_date': '2024-03-12T15:29:58.142+01:00',
                  'description': 'Dectris EIGER2 CdTe 9M',
                  'detector_distance': 0.0,
                  'detector_number': 'E-18-0000',
                  'detector_readout_time': 1e-07,
                  'detector_translation': [0.0, 0.0, 0.0],
                  'eiger_fw_version': 'release-2022.1.1',
                  'element': '',
                  'flatfield_correction_applied': True,
                  'frame_count_time': 0.00499996,
                  'frame_period': 0.00499996,
                  'frame_time': 0.01,
                  'kappa_increment': 0.0,
                  'kappa_start': 0.0,
                  'nimages': 3,
                  'ntrigger': 1,
                  'number_of_excluded_pixels': 683998,
                  'omega_increment': 0.0,
                  'omega_start': 0.0,
                  'phi_increment': 0.0,
                  'phi_start': 0.0,
                  'photon_energy': 8041.0,
                  'pixel_mask_applied': True,
                  'roi_mode': '',
                  'sensor_material': 'CdTe',
                  'sensor_thickness': 0.00075,
                  'software_version': '1.8.0',
                  'threshold_energy': 4020.5,
                  'trigger_mode': 'ints',
                  'two_theta_increment': 0.0,
                  'two_theta_start': 0.0,
                  'virtual_pixel_correction_applied': True,
                  'wavelength': 1.5419002416764116,
                  'x_pixel_size': 7.5e-05,
                  'x_pixels_in_detector': 3108,
                  'y_pixel_size': 7.5e-05,
                  'y_pixels_in_detector': 3262}
            appendix={'collect_dict': {
                        'col_id': 128579,
                        'process_dir': '/data/.../process',
                        'target_beam_size_factor': 0,
                        'ssx_mode': 'test',
                        'exp_type': 'test',
                        'shape_id': '2DP1',
                        'col': 0,
                        'row': 0},
                      'dozor_dict': {
                        'x_pixels_in_detector': 3108,
                        'omega_increment': None,
                        'count_time': 0.0099999,
                        'detector_distance': 0.0,
                        'beam_center_y': 0.0,
                        'beam_center_x': 0.0,
                        'y_pixels_in_detector': 3262,
                        'wavelength': 1.541900241676412,
                        'countrate_correction_count_cutoff': 83270,
                        'x_pixel_size': 7.5e-05}
                      }
        )
        ```
    """

    model_config = ConfigDict(extra="allow")

    htype: Literal["dheader-1.0"]

EigerLegacyImage

Bases: EigerLegacy

Example 
EigerLegacyImage(
    htype='dimage-1.0',
    frame=0
    hash='815e4907ce3482ec3cc4d33a1145cd44'
    series=6
    data={'encoding': 'bs32-lz4<',
          'htype': 'dimage_d-1.0',
          'shape': [3108, 3262],
          'size': 754672,
          'type': 'uint32',
          'buffer': b'jÊà...'
    config={'htype': 'dconfig-1.0',
            'real_time': 9999900,
            'start_time': 103597359252740,
            'stop_time': 103597369252640}
)
Source code in dranspose/data/eiger_legacy.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
class EigerLegacyImage(EigerLegacy):
    """
    Example:
        ``` py
        EigerLegacyImage(
            htype='dimage-1.0',
            frame=0
            hash='815e4907ce3482ec3cc4d33a1145cd44'
            series=6
            data={'encoding': 'bs32-lz4<',
                  'htype': 'dimage_d-1.0',
                  'shape': [3108, 3262],
                  'size': 754672,
                  'type': 'uint32',
                  'buffer': b'\x00\x00\x00\x00\x02j\xca\xe0...'
            config={'htype': 'dconfig-1.0',
                    'real_time': 9999900,
                    'start_time': 103597359252740,
                    'stop_time': 103597369252640}
        )
        ```
    """

    model_config = ConfigDict(extra="allow")

    htype: Literal["dimage-1.0"]
    frame: int