vreg.concatenate#
- vreg.concatenate(vols, axis=2, prec=None, move=False)[source]#
Join a sequence of volumes along x-, y-, or z-axis.
Volumes can only be joined up if they have the same shape (except along the axis of concatenation), the same orientation and the same voxel size.
- Parameters:
vols (sequence of volumes) – Volumes to concatenate.
axis (int, optional) – The axis along which the volumes will be concatenated (x, y or z). Defaults to 2 (z-axis).
prec (int, optional) – precision to consider when comparing positions and orientations of volumes. All differences are rounded off to this digit before comparing them to zero. If this is not specified, floating-point precision is used. Defaults to None.
move (bool, optional) – If this is set to True, the volumes are allowed to move to the correct positions for concatenation. In this case the first volume in the sequence will be fixed, and all others will move to align with it. If move=False, volumes can only be concatenated if they are already aligned in the direction of concatenation without gaps between them, and in the correct order. Defaults to False.
- Returns:
The concatenated volume.
- Return type: