Unitful integration

Time lookups and values can carry Unitful units. Units propagate through most operations; helpers below extract or strip them.

using TimeseriesTools, Unitful
t = (0.0:0.01:1.0) * u"s"
x = Timeseries(sin.(ustrip.(t)), t) * u"V"
timeunit(x), unit(eltype(x)), dimunit(x, 𝑡)

(s, V, s)

ustripall recursively strips units from values and lookups, returning a plain ToolsArray. Use it when handing data to a unit-unaware backend, then re-attach with * u.

Reference

TimeseriesBase.UnitfulTools.dimunit Function

dimunit(x::UnitfulTimeseries, dim)

Returns the unit associated with the specified dimension dim of a UnitfulTimeseries.

Examples

julia> using Unitful;
julia> t = 1:100;
julia> x = rand(100);
julia> ts = Timeseries(x, (t)u"ms");
julia> TimeseriesBase.dimunit(ts, 𝑡) == u"ms"

source

TimeseriesBase.UnitfulTools.timeunit Function

timeunit(x::UnitfulTimeseries)

Returns the time units associated with a [UnitfulTimeseries].

Examples

julia> using Unitful;
julia> t = 1:100;
julia> x = rand(100);
julia> ts = Timeseries(x, (t)u"ms");
julia> timeunit(ts) == u"ms"

source

TimeseriesBase.UnitfulTools.frequnit Function

frequnit(x::UnitfulSpectrum)

Returns the frequency units associated with a UnitfulSpectrum.

Examples

julia> using Unitful;
julia> t = 1:100;
julia> x = rand(100);
julia> ts = Timeseries(x, (t)u"ms");
julia> sp = fft(ts);  # assuming fft returns a UnitfulSpectrum
julia> frequnits(sp) == u"Hz"

source

Unitful.unit Function

unit(x::AbstractArray)

Returns the units associated with the elements of an UnitfulTimeseries or UnitfulSpectrum.

Examples

julia> using Unitful;
julia> t = 1:100;
julia> x = rand(100);
julia> ts = Timeseries(x, (t)u"ms")*u"V";
julia> unit(ts) == u"V"

source

TimeseriesBase.UnitfulTools.UnitfulIndex Type

UnitfulIndex

A type alias for a union of AbstractArray, AbstractRange, and Tuple types with Unitful.Time elements.

source

TimeseriesBase.UnitfulTools.UnitfulTimeseries Type

UnitfulTimeseries{T, N, B}

A type alias for an AbstractToolsArray with a UnitfulTimeIndex.

Examples

julia> using Unitful;
julia> t = (1:100)u"s";
julia> x = rand(100);
julia> uts = Timeseries(x, t);
julia> uts isa UnitfulTimeseries

source

TimeseriesBase.UnitfulTools.UnitfulSpectrum Type

UnitfulSpectrum{T,N,B}

A type representing spectra with unitful frequency units.

source

Missing docstring.

Missing docstring for ustripall. Check Documenter's build log for details.