Donut Models¶
Models for fitting single or multiple out-of-focus (donut) stellar images.
Base class¶
danish.donut_model.BaseDonutModel ¶
Base class for donut models.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
factory
|
DonutFactoryBase
|
|
required |
bkg_order
|
int
|
Order of polynomial background model to use. If -1, no background. |
required |
npix
|
int
|
Number of pixels along image edge. Must be odd. |
required |
seed
|
int
|
Random seed for use when creating noisy donut images. |
required |
atm_mode
|
str
|
Atmospheric PSF parameterization. 'fwhm' for scalar FWHM (default), 'ixx' for second moment tensor (Ixx, Ixy, Iyy) in arcsec^2. |
'fwhm'
|
Source code in danish/donut_model.py
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 | |
Single-donut model¶
danish.donut_model.SingleDonutModel ¶
Bases: BaseDonutModel
Model individual donuts using single Zernike offsets to a reference single Zernike series.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
factory
|
DonutFactoryBase
|
|
required |
bkg_order
|
int
|
Order of polynomial background model to use. If -1, no background. |
-1
|
z_ref
|
array of float
|
Constant reference Zernike coefs to add to fitted coefficients. [0] is ignored, [1] is piston, [4] is defocus, etc. |
None
|
x_offset
|
Zernike
|
Additional pupil distortion coefficients. |
None
|
y_offset
|
Zernike
|
Additional pupil distortion coefficients. |
None
|
z_terms
|
sequence of int
|
Which Zernike coefficients to include in the fit. E.g., [4,5,6,11] will fit defocus, astigmatism, and spherical. |
()
|
thx
|
float
|
Field angle in radians. |
None
|
thy
|
float
|
Field angle in radians. |
None
|
npix
|
int
|
Number of pixels along image edge. Must be odd. |
181
|
seed
|
int
|
Random seed for use when creating noisy donut images with this class. |
57721
|
Source code in danish/donut_model.py
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 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 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 | |
model ¶
Compute donut model image.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
flux
|
float
|
Flux level at which to set image. |
required |
dx
|
float
|
Offset in arcseconds. |
required |
dy
|
float
|
Offset in arcseconds. |
required |
fwhm
|
float
|
Full width half maximum of Kolmogorov kernel. |
required |
z_fit
|
sequence of float
|
Zernike perturbations. |
required |
bkg
|
sequence of float
|
Background polynomial coefficients. |
()
|
sky_level
|
float
|
Sky level to use when adding Poisson noise to image. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
img |
array of float
|
Model image. |
Source code in danish/donut_model.py
pack_params ¶
Pack parameters into a single tuple for optimization.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
flux
|
float
|
Flux level at which to set image. |
required |
dx
|
float
|
Offset in arcseconds. |
required |
dy
|
float
|
Offset in arcseconds. |
required |
fwhm
|
float
|
Full width half maximum of Kolmogorov kernel. |
required |
z_fit
|
array of float
|
Zernike perturbations. |
required |
bkg
|
array of float
|
Background polynomial coefficients. |
()
|
Returns:
| Type | Description |
|---|---|
tuple of float
|
Packed parameters. |
Source code in danish/donut_model.py
unpack_params ¶
Unpack parameters from the single tuple used for optimization.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
params
|
sequence of float
|
Packed parameters tuple as returned by |
required |
Returns:
| Type | Description |
|---|---|
dict
|
Dictionary with keys 'flux', 'dx', 'dy', 'fwhm', 'z_fit', and 'bkg'. |
Source code in danish/donut_model.py
chi ¶
Compute chi = (data - model)/error.
The error is modeled as sqrt(model + var).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
params
|
sequence of float
|
Order is: (flux, dx, dy, fwhm, z_fit, bkg) |
required |
data
|
array of float (npix, npix)
|
Image against which to compute chi. |
required |
var
|
float or array of float (npix, npix)
|
Variance of the sky only. Do not include Poisson contribution of the signal, as this will be added from the current model. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
chi |
array of float
|
Flattened array of chi residuals. |
Source code in danish/donut_model.py
jac ¶
Compute jacobian d(chi)/d(param).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
params
|
sequence of float
|
Order is: (flux, dx, dy, fwhm, z_fit, bkg) |
required |
data
|
array of float
|
Image against which to compute chi. |
required |
var
|
float or array of float (npix, npix)
|
Variance of the sky only. Do not include Poisson contribution of the signal, as this will be added from the current model. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
jac |
array of float
|
Jacobian array d(chi)/d(param). First dimension is pixels, second dimension is param. |
Source code in danish/donut_model.py
Multi-donut models¶
danish.donut_model.DZMultiDonutModel ¶
Bases: BaseMultiDonutModel
Multi donut model that uses double Zernike coefficients to parameterize the wavefront.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
factory
|
DonutFactoryBase
|
|
required |
dz_terms
|
sequence of tuple of int
|
List of (k, j) indices specifying which double Zernike terms to use. |
()
|
bkg_order
|
int
|
Order of the background polynomial to fit. If -1, no background. |
required |
dz_ref
|
DoubleZernike
|
Double Zernike coefficients to use for constructing Single Zernike
reference coefficients to use for each modeled donut. Either this kwarg
or |
required |
z_refs
|
array of float
|
Single Zernike reference coefficients for each donut. First dimension is donut, second dimension is pupil Zernike coefficient. |
required |
field_radius
|
float
|
Field radius in radians. If dz_ref is provided, then this is ignored and the field radius will be inferred from dz_ref. |
required |
thxs
|
float
|
Field angles in radians. |
required |
thys
|
float
|
Field angles in radians. |
required |
npix
|
int
|
Number of pixels along image edge. Must be odd. |
required |
seed
|
int
|
Random seed for use when creating noisy donut images with this class. |
required |
Source code in danish/donut_model.py
danish.donut_model.DZBasisMultiDonutModel ¶
Bases: BaseMultiDonutModel
Multi donut model that uses a sensitivity matrix to convert mode coefficients into double Zernike coefficients to parameterize the wavefront.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
factory
|
DonutFactoryBase
|
|
required |
sensitivity
|
array of float
|
Sensitivity matrix that converts mode coefficients into double Zernike coefficients. Dimensions are (nmode, k_max+1, j_max+1) |
None
|
bkg_order
|
int
|
Order of the background polynomial to fit. If -1, no background. |
required |
dz_ref
|
DoubleZernike
|
Double Zernike coefficients to use for constructing Single Zernike
reference coefficients to use for each modeled donut. Either this kwarg
or |
required |
z_refs
|
array of float
|
Single Zernike reference coefficients for each donut. First dimension is donut, second dimension is pupil Zernike coefficient. |
required |
field_radius
|
float
|
Field radius in radians. If dz_ref is provided, then this is ignored and the field radius will be inferred from dz_ref. |
required |
thxs
|
float
|
Field angles in radians. |
required |
thys
|
float
|
Field angles in radians. |
required |
npix
|
int
|
Number of pixels along image edge. Must be odd. |
required |
seed
|
int
|
Random seed for use when creating noisy donut images with this class. |
required |