fitting
check_params_model(param)
Check whether model parameters satisfy model constraints.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
param
|
dict
|
Model parameters, including the |
required |
Returns:
| Type | Description |
|---|---|
tuple[bool, str]
|
Whether parameters are valid and a validation message. |
Source code in src/amical/analysis/fitting.py
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 | |
comput_CP(X, param, model)
Compute closure phases for a model.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
X
|
sequence of array-like
|
Baseline coordinates and wavelength |
required |
param
|
dict
|
Model parameters. |
required |
model
|
callable
|
Complex-visibility model. |
required |
Returns:
| Type | Description |
|---|---|
ndarray
|
Closure phases in degrees. |
Source code in src/amical/analysis/fitting.py
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 | |
comput_V2(X, param, model)
Compute squared visibility for a model.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
X
|
sequence of array-like
|
Spatial-frequency coordinates |
required |
param
|
dict
|
Model parameters. |
required |
model
|
callable
|
Complex-visibility model. |
required |
Returns:
| Type | Description |
|---|---|
ndarray or int
|
Squared visibility, or |
Source code in src/amical/analysis/fitting.py
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 | |
compute_chi2_curve(obs, name_param, params, array_params, fitOnly, normalizeErrors=False, fitCP=True, onlyCP=False, ymin=0, ymax=3)
Compute a one-dimensional reduced-chi-square curve.
The curve estimates pessimistic, fully correlated uncertainty for one model parameter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
obs
|
array - like
|
Selected fitting observations. |
required |
name_param
|
str
|
Parameter for which to calculate the curve. |
required |
params
|
dict
|
Model parameters. |
required |
array_params
|
ndarray
|
Parameter values used to calculate the curve. |
required |
fitOnly
|
list of str
|
Parameters to fit. This list is modified in place to remove |
required |
normalizeErrors
|
bool
|
Whether to normalize V2 and CP errors. |
False
|
fitCP
|
bool
|
Whether to fit closure-phase data. |
True
|
onlyCP
|
bool
|
Whether to fit only closure-phase data. |
False
|
ymin
|
float
|
Lower normalized vertical extent for uncertainty shading. |
0
|
ymax
|
float
|
Upper normalized vertical extent for uncertainty shading. |
3
|
Returns:
| Type | Description |
|---|---|
tuple[dict, float] or None
|
Initial fit and chi-square-curve uncertainty, or |
Source code in src/amical/analysis/fitting.py
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 | |
engine_multi_proc(inputs)
Compute one model datum for multiprocessing.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
inputs
|
sequence
|
Model coordinates, observable type, and model parameters. |
required |
Returns:
| Type | Description |
|---|---|
scalar
|
Modelled observable, |
Source code in src/amical/analysis/fitting.py
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 | |
fits2obs(inputdata, use_flag=True, cond_wl=False, wl_min=None, wl_max=None, cond_uncer=False, rel_max=None, extra_error_v2=0, extra_error_cp=0, err_scale=1, input_rad=False, verbose=True)
Convert selected OIFITS observables to fitting observations.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
inputdata
|
str
|
OIFITS file name. |
required |
use_flag
|
bool
|
Whether to exclude data flagged in the OIFITS file. |
True
|
cond_wl
|
bool
|
Whether to restrict wavelengths to |
False
|
wl_min
|
float or None
|
Lower wavelength limit in micrometres. |
None
|
wl_max
|
float or None
|
Upper wavelength limit in micrometres. |
None
|
cond_uncer
|
bool
|
Whether to filter data by relative uncertainty. |
False
|
rel_max
|
float or None
|
Maximum allowed relative uncertainty in percent. |
None
|
extra_error_v2
|
float
|
Additive squared-visibility uncertainty. |
0
|
extra_error_cp
|
float
|
Additive closure-phase uncertainty. |
0
|
err_scale
|
float
|
Multiplicative closure-phase uncertainty scale. |
1
|
input_rad
|
bool
|
Whether closure phases and their uncertainties are expressed in radians. |
False
|
verbose
|
bool
|
Whether to print data-selection information. |
True
|
Returns:
| Type | Description |
|---|---|
ndarray
|
Object array of selected coordinates, observable types, values, and uncertainties. |
Source code in src/amical/analysis/fitting.py
252 253 254 255 256 257 258 259 260 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 | |
model_parallelized(obs, param, ncore=12)
Compute model values for all observations using multiprocessing.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
obs
|
array - like
|
Observation rows containing coordinates and observable types. |
required |
param
|
dict
|
Model parameters. |
required |
ncore
|
int
|
Number of worker processes. |
12
|
Returns:
| Type | Description |
|---|---|
ndarray
|
Model values for the observations. |
Source code in src/amical/analysis/fitting.py
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 | |
model_standard(obs, param)
Compute model values for all observations serially.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
obs
|
array - like
|
Observation rows containing coordinates and observable types. |
required |
param
|
dict
|
Model parameters. |
required |
Returns:
| Type | Description |
|---|---|
ndarray
|
Model values for the observations. |
Source code in src/amical/analysis/fitting.py
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 | |
plot_model(inputdata, param, save=False, outputfile=None, extra_error_v2=0, extra_error_cp=0, err_scale=1, d_freedom=3, v2_min=None, v2_max=1.1, cp_max=None, unit='m')
Plot V2 and CP model predictions, data, and residuals.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
inputdata
|
str
|
OIFITS file name. |
required |
param
|
dict
|
Model parameters, such as the |
required |
save
|
bool
|
Whether to save the figure. |
False
|
outputfile
|
str or None
|
Filename for the saved figure. |
None
|
extra_error_v2
|
float
|
Additive squared-visibility uncertainty. |
0
|
extra_error_cp
|
float
|
Additive closure-phase uncertainty. |
0
|
err_scale
|
float
|
Multiplicative closure-phase uncertainty scale. |
1
|
d_freedom
|
int
|
Number of model degrees of freedom. |
3
|
v2_min
|
float or None
|
Lower squared-visibility axis limit. |
None
|
v2_max
|
float
|
Upper squared-visibility axis limit. |
1.1
|
cp_max
|
float or None
|
Absolute closure-phase axis limit. |
None
|
unit
|
(m, 'lambda', arcsec)
|
Spatial-frequency unit. |
"m"
|
Returns:
| Type | Description |
|---|---|
tuple[ndarray, ndarray, float]
|
Model squared visibilities, model closure phases, and reduced chi-square. |
Source code in src/amical/analysis/fitting.py
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 | |
select_model(name)
Select a Fourier-space model by name.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
Model identifier. |
required |
Returns:
| Type | Description |
|---|---|
callable or None
|
Matching visibility-model function, or |
Source code in src/amical/analysis/fitting.py
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 | |
smartfit(obs, first_guess, doNotFit=None, fitOnly=None, follow=None, multiproc=False, ftol=0.0001, epsfcn=1e-07, normalizeErrors=False, scale_err=1, fitCP=True, onlyCP=False, verbose=True)
Fit V2 and CP data contained in observations.
.. deprecated::
smartfit is deprecated and will be removed in a future release. Fit
the calibrated OIFITS file with virgil instead
(pip install amical[virgil]).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
obs
|
ndarray
|
Selected fitting observations. |
required |
first_guess
|
dict
|
Initial model parameters. |
required |
doNotFit
|
list of str or None
|
Parameters excluded from fitting. |
None
|
fitOnly
|
list of str or None
|
Parameters to fit; defaults to all numeric parameters. |
None
|
follow
|
list of str or None
|
Parameters to print in verbose mode. |
None
|
multiproc
|
bool
|
Whether to evaluate models using multiprocessing. |
False
|
ftol
|
float
|
Relative fit-tolerance threshold. |
0.0001
|
epsfcn
|
float
|
Finite-difference step used by the optimizer. |
1e-07
|
normalizeErrors
|
bool
|
Whether to normalize V2 and CP errors. |
False
|
scale_err
|
float
|
Multiplicative scale for fitting uncertainties. |
1
|
fitCP
|
bool
|
Whether to fit closure-phase data. |
True
|
onlyCP
|
bool
|
Whether to fit only closure-phase data. |
False
|
verbose
|
bool
|
Whether to print fitting information. |
True
|
Returns:
| Type | Description |
|---|---|
dict
|
Result returned by :func: |
Source code in src/amical/analysis/fitting.py
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 | |