Download OpenAPI specification:
Download OpenAPI specification:
API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland).
@@ -971,7 +971,7 @@ Changing detector will set detector to Inactive state and will requ
" class="sc-dTUlgT sc-fhPBcz sc-dNpohg gAHTYt hNgelr kfJzSr">
Everything OK
{- "detectors": [
- {
- "id": 0,
- "description": "JUNGFRAU 4 Mpixel",
- "serial_number": "JF17T16V01",
- "base_ipv4_addr": "10.10.10.1",
- "udp_interface_count": 2,
- "nmodules": 18,
- "width": 2068,
- "height": 2164,
- "readout_time_us": 0,
- "min_frame_time_us": 0,
- "min_count_time_us": 0,
- "type": "EIGER"
}
], - "current_id": 0
}{- "detectors": [
- {
- "id": 0,
- "description": "JUNGFRAU 4 Mpixel",
- "serial_number": "JF17T16V01",
- "base_ipv4_addr": "10.10.10.1",
- "udp_interface_count": 2,
- "nmodules": 18,
- "width": 2068,
- "height": 2164,
- "pixel_size_mm": 0.075,
- "readout_time_us": 0,
- "min_frame_time_us": 0,
- "min_count_time_us": 0,
- "type": "EIGER"
}
], - "current_id": 0
}{- "detector": {
- "state": "Idle",
- "powerchip": "PowerOn",
- "server_version": "string",
- "number_of_triggers_left": 0,
- "fpga_temp_degC": [
- 0
], - "high_voltage_V": [
- 0
]
}, - "detector_list": {
- "detectors": [
- {
- "id": 0,
- "description": "JUNGFRAU 4 Mpixel",
- "serial_number": "JF17T16V01",
- "base_ipv4_addr": "10.10.10.1",
- "udp_interface_count": 2,
- "nmodules": 18,
- "width": 2068,
- "height": 2164,
- "readout_time_us": 0,
- "min_frame_time_us": 0,
- "min_count_time_us": 0,
- "type": "EIGER"
}
], - "current_id": 0
}, - "detector_settings": {
- "frame_time_us": 1,
- "count_time_us": 0,
- "internal_frame_generator": false,
- "internal_frame_generator_images": 1,
- "detector_trigger_delay_ns": 0,
- "timing": "auto",
- "eiger_threshold_keV": 1,
- "eiger_bit_depth": 8,
- "jungfrau_pedestal_g0_frames": 2000,
- "jungfrau_pedestal_g1_frames": 300,
- "jungfrau_pedestal_g2_frames": 300,
- "jungfrau_pedestal_min_image_count": 128,
- "jungfrau_storage_cell_count": 1,
- "jungfrau_storage_cell_delay_ns": 5000,
- "jungfrau_fixed_gain_g1": false,
- "jungfrau_use_gain_hg0": false
}, - "image_format_settings": {
- "summation": true,
- "geometry_transform": true,
- "jungfrau_conversion": true,
- "jungfrau_conversion_factor_keV": 0.001,
- "bit_depth_image": 8,
- "signed_output": true,
- "mask_module_edges": true,
- "mask_chip_edges": true,
- "jungfrau_mask_pixels_without_g0": true,
- "apply_mask": false,
- "jungfrau_pedestal_g0_rms_limit": 100
}, - "instrument_metadata": {
- "source_name": "Swiss Light Source",
- "source_type": "Synchrotron X-ray Source",
- "instrument_name": "CristallinaMX",
- "pulsed_source": false,
- "electron_source": false
}, - "file_writer_settings": {
- "overwrite": false,
- "format": "None"
}, - "data_processing_settings": {
- "enable": true,
- "indexing": true,
- "filter_powder_rings": false,
- "min_spot_count_powder_ring": 5,
- "signal_to_noise_threshold": 0.1,
- "photon_count_threshold": 0,
- "min_pix_per_spot": 1,
- "max_pix_per_spot": 1,
- "high_resolution_limit": 0.1,
- "low_resolution_limit": 0.1,
- "resolution_estimate": true,
- "quick_integration": false,
- "quick_integration_high_res_A": 1.5
}, - "measurement": {
- "file_prefix": "string",
- "run_number": 0,
- "experiment_group": "string",
- "images_expected": 0,
- "images_collected": 0,
- "images_sent": 0,
- "images_discarded_lossy_compression": 0,
- "max_image_number_sent": 0,
- "collection_efficiency": 1,
- "compression_ratio": 5.3,
- "cancelled": true,
- "max_receiver_delay": 0,
- "indexing_rate": 0.1,
- "detector_width": 0,
- "detector_height": 0,
- "detector_pixel_depth": 2,
- "bkg_estimate": 0.1,
- "unit_cell": "string",
- "error_pixels": 0.1,
- "saturated_pixels": 0.1,
- "roi_beam_pixels": 0.1,
- "roi_beam_sum": 0.1
}, - "broker": {
- "state": "Inactive",
- "progress": 1,
- "message": "string",
- "message_severity": "success",
- "gpu_count": 0,
- "ml_resolution_estimation": true
}, - "fpga": [
- {
- "pci_dev_id": "string",
- "serial_number": "string",
- "fw_version": "string",
- "base_mac_addr": "string",
- "eth_link_count": 0,
- "eth_link_status": 0,
- "power_usage_W": 0.1,
- "fpga_temp_C": 0.1,
- "hbm_temp_C": 0.1,
- "packets_udp": 0,
- "packets_sls": 0,
- "idle": true,
- "pcie_link_speed": 0,
- "pcie_link_width": 0
}
], - "calibration": [
- {
- "module_number": 0,
- "storage_cell_number": 0,
- "pedestal_g0_mean": 0.1,
- "pedestal_g1_mean": 0.1,
- "pedestal_g2_mean": 0.1,
- "gain_g0_mean": 0.1,
- "gain_g1_mean": 0.1,
- "gain_g2_mean": 0.1,
- "masked_pixels": 0
}
], - "zeromq_preview": {
- "enabled": true,
- "period_ms": 1000,
- "socket_address": "string"
}, - "zeromq_metadata": {
- "enabled": true,
- "period_ms": 1000,
- "socket_address": "string"
}, - "pixel_mask": {
- "user_mask": 0,
- "too_high_pedestal_rms": 0,
- "wrong_gain": 0
}, - "roi": {
- "box": {
- "rois": [
- {
- "name": "string",
- "min_x_pxl": 0,
- "max_x_pxl": 0,
- "min_y_pxl": 0,
- "max_y_pxl": 0
}
]
}, - "circle": {
- "rois": [
- {
- "name": "string",
- "center_x_pxl": 0.1,
- "center_y_pxl": 0.1,
- "radius_pxl": 0.1
}
]
}, - "azim": {
- "rois": [
- {
- "name": "string",
- "q_min_recipA": 0.00001,
- "q_max_recipA": 0.00001
}
]
}
}, - "az_int": {
- "polarization_corr": true,
- "solid_angle_corr": true,
- "high_q_recipA": 0.1,
- "low_q_recipA": 0.1,
- "q_spacing": 0.1,
- "azimuthal_bins": 1
}, - "buffer": {
- "min_image_number": 0,
- "max_image_number": 0,
- "image_numbers": [
- 0
], - "total_slots": 0,
- "available_slots": 0
}, - "indexing": {
- "algorithm": "FFBIDX",
- "fft_max_unit_cell_A": 250,
- "fft_min_unit_cell_A": 10,
- "fft_high_resolution_A": 2,
- "fft_num_vectors": 16384,
- "tolerance": 0.5
}
}{- "detector": {
- "state": "Idle",
- "powerchip": "PowerOn",
- "server_version": "string",
- "number_of_triggers_left": 0,
- "fpga_temp_degC": [
- 0
], - "high_voltage_V": [
- 0
]
}, - "detector_list": {
- "detectors": [
- {
- "id": 0,
- "description": "JUNGFRAU 4 Mpixel",
- "serial_number": "JF17T16V01",
- "base_ipv4_addr": "10.10.10.1",
- "udp_interface_count": 2,
- "nmodules": 18,
- "width": 2068,
- "height": 2164,
- "pixel_size_mm": 0.075,
- "readout_time_us": 0,
- "min_frame_time_us": 0,
- "min_count_time_us": 0,
- "type": "EIGER"
}
], - "current_id": 0
}, - "detector_settings": {
- "frame_time_us": 1,
- "count_time_us": 0,
- "internal_frame_generator": false,
- "internal_frame_generator_images": 1,
- "detector_trigger_delay_ns": 0,
- "timing": "auto",
- "eiger_threshold_keV": 1,
- "eiger_bit_depth": 8,
- "jungfrau_pedestal_g0_frames": 2000,
- "jungfrau_pedestal_g1_frames": 300,
- "jungfrau_pedestal_g2_frames": 300,
- "jungfrau_pedestal_min_image_count": 128,
- "jungfrau_storage_cell_count": 1,
- "jungfrau_storage_cell_delay_ns": 5000,
- "jungfrau_fixed_gain_g1": false,
- "jungfrau_use_gain_hg0": false
}, - "image_format_settings": {
- "summation": true,
- "geometry_transform": true,
- "jungfrau_conversion": true,
- "jungfrau_conversion_factor_keV": 0.001,
- "bit_depth_image": 8,
- "signed_output": true,
- "mask_module_edges": true,
- "mask_chip_edges": true,
- "jungfrau_mask_pixels_without_g0": true,
- "apply_mask": false,
- "jungfrau_pedestal_g0_rms_limit": 100
}, - "instrument_metadata": {
- "source_name": "Swiss Light Source",
- "source_type": "Synchrotron X-ray Source",
- "instrument_name": "CristallinaMX",
- "pulsed_source": false,
- "electron_source": false
}, - "file_writer_settings": {
- "overwrite": false,
- "format": "None"
}, - "data_processing_settings": {
- "enable": true,
- "indexing": true,
- "filter_powder_rings": false,
- "min_spot_count_powder_ring": 5,
- "signal_to_noise_threshold": 0.1,
- "photon_count_threshold": 0,
- "min_pix_per_spot": 1,
- "max_pix_per_spot": 1,
- "high_resolution_limit": 0.1,
- "low_resolution_limit": 0.1,
- "resolution_estimate": true,
- "quick_integration": false,
- "quick_integration_high_res_A": 1.5
}, - "measurement": {
- "file_prefix": "string",
- "run_number": 0,
- "experiment_group": "string",
- "images_expected": 0,
- "images_collected": 0,
- "images_sent": 0,
- "images_discarded_lossy_compression": 0,
- "max_image_number_sent": 0,
- "collection_efficiency": 1,
- "compression_ratio": 5.3,
- "cancelled": true,
- "max_receiver_delay": 0,
- "indexing_rate": 0.1,
- "detector_width": 0,
- "detector_height": 0,
- "detector_pixel_depth": 2,
- "bkg_estimate": 0.1,
- "unit_cell": "string",
- "error_pixels": 0.1,
- "saturated_pixels": 0.1,
- "roi_beam_pixels": 0.1,
- "roi_beam_sum": 0.1
}, - "broker": {
- "state": "Inactive",
- "progress": 1,
- "message": "string",
- "message_severity": "success",
- "gpu_count": 0,
- "ml_resolution_estimation": true
}, - "fpga": [
- {
- "pci_dev_id": "string",
- "serial_number": "string",
- "fw_version": "string",
- "base_mac_addr": "string",
- "eth_link_count": 0,
- "eth_link_status": 0,
- "power_usage_W": 0.1,
- "fpga_temp_C": 0.1,
- "hbm_temp_C": 0.1,
- "packets_udp": 0,
- "packets_sls": 0,
- "idle": true,
- "pcie_link_speed": 0,
- "pcie_link_width": 0
}
], - "calibration": [
- {
- "module_number": 0,
- "storage_cell_number": 0,
- "pedestal_g0_mean": 0.1,
- "pedestal_g1_mean": 0.1,
- "pedestal_g2_mean": 0.1,
- "gain_g0_mean": 0.1,
- "gain_g1_mean": 0.1,
- "gain_g2_mean": 0.1,
- "masked_pixels": 0
}
], - "zeromq_preview": {
- "enabled": true,
- "period_ms": 1000,
- "socket_address": "string"
}, - "zeromq_metadata": {
- "enabled": true,
- "period_ms": 1000,
- "socket_address": "string"
}, - "pixel_mask": {
- "user_mask": 0,
- "too_high_pedestal_rms": 0,
- "wrong_gain": 0
}, - "roi": {
- "box": {
- "rois": [
- {
- "name": "string",
- "min_x_pxl": 0,
- "max_x_pxl": 0,
- "min_y_pxl": 0,
- "max_y_pxl": 0
}
]
}, - "circle": {
- "rois": [
- {
- "name": "string",
- "center_x_pxl": 0.1,
- "center_y_pxl": 0.1,
- "radius_pxl": 0.1
}
]
}, - "azim": {
- "rois": [
- {
- "name": "string",
- "q_min_recipA": 0.00001,
- "q_max_recipA": 0.00001
}
]
}
}, - "az_int": {
- "polarization_corr": true,
- "solid_angle_corr": true,
- "high_q_recipA": 0.1,
- "low_q_recipA": 0.1,
- "q_spacing": 0.1,
- "azimuthal_bins": 1
}, - "buffer": {
- "min_image_number": 0,
- "max_image_number": 0,
- "image_numbers": [
- 0
], - "total_slots": 0,
- "available_slots": 0
}, - "indexing": {
- "algorithm": "FFBIDX",
- "fft_max_unit_cell_A": 250,
- "fft_min_unit_cell_A": 10,
- "fft_high_resolution_A": 2,
- "fft_num_vectors": 16384,
- "tolerance": 0.5
}
}