Skip to content

ToCanonical

ToCanonical

Bases: ToOrientation

Reorder the data to be closest to canonical (RAS+) orientation.

This transform reorders the voxels and modifies the affine matrix so that the voxel orientations are nearest to:

  1. First voxel axis goes from left to Right
  2. Second voxel axis goes from posterior to Anterior
  3. Third voxel axis goes from inferior to Superior

See NiBabel docs about image orientation for more information.

Parameters:

Name Type Description Default
**kwargs

See Transform for additional keyword arguments.

 {}
Note

The reorientation is performed using ToOrientation().

__call__(data) 

__call__(data: Subject) -> Subject

__call__(data: ImageT) -> ImageT

__call__(data: torch.Tensor) -> torch.Tensor

__call__(data: np.ndarray) -> np.ndarray

__call__(data: sitk.Image) -> sitk.Image

__call__(data: dict[str, object]) -> dict[str, object]

__call__(data: nib.Nifti1Image) -> nib.Nifti1Image

Transform data and return a result of the same type.

Parameters:

Name Type Description Default
data TypeTransformInput

Instance of torchio.Subject, 4D torch.Tensor or numpy.ndarray with dimensions \((C, W, H, D)\), where \(C\) is the number of channels and \(W, H, D\) are the spatial dimensions. If the input is a tensor, the affine matrix will be set to identity. Other valid input types are a SimpleITK image, a torchio.Image, a NiBabel Nifti1 image or a dict. The output type is the same as the input type.

 required

to_hydra_config()

Return a dictionary representation of the transform for Hydra instantiation.