Jungfraujoch/docs/python_client/docs/SpotFindingSettings.md

SpotFindingSettings

Properties

Name	Type	Description	Notes
enable	bool	Enable spot finding. This is temporary setting, i.e. can be changed anytime during data collection. Even if disabled spot finding information will still be send and written, though always with zero spots.	[default to True]
indexing	bool	Enable indexing. This is temporary setting, i.e. can be changed anytime during data collection.	[default to True]
signal_to_noise_threshold	float
photon_count_threshold	int
min_pix_per_spot	int
max_pix_per_spot	int
high_resolution_limit	float	High resolution limit for spot finding [Angstrom]. Optional: if omitted, spot finding extends as far as the detector reaches, i.e. the detection is not clipped in resolution.	[optional]
low_resolution_limit	float	Low resolution limit for spot finding [Angstrom]. Optional: if omitted, spot finding is not clipped at the low-resolution end. A value of 0 is accepted and means the same thing.	[optional]
high_resolution_limit_for_spot_count_low_res	float	High resolution threshold to consider spot "low resolution" [Angstrom]
quick_integration	bool	Ignored: accepted on input and always returned as false; will be removed in a future release. The Lite and FPGA workflows index images but do not integrate them; integration is done by rugnux live.	[optional] [default to False]
ice_ring_width_q_recip_a	float	Half-width of the ice ring band in q (1/A). Matches the offline default in image_analysis/spot_finding/SpotFindingSettings.h, which was set from a measured ring FWHM of ~0.06; the two must agree or the same data gets a narrower ice band online.	[default to 0.03]
high_res_gap_q_recip_a	float	This parameter is used to remove spurious spots at a very high resolution, that sometimes appear due to very low background close to the edge of the detector. If there is a gap in (1/d)-space between spots of at least this size, spots on the side of the gap with high resolution will be discarded. This is optional parameter. This option should be turned OFF for small molecule datasets or for crystals with very low mosaicity, when it is expected to see only few spots in any case.	[optional] [default to 1.5]
adaptive_threshold	bool	Self-calibrating spot detection: replace the fixed photon_count_threshold by a per-resolution-ring threshold derived from each image's own noise, so the same setting works across datasets without per-dataset tuning. photon_count_threshold is then ignored and false_pixels_per_frame sets the operating point instead. Used only on detectors whose images are analysed in software (the DECTRIS/SIMPLON workflow). The JUNGFRAU and EIGER workflows find spots on the FPGA, which applies its own fixed threshold; there the setting is accepted and ignored, so the same settings can be shared across detectors.	[optional] [default to False]
false_pixels_per_frame	float	Operating point of the adaptive threshold: the number of noise pixels tolerated per frame. About 100 suits a multi-megapixel detector. Ignored unless adaptive_threshold is set.	[optional] [default to 100.0]

Example

from jfjoch_client.models.spot_finding_settings import SpotFindingSettings

# TODO update the JSON string below
json = "{}"
# create an instance of SpotFindingSettings from a JSON string
spot_finding_settings_instance = SpotFindingSettings.from_json(json)
# print the JSON string representation of the object
print(SpotFindingSettings.to_json())

# convert the object into a dict
spot_finding_settings_dict = spot_finding_settings_instance.to_dict()
# create an instance of SpotFindingSettings from a dict
spot_finding_settings_from_dict = SpotFindingSettings.from_dict(spot_finding_settings_dict)

[Back to Model list] [Back to API list] [Back to README]