def ants_combine_transform(in_file, transforms_list, reference):
"""
Apply a transformation obtained with antsRegistrationSyNQuick.sh.
This function applies a rigid & deformable B-Spline syn transformation
which has been estimated previously with antsRegistrationSyNQuick script.
Args:
in_file (str): File containing the input image to be transformed.
reference (str): File defining the spacing, origin, size, and
direction of the output warped image.
transforms_list (str): File containing the transformations
obtained by antsRegistrationSyNQuick.
Returns:
out_warp (str): File containing the deformed image according to
transforms_list in_affine_transformation and
in_bspline_transformation transformations.
"""
import os
from clinica.utils.check_dependency import check_ants
check_ants()
out_warp = os.path.abspath('out_warp.nii.gz')
transforms = ""
for trans in transforms_list:
transforms += " " + trans
cmd = 'antsApplyTransforms -o [out_warp.nii.gz,1] -i %s -r %s -t %s' % \
(in_file, reference, transforms)
os.system(cmd)
return out_warp
def ants_registration_syn_quick(fix_image, moving_image, prefix_output=None):
"""
Small wrapper for antsRegistrationSyNQuick.sh.
This function calls antsRegistrationSyNQuick.sh in order to register
non-linearly moving_image towards fix_image.
Args:
fix_image (str): The target image.
moving_image (str): The source
prefix_output (str): Prefix for output files
(format: <prefix_output>[Warped|0GenericAffine|1Warp|
InverseWarped|1InverseWarp])
Returns:
The deformed image with the deformation parameters.
"""
import os
from clinica.utils.check_dependency import check_ants
check_ants()
if prefix_output is None:
prefix_output = 'SyN_Quick'
image_warped = os.path.abspath(prefix_output + 'Warped.nii.gz')
affine_matrix = os.path.abspath(prefix_output + '0GenericAffine.mat')
warp = os.path.abspath(prefix_output + '1Warp.nii.gz')
inverse_warped = os.path.abspath(prefix_output + 'InverseWarped.nii.gz')
inverse_warp = os.path.abspath(prefix_output + '1InverseWarp.nii.gz')
cmd = 'antsRegistrationSyNQuick.sh -t b -d 3 -f %s -m %s -o %s' \
% (fix_image, moving_image, prefix_output)
os.system(cmd)
return image_warped, affine_matrix, warp, inverse_warped, inverse_warp
def apply_ants_registration_syn_quick_transformation(
in_image,
in_reference_image,
in_affine_transformation,
in_bspline_transformation,
name_output_image=None,
):
"""Apply a transformation obtained with antsRegistrationSyNQuick.sh.
This function applies a rigid & deformable B-Spline syn transformation
which has been estimated previously with antsRegistrationSyNQuick script.
Args:
in_image (str): File containing the input image to be transformed.
in_reference_image (str): File defining the spacing, origin, size,
and direction of the output warped image.
in_affine_transformation (str): File containing the transformation
matrix obtained by antsRegistrationSyNQuick (expected file:
[Prefix]0GenericAffine.mat).
in_bspline_transformation (str): File containing the transformation
matrix obtained by antsRegistrationSyNQuick (expected file:
[Prefix]1Warp.nii.gz).
name_output_image (Optional[str]): Name of the output image
(default=deformed_image.nii.gz).
Returns:
out_deformed_image (str): File containing the deformed image according
to in_affine_transformation and in_bspline_transformation
transformations.
"""
import os
from clinica.utils.check_dependency import check_ants
check_ants()
assert os.path.isfile(in_image)
assert os.path.isfile(in_affine_transformation)
assert os.path.isfile(in_bspline_transformation)
if name_output_image is None:
out_deformed_image = os.path.abspath("deformed_image.nii.gz")
else:
out_deformed_image = os.path.abspath(name_output_image)
cmd = (
f"antsApplyTransforms -d 3 -e 0 -i {in_image} -o {out_deformed_image} "
f"-t {in_bspline_transformation} -t {in_affine_transformation} "
f"-r {in_reference_image} --interpolation Linear")
os.system(cmd)
return out_deformed_image
def preprocessing_t1w(bids_directory,
caps_directory,
tsv,
working_directory=None):
"""
This preprocessing pipeline includes globally three steps:
1) N4 bias correction (performed with ANTS).
2) Linear registration to MNI (MNI icbm152 nlinear sym template)
(performed with ANTS) - RegistrationSynQuick.
3) Cropping the background (in order to save computational power).
4) Histogram-based intensity normalization. This is a custom function
performed by the binary ImageMath included with ANTS.
Parameters
----------
bids_directory: str
Folder with BIDS structure.
caps_directory: str
Folder where CAPS structure will be stored.
working_directory: str
Folder containing a temporary space to save intermediate results.
"""
from os.path import dirname, join, abspath, split, exists
from os import pardir, makedirs
from pathlib import Path
from clinica.utils.inputs import check_bids_folder
from clinica.utils.participant import get_subject_session_list
from clinica.utils.filemanip import get_subject_id
from clinica.utils.exceptions import ClinicaBIDSError, ClinicaException
from clinica.utils.inputs import clinica_file_reader
from clinica.utils.input_files import T1W_NII
from clinica.utils.check_dependency import check_ants
from clinicadl.tools.inputs.input import fetch_file
from clinicadl.tools.inputs.input import RemoteFileStructure
import nipype.pipeline.engine as npe
import nipype.interfaces.utility as nutil
from nipype.interfaces import ants
check_ants()
check_bids_folder(bids_directory)
input_dir = abspath(bids_directory)
caps_directory = abspath(caps_directory)
is_bids_dir = True
base_dir = abspath(working_directory)
home = str(Path.home())
cache_clinicadl = join(home, '.cache', 'clinicadl', 'ressources', 'masks')
url_aramis = 'https://aramislab.paris.inria.fr/files/data/img_t1_linear/'
FILE1 = RemoteFileStructure(
filename='ref_cropped_template.nii.gz',
url=url_aramis,
checksum=
'67e1e7861805a8fd35f7fcf2bdf9d2a39d7bcb2fd5a201016c4d2acdd715f5b3')
FILE2 = RemoteFileStructure(
filename='mni_icbm152_t1_tal_nlin_sym_09c.nii',
url=url_aramis,
checksum=
'93359ab97c1c027376397612a9b6c30e95406c15bf8695bd4a8efcb2064eaa34')
if not (exists(cache_clinicadl)):
makedirs(cache_clinicadl)
ref_template = join(cache_clinicadl, FILE2.filename)
ref_crop = join(cache_clinicadl, FILE1.filename)
if not (exists(ref_template)):
try:
ref_template = fetch_file(FILE2, cache_clinicadl)
except IOError as err:
print(
'Unable to download required template (mni_icbm152) for processing:',
err)
if not (exists(ref_crop)):
try:
ref_crop = fetch_file(FILE1, cache_clinicadl)
except IOError as err:
print(
'Unable to download required template (ref_crop) for processing:',
err)
sessions, subjects = get_subject_session_list(input_dir, tsv, is_bids_dir,
False, base_dir)
# Use hash instead of parameters for iterables folder names
# Otherwise path will be too long and generate OSError
from nipype import config
cfg = dict(execution={'parameterize_dirs': False})
config.update_config(cfg)
# Inputs from anat/ folder
# ========================
# T1w file:
try:
t1w_files = clinica_file_reader(subjects, sessions, bids_directory,
T1W_NII)
except ClinicaException as e:
err = 'Clinica faced error(s) while trying to read files in your CAPS directory.\n' + str(
e)
raise ClinicaBIDSError(err)
def get_input_fields():
""""Specify the list of possible inputs of this pipelines.
Returns:
A list of (string) input fields name.
"""
return ['t1w']
read_node = npe.Node(
name="ReadingFiles",
iterables=[
('t1w', t1w_files),
],
synchronize=True,
interface=nutil.IdentityInterface(fields=get_input_fields()))
image_id_node = npe.Node(interface=nutil.Function(
input_names=['bids_or_caps_file'],
output_names=['image_id'],
function=get_subject_id),
name='ImageID')
# The core (processing) nodes
# 1. N4biascorrection by ANTS. It uses nipype interface.
n4biascorrection = npe.Node(name='n4biascorrection',
interface=ants.N4BiasFieldCorrection(
dimension=3,
save_bias=True,
bspline_fitting_distance=600))
# 2. `RegistrationSynQuick` by *ANTS*. It uses nipype interface.
ants_registration_node = npe.Node(name='antsRegistrationSynQuick',
interface=ants.RegistrationSynQuick())
ants_registration_node.inputs.fixed_image = ref_template
ants_registration_node.inputs.transform_type = 'a'
ants_registration_node.inputs.dimension = 3
# 3. Crop image (using nifti). It uses custom interface, from utils file
from .T1_linear_utils import crop_nifti
cropnifti = npe.Node(name='cropnifti',
interface=nutil.Function(
function=crop_nifti,
input_names=['input_img', 'ref_crop'],
output_names=['output_img', 'crop_template']))
cropnifti.inputs.ref_crop = ref_crop
# ********* Deprecrecated ********** #
# ** This step was not used in the final version ** #
# 4. Histogram-based intensity normalization. This is a custom function
# performed by the binary `ImageMath` included with *ANTS*.
# from .T1_linear_utils import ants_histogram_intensity_normalization
#
# # histogram-based intensity normalization
# intensitynorm = npe.Node(
# name='intensitynormalization',
# interface=nutil.Function(
# input_names=['image_dimension', 'crop_template', 'input_img'],
# output_names=['output_img'],
# function=ants_histogram_intensity_normalization
# )
# )
# intensitynorm.inputs.image_dimension = 3
# DataSink and the output node
from .T1_linear_utils import (container_from_filename, get_data_datasink)
# Create node to write selected files into the CAPS
from nipype.interfaces.io import DataSink
get_ids = npe.Node(interface=nutil.Function(
input_names=['image_id'],
output_names=['image_id_out', 'subst_ls'],
function=get_data_datasink),
name="GetIDs")
# Find container path from t1w filename
# =====================================
container_path = npe.Node(nutil.Function(
input_names=['bids_or_caps_filename'],
output_names=['container'],
function=container_from_filename),
name='ContainerPath')
write_node = npe.Node(name="WriteCaps", interface=DataSink())
write_node.inputs.base_directory = caps_directory
write_node.inputs.parameterization = False
# Connectiong the workflow
from clinica.utils.nipype import fix_join
wf = npe.Workflow(name='t1_linear_dl', base_dir=working_directory)
wf.connect([
(read_node, image_id_node, [('t1w', 'bids_or_caps_file')]),
(read_node, container_path, [('t1w', 'bids_or_caps_filename')]),
(image_id_node, ants_registration_node, [('image_id', 'output_prefix')
]),
(read_node, n4biascorrection, [("t1w", "input_image")]),
(n4biascorrection, ants_registration_node, [('output_image',
'moving_image')]),
(ants_registration_node, cropnifti, [('warped_image', 'input_img')]),
(ants_registration_node, write_node, [('out_matrix', '@affine_mat')]),
# Connect to DataSink
(container_path, write_node, [(('container', fix_join, 't1_linear'),
'container')]),
(image_id_node, get_ids, [('image_id', 'image_id')]),
(get_ids, write_node, [('image_id_out', '@image_id')]),
(get_ids, write_node, [('subst_ls', 'substitutions')]),
# (get_ids, write_node, [('regexp_subst_ls', 'regexp_substitutions')]),
(n4biascorrection, write_node, [('output_image', '@outfile_corr')]),
(ants_registration_node, write_node, [('warped_image', '@outfile_reg')
]),
(cropnifti, write_node, [('output_img', '@outfile_crop')]),
])
return wf
