box required
object (roi_box_list)
http://localhost:5232 /config/roi
Response samples Content type application/json
Copy
Expand all Collapse all { "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 ,
"phi_min_deg" : 0.1 ,
"phi_max_deg" : 0.1
} ] } } Upload ROI definitions Request Body schema: application/json
box required
circle required
azim required
Responses 400 Input parsing or validation error
500 Error within Jungfraujoch code - see output message.
put /config/roi Test Jungfraujoch system
-
http://localhost:5232 /config/roi
Request samples Content type application/json
Copy
Expand all Collapse all { "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
} ] } } Response samples Content type application/json
Get general statistics Responses 200 http://localhost:5232 /config/roi
Request samples Content type application/json
Copy
Expand all Collapse all { "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 ,
"phi_min_deg" : 0.1 ,
"phi_max_deg" : 0.1
} ] } } Response samples Content type application/json
get /statistics Test Jungfraujoch system
-
http://localhost:5232 /statistics
Response samples Content type application/json
Copy
Expand all Collapse all { "detector" :
{ "state" : "Idle" ,
"powerchip" : "PowerOn" ,
"server_version" : "string" ,
"number_of_triggers_left" : 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_ns" : 0 ,
"min_frame_time_ns" : 0 ,
"min_count_time_ns" : 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" : "NXmxOnlyData"
} , "data_processing_settings" :
{ "enable" : true ,
"indexing" : true ,
"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 ,
"high_resolution_limit_for_spot_count_low_res" : 2 ,
"quick_integration" : false ,
"ice_ring_width_q_recipA" : 0.02 ,
"high_res_gap_Q_recipA" : 1.5
} , "measurement" :
{ "file_prefix" : "string" ,
"run_number" : 0 ,
"experiment_group" : "string" ,
"images_expected" : 0 ,
"images_collected" : 0 ,
"images_sent" : 0 ,
"images_written" : 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
} , "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
} ] , "dark_mask" :
{ "detector_threshold_keV" : 3.5 ,
"frame_time_us" : 10000 ,
"number_of_frames" : 1000 ,
"max_allowed_pixel_count" : 1 ,
"max_frames_with_signal" : 10
} , "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.00002 ,
"low_q_recipA" : 0.00001 ,
"q_spacing" : 0.00001 ,
"azimuthal_bins" : 1 ,
"force_cpu" : false
} , "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 ,
"thread_count" : 1 ,
"geom_refinement_algorithm" : "BeamCenter" ,
"unit_cell_dist_tolerance" : 0.05 ,
"viable_cell_min_spots" : 10 ,
"index_ice_rings" : false ,
"rotation_indexing" : false ,
"rotation_indexing_min_angular_range_deg" : 20 ,
"rotation_indexing_angular_stride_deg" : 0.5 ,
"blocking" : true
} , "image_pusher" :
{ "pusher_type" : "ZeroMQ" ,
"addr" :
[ "tcp://1.2.3.4:5000" ,
"tcp://1.2.3.4:5001"
] , "connected_writers" : 0 ,
"images_written" : 0 ,
"images_write_error" : 0 ,
"writer_fifo_utilization" :
[ ] } } Get data collection statistics Results of the last data collection
+
http://localhost:5232 /statistics
Response samples Content type application/json
Copy
Expand all Collapse all { "detector" :
{ "state" : "Idle" ,
"powerchip" : "PowerOn" ,
"server_version" : "string" ,
"number_of_triggers_left" : 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_ns" : 0 ,
"min_frame_time_ns" : 0 ,
"min_count_time_ns" : 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" : "NXmxOnlyData"
} , "data_processing_settings" :
{ "enable" : true ,
"indexing" : true ,
"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 ,
"high_resolution_limit_for_spot_count_low_res" : 2 ,
"quick_integration" : false ,
"ice_ring_width_q_recipA" : 0.02 ,
"high_res_gap_Q_recipA" : 1.5
} , "measurement" :
{ "file_prefix" : "string" ,
"run_number" : 0 ,
"experiment_group" : "string" ,
"images_expected" : 0 ,
"images_collected" : 0 ,
"images_sent" : 0 ,
"images_written" : 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
} , "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
} ] , "dark_mask" :
{ "detector_threshold_keV" : 3.5 ,
"frame_time_us" : 10000 ,
"number_of_frames" : 1000 ,
"max_allowed_pixel_count" : 1 ,
"max_frames_with_signal" : 10
} , "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 ,
"phi_min_deg" : 0.1 ,
"phi_max_deg" : 0.1
} ] } } , "az_int" :
{ "polarization_corr" : true ,
"solid_angle_corr" : true ,
"high_q_recipA" : 0.00002 ,
"low_q_recipA" : 0.00001 ,
"q_spacing" : 0.00001 ,
"azimuthal_bins" : 1 ,
"force_cpu" : false
} , "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 ,
"thread_count" : 1 ,
"geom_refinement_algorithm" : "BeamCenter" ,
"unit_cell_dist_tolerance" : 0.05 ,
"viable_cell_min_spots" : 10 ,
"index_ice_rings" : false ,
"rotation_indexing" : false ,
"rotation_indexing_min_angular_range_deg" : 20 ,
"rotation_indexing_angular_stride_deg" : 0.5 ,
"blocking" : true
} , "image_pusher" :
{ "pusher_type" : "ZeroMQ" ,
"addr" :
[ "tcp://1.2.3.4:5000" ,
"tcp://1.2.3.4:5001"
] , "connected_writers" : 0 ,
"images_written" : 0 ,
"images_write_error" : 0 ,
"writer_fifo_utilization" :
[ ] } } Get data collection statistics Results of the last data collection
Responses 404 No data collection performed so far
get /statistics/data_collection Test Jungfraujoch system
@@ -937,7 +937,7 @@ then image might be replaced in the buffer between calling /images and /image.cb
get /version http://localhost:5232 /version