Spatial API

pixel_spacing(x)

Return a tuple representing the separation between adjacent pixels along each axis of the image. Derived from the step size of each element of spatial_keys.

sdims(x)

Return the number of spatial dimensions in the image. Defaults to the same as ndims, but with NamedDimsArray you can specify that some dimensions correspond to other quantities (e.g., time) and thus not included by sdims.

spatial_axes(x, sz; kwargs...)

Returns an AxesIterator along the spatial axes.

spatial_axes(x) -> Tuple

Returns a tuple of each axis corresponding to a spatial dimensions.

spatial_directions(img) -> (axis1, axis2, ...)

Return a tuple-of-tuples, each axis[i] representing the displacement vector between adjacent pixels along spatial axis i of the image array, relative to some external coordinate system ("physical coordinates").

By default this is computed from pixel_spacing, but you can set this manually using ImagesMeta.

spatial_indices(x)

Return a tuple with the indices of the spatial dimensions of the image. Defaults to the same as indices, but using NamedDimsArray you can mark some axes as being non-spatial.

spatial_keys(x)

spatial_order(x) -> Tuple{Vararg{Symbol}}

Returns the dimnames of x that correspond to spatial dimensions.

spatial_size(x) -> Tuple{Vararg{Int}}

Return a tuple listing the sizes of the spatial dimensions of the image.

spatialdims(x) -> Tuple{Vararg{Int}}

Return a tuple listing the spatial dimensions of img. Note that a better strategy may be to use ImagesAxes and take slices along the time axis.

affine_map(x) -> AffineMap

Returns and affine map. By default using spatial_directions and pixel_spacing are used to constuct the mapping.

spatial_offset(x)

The offset of each dimension (i.e., where each spatial axis starts).