SpatioTemporalTraits

assert_timedim_last(x)

Throw an error if the x has a time dimension that is not the last dimension.

depth(x)

Returns the size of the dimension corresponding to depth.

duration(x)

Duration of the event along the time axis.

has_timedim(x) -> Bool

Returns 'true' if x has a time dimension.

height(x)

Returns the size of the dimension corresponding to height.

is_spatial(x::StaticSymbol) -> StaticBool

Returns static(true) if x refers to a spatial dimension. By default, any dimension that is not one of the following is considered spatial:

• time, Time
• channels, Channels
• observations, Observations, obs

is_temporal(x) -> StaticBool

Returns True if x refers to time.

ntimes(x) -> Integer

Returns the number of elements along the time dimension.

origin(x) -> Tuple

Returns the spatial origin of x.

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_indices.

sampling_rate(x)

Number of samples per second.

sdims(x) -> Int

Return the number of spatial dimensions that x has.

See also: spatialdims, is_spatial

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 ImageMeta.

spatial_first(x)

The first position along each spatial indices (i.e., where each spatial axis starts).

spatial_indices(x)

Returns the keys along each spatial dimension.

spatial_last(x)

The last position along each spatial indices (i.e., where each spatial axis stops).

spatial_order(x) -> Tuple

Returns the dimnames of x that correspond to spatial dimensions, as determined by is_spatial. At most three dimensions will be considered spatial.

spatial_units(x)

Returns the Unitful.unit along all spaial dimensions.

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

Return a tuple of the spatial dimensions of x.

temporal_units(x)

Returns the Unitful.unit along the time dimensions.

time_first(x)

First time point along the time axis.

time_last(x)

Last time point along the time axis.

time_step(x)

The time step/interval between each element.

timedim(::Type{T}) -> Integer

Returns the dimension associated with time.

times(x)

Returns a collection of times associated with x. If x has a specific dimension associated with time, this returns the keys along that dimension.

width(x)

Returns the size of the dimension corresponding to width.