transform
lacuna.spatial.transform
¶
Transformation strategies for spatial coordinate space conversions.
InterpolationMethod
¶
Bases: str, Enum
Supported interpolation methods for spatial transformations.
Source code in src/lacuna/spatial/transform.py
TransformationStrategy
¶
Strategy for applying spatial transformations between coordinate spaces.
This class determines the optimal transformation direction and method for converting data between different coordinate spaces.
Source code in src/lacuna/spatial/transform.py
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 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 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 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 | |
apply_regrid(img, target_space, interpolation=None)
¶
Resample image to a different voxel grid in the same world coordinate system.
Unlike apply_resampling() which rescales the source affine, this method uses the TARGET space's reference affine and shape. This is needed when moving between 2009b and 2009c which share MNI world coordinates but have different voxel grids (origins differ by 2-6mm).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
img
|
Nifti1Image
|
Image to regrid. |
required |
target_space
|
CoordinateSpace
|
Target coordinate space (with correct reference affine). |
required |
interpolation
|
InterpolationMethod or None
|
Interpolation method override. |
None
|
Returns:
| Type | Description |
|---|---|
Nifti1Image
|
Regridded image in target voxel grid. |
Source code in src/lacuna/spatial/transform.py
apply_resampling(img, target_space, interpolation=None)
¶
Resample image to different resolution in same coordinate space.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
img
|
Nifti1Image
|
Image to resample. |
required |
target_space
|
CoordinateSpace
|
Target coordinate space (with desired resolution). |
required |
interpolation
|
InterpolationMethod or None
|
Interpolation method override. |
None
|
Returns:
| Type | Description |
|---|---|
Nifti1Image
|
Resampled image. |
Source code in src/lacuna/spatial/transform.py
apply_transformation(img, source, target, transform, interpolation=None)
¶
Apply spatial transformation to image data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
img
|
Nifti1Image
|
Image to transform. |
required |
source
|
CoordinateSpace
|
Source coordinate space. |
required |
target
|
CoordinateSpace
|
Target coordinate space. |
required |
transform
|
TransformChain
|
Nitransforms TransformChain (composite transform with affine + nonlinear). |
required |
interpolation
|
InterpolationMethod or None
|
Interpolation method (auto-detected if None). |
None
|
Returns:
| Type | Description |
|---|---|
Nifti1Image
|
Transformed image in target space. |
Raises:
| Type | Description |
|---|---|
TransformNotAvailableError
|
If transformation not supported. |
Source code in src/lacuna/spatial/transform.py
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 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 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 | |
determine_direction(source, target)
¶
Determine transformation direction based on source and target spaces.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
source
|
CoordinateSpace
|
Source coordinate space. |
required |
target
|
CoordinateSpace
|
Target coordinate space. |
required |
Returns:
| Type | Description |
|---|---|
str
|
"none" — no transformation needed "resample" — same space, different resolution "regrid" — 2009b ↔ 2009c (same world coords, different voxel grid) "forward" — NLin6 → NLin2009c (nonlinear warp) "reverse" — NLin2009c → NLin6 (nonlinear warp) "chain_forward" — NLin6 → 2009c → 2009b (warp then regrid) "chain_reverse" — 2009b → 2009c → NLin6 (regrid then warp) |
Raises:
| Type | Description |
|---|---|
TransformNotAvailableError
|
If transformation not supported. |
Source code in src/lacuna/spatial/transform.py
select_interpolation(img, method=None)
¶
Select appropriate interpolation method based on image data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
img
|
Nifti1Image
|
Image to transform. |
required |
method
|
InterpolationMethod or None
|
Override interpolation method (if None, auto-detect). |
None
|
Returns:
| Type | Description |
|---|---|
InterpolationMethod
|
Interpolation method to use. |
Source code in src/lacuna/spatial/transform.py
can_transform_between(source, target)
¶
Check if transformation is possible between two coordinate spaces.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
source
|
CoordinateSpace
|
Source coordinate space. |
required |
target
|
CoordinateSpace
|
Target coordinate space. |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if transformation is supported, False otherwise. |
Examples:
>>> from lacuna.core.spaces import CoordinateSpace, REFERENCE_AFFINES
>>> source = CoordinateSpace('MNI152NLin6Asym', 2, REFERENCE_AFFINES[('MNI152NLin6Asym', 2)])
>>> target = CoordinateSpace('MNI152NLin2009cAsym', 2, REFERENCE_AFFINES[('MNI152NLin2009cAsym', 2)])
>>> can_transform_between(source, target)
True
Source code in src/lacuna/spatial/transform.py
query_available_transforms()
¶
Query available spatial transformations.
Returns a list of supported (source_space, target_space) pairs: - Nonlinear warps: NLin6 ↔ 2009c (via TemplateFlow) - Regrid: 2009b ↔ 2009c (same world coords, different voxel grid) - Chained: NLin6 ↔ 2009b (warp via 2009c + regrid)
Returns:
| Type | Description |
|---|---|
list[tuple[str, str]]
|
List of (source, target) space identifier pairs. |
Examples:
>>> transforms = query_available_transforms()
>>> ('MNI152NLin6Asym', 'MNI152NLin2009cAsym') in transforms
True
>>> ('MNI152NLin2009bAsym', 'MNI152NLin2009cAsym') in transforms
True
Source code in src/lacuna/spatial/transform.py
transform_image(img, source_space, target_space, source_resolution=None, interpolation=None, image_name=None, verbose=False)
¶
Transform a NIfTI image between coordinate spaces.
This is a low-level, generic function for transforming any NIfTI image between coordinate spaces. Use this when working with atlases, templates, or other non-lesion images.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
img
|
Nifti1Image
|
NIfTI image to transform. |
required |
source_space
|
str
|
Source coordinate space identifier (e.g., "MNI152NLin6Asym"). |
required |
target_space
|
CoordinateSpace or str
|
Target coordinate space object or identifier string. |
required |
source_resolution
|
int or None
|
Source resolution in mm (default: infer from affine). |
None
|
interpolation
|
InterpolationMethod or str or None
|
Interpolation method (auto-detected if None). Can be InterpolationMethod enum or string ('nearest', 'linear', 'cubic'). Default: 'cubic' for continuous data, 'nearest' for binary/integer data. |
None
|
image_name
|
str or None
|
Name of image/atlas for user-facing log messages (e.g., "SchaeferYeo7Networks"). |
None
|
verbose
|
bool
|
If True, print progress messages. If False, run silently. |
False
|
Returns:
| Type | Description |
|---|---|
Nifti1Image
|
Transformed NIfTI image in target space. |
Raises:
| Type | Description |
|---|---|
TransformNotAvailableError
|
If transformation not supported. |
Notes:
|
To save intermediate warped images for QC, use analysis classes with keep_intermediate=True. The warped mask will be stored in the results dictionary under the analysis namespace. |
Examples:
|
|
Source code in src/lacuna/spatial/transform.py
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 654 655 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 | |
transform_mask_data(mask_data, target_space, interpolation=None, image_name=None, verbose=False)
¶
Transform lesion data to target coordinate space.
This is the high-level API for transforming SubjectData objects between coordinate spaces. It handles: - Space detection and validation - Transform loading and caching - Transformation application - Provenance tracking
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mask_data
|
SubjectData
|
SubjectData object to transform. |
required |
target_space
|
CoordinateSpace
|
Target coordinate space. |
required |
interpolation
|
InterpolationMethod or str or None
|
Interpolation method (auto-detected if None). Can be InterpolationMethod enum or string ('nearest', 'linear', 'cubic'). Default: 'nearest' for binary masks (preserves mask integrity). |
None
|
image_name
|
str or None
|
Name of mask for user-facing log messages (e.g., "lesion_001"). |
None
|
verbose
|
bool
|
If True, print progress messages. If False, run silently. |
False
|
Returns:
| Type | Description |
|---|---|
SubjectData
|
New SubjectData object in target space. |
Raises:
| Type | Description |
|---|---|
TransformNotAvailableError
|
If transformation not supported. |
SpaceDetectionError
|
If source space cannot be determined. |
Notes:
|
To save intermediate warped images for QC, use analysis classes with
keep_intermediate=True. The warped mask will be stored in the results
dictionary under the analysis namespace as |
Examples:
|
|
Source code in src/lacuna/spatial/transform.py
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 824 825 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 | |