register_pet#

petpal.preproc.register.register_pet(input_reg_image_path: str, out_image_path: str, reference_image_path: str, motion_target_option: str | tuple, verbose: bool, type_of_transform: str = 'DenseRigid', **kwargs)#

Computes and runs rigid registration of 4D PET image series to 3D anatomical image, typically a T1 MRI. Runs rigid registration module from Advanced Normalisation Tools (ANTs) with default inputs. Will upsample PET image to the resolution of anatomical imaging.

Parameters:

  • input_reg_image_path (str) – Path to a .nii or .nii.gz file containing a 4D PET image to be registered to anatomical space.

  • reference_image_path (str) – Path to a .nii or .nii.gz file containing a 3D anatomical image to which PET image is registered.

  • motion_target_option (str | tuple) – Target image for computing transformation. See determine_motion_target().

  • type_of_transform (str) – Type of transform to perform on the PET image, must be one of antspy’s transformation types, i.e. ‘DenseRigid’ or ‘Translation’. Any transformation type that uses >6 degrees of freedom is not recommended, use with caution. See ants.registration().

  • out_image_path (str) – Path to a .nii or .nii.gz file to which the registered PET series is written.

  • verbose (bool) – Set to True to output processing information.

  • kwargs (keyword arguments) – Additional arguments passed to ants.registration().

On this page

This Page