Models
This module import peakfinder8 from the OnDA monitor and add extra features.
PF8
This class defines an object that determine the Bragg peaks using the peakfinder8 algorithm from OnDA monitor.
Source code in bblib/models.py
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 |
|
__init__(info)
This method initilizes the PF8 class.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
info
|
PF8Info
|
Peakfinder8 parameters. |
required |
Source code in bblib/models.py
get_peaks_pf8(data)
This method determines the Bragg peaks positions using the peakfinder8 algorithm from OnDA monitor.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data
|
ndarray
|
Data in which the peakfinder8 will be performed. |
required |
Returns:
Name | Type | Description |
---|---|---|
peak_list |
dict
|
Bragg peaks position in the fast-scan/slow-scan axis, their integrated intensity and maximum intensity |
Source code in bblib/models.py
peak_list_in_slab(peak_list)
This method transforms the Bragg peaks positions in the fast-scan/slow-scan axis to Cartesian (x/y) coordinates using the visualization pixel map. Args: peak_list (dict): Bragg peaks list determined by peakfinder8.
Returns:
Name | Type | Description |
---|---|---|
peaks_coordinates |
tuple
|
Bragg peaks x and y coordinates in the visualization frame. |
Source code in bblib/models.py
PF8Info
dataclass
This class defines the configuration parameters for peakfinder8.
Attributes:
Name | Type | Description |
---|---|---|
max_num_peaks |
int32
|
Maximum number of peaks. |
adc_threshold |
int32
|
Minimum threshold in arbitrary detector counts (ADC) units. |
minimum_snr |
float32
|
Minimum signal-to-noise ration. |
min_pixel_count |
int16
|
Minimum number of pixels to consider a Bragg peak. |
max_pixel_count |
int16
|
Maximum number of pixels to consider a Bragg peak. |
local_bg_radius |
int16
|
Local bakground radius in pixels. |
min_res |
int16
|
Minimum resolution ring in pixels. |
max_res |
int16
|
Maximum resolution ring in pixels. |
pf8_detector_info |
TypeDetectorLayoutInformation
|
Detector layout information. |
bad_pixel_map_filename |
str
|
Path to the bad pixels map (mask). |
bad_pixel_map_hdf5_path |
str
|
Key to acess the bad pixel map (mask). |
pixel_maps |
TypePixelMaps
|
Map of the pixels positions in the laboratory coordinates. |
pixel_resolution |
float
|
Reciprocal of the pixel size (1/m). |
geometry_txt |
list
|
Content of the geometry file (.geom), in CrystFEL format. |
Source code in bblib/models.py
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 94 95 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 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 |
|
get(parameter)
This module return the peakfinder8 parameters.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
parameter
|
str
|
Peakfinder8 parameter. |
required |
Source code in bblib/models.py
get_detector_center()
This module return the detector center in x/y.
Returns:
Name | Type | Description |
---|---|---|
center |
list
|
The detector center in x/y. |
Source code in bblib/models.py
set_geometry_from_file(geometry_filename=None)
This module sets the class attributes in accordance with the CrystFEL geometry file (.geom).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
geometry_filename
|
str
|
Path to the CrystFEL geometry file (.geom). |
None
|
Source code in bblib/models.py
85 86 87 88 89 90 91 92 93 94 95 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 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
|
update_pixel_maps(detector_shift_x, detector_shift_y)
This module checks whether the pixel maps have been shifted. If not, it shifts the entire detector along the x and y axes by the specified values.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
detector_shift_x
|
int
|
Number of pixels to shift the entire detector in the x-axis, according to the CXI coordinate system. |
required |
detector_shift_y
|
int
|
Number of pixels to shift the entire detector in the y-axis, according to the CXI coordinate system. |
required |