TimeseriesMakie.Kinetic Type
Kinetic
is the plot type associated with plotting function kinetic
. Check the docstring for kinetic
for further information.
TimeseriesMakie.Shadows Type
Shadows
is the plot type associated with plotting function shadows
. Check the docstring for shadows
for further information.
TimeseriesMakie.Traces Type
Traces
is the plot type associated with plotting function traces
. Check the docstring for traces
for further information.
TimeseriesMakie.Trail Type
Trail
is the plot type associated with plotting function trail
. Check the docstring for trail
for further information.
TimeseriesMakie.Trajectory Type
Trajectory
is the plot type associated with plotting function trajectory
. Check the docstring for trajectory
for further information.
TimeseriesMakie.kinetic Function
kinetic(x, y; kwargs...)
Plots a line with a varying width.
Key attribtues:
linewidth
= :curv
:
Sets the algorithm for determining the line width.
:curv
- Width is determined by the velocity:x
- Width is determined by the x-coordinate:y
- Width is determined by the y-coordinate<: Number
- Width is set to a constant value
linewidthscale
= 1
: Scale factor for the line width.
Other attributes are shared with Makie.Lines
.
Plot type
The plot type alias for the kinetic
function is Kinetic
.
Attributes
alpha
= 1.0
— The alpha value of the colormap or color attribute. Multiple alphas like in plot(alpha=0.2, color=(:red, 0.5)
, will get multiplied.
clip_planes
= @inherit clip_planes automatic
— Clip planes offer a way to do clipping in 3D space. You can set a Vector of up to 8 Plane3f
planes here, behind which plots will be clipped (i.e. become invisible). By default clip planes are inherited from the parent plot or scene. You can remove parent clip_planes
by passing Plane3f[]
.
color
= @inherit linecolor
— No docs available.
colormap
= @inherit colormap :viridis
— Sets the colormap that is sampled for numeric color
s. PlotUtils.cgrad(...)
, Makie.Reverse(any_colormap)
can be used as well, or any symbol from ColorBrewer or PlotUtils. To see all available color gradients, you can call Makie.available_gradients()
.
colorrange
= automatic
— The values representing the start and end points of colormap
.
colorscale
= identity
— The color transform function. Can be any function, but only works well together with Colorbar
for identity
, log
, log2
, log10
, sqrt
, logit
, Makie.pseudolog10
, Makie.Symlog10
, Makie.AsinhScale
, Makie.SinhScale
, Makie.LogScale
, Makie.LuptonAsinhScale
, and Makie.PowerScale
.
cycle
= :color
— No docs available.
depth_shift
= 0.0
— Adjusts the depth value of a plot after all other transformations, i.e. in clip space, where -1 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw).
fxaa
= false
— Adjusts whether the plot is rendered with fxaa (anti-aliasing, GLMakie only).
highclip
= automatic
— The color for any value above the colorrange.
inspectable
= @inherit inspectable
— Sets whether this plot should be seen by DataInspector
. The default depends on the theme of the parent scene.
inspector_clear
= automatic
— Sets a callback function (inspector, plot) -> ...
for cleaning up custom indicators in DataInspector.
inspector_hover
= automatic
— Sets a callback function (inspector, plot, index) -> ...
which replaces the default show_data
methods.
inspector_label
= automatic
— Sets a callback function (plot, index, position) -> string
which replaces the default label generated by DataInspector.
joinstyle
= @inherit joinstyle
— Controls the rendering at corners. Options are :miter
for sharp corners, :bevel
for "cut off" corners, and :round
for rounded corners. If the corner angle is below miter_limit
, :miter
is equivalent to :bevel
to avoid long spikes.
linecap
= :round
— No docs available.
linestyle
= nothing
— Sets the dash pattern of the line. Options are :solid
(equivalent to nothing
), :dot
, :dash
, :dashdot
and :dashdotdot
. These can also be given in a tuple with a gap style modifier, either :normal
, :dense
or :loose
. For example, (:dot, :loose)
or (:dashdot, :dense)
.
For custom patterns have a look at Makie.Linestyle
.
linewidth
= :curv
— No docs available.
linewidthscale
= 1
— No docs available.
lowclip
= automatic
— The color for any value below the colorrange.
miter_limit
= @inherit miter_limit
— Sets the minimum inner join angle below which miter joins truncate. See also Makie.miter_distance_to_angle
.
model
= automatic
— Sets a model matrix for the plot. This overrides adjustments made with translate!
, rotate!
and scale!
.
nan_color
= :transparent
— The color for NaN values.
overdraw
= false
— Controls if the plot will draw over other plots. This specifically means ignoring depth checks in GL backends
space
= :data
— Sets the transformation space for box encompassing the plot. See Makie.spaces()
for possible inputs.
ssao
= false
— Adjusts whether the plot is rendered with ssao (screen space ambient occlusion). Note that this only makes sense in 3D plots and is only applicable with fxaa = true
.
transformation
= :automatic
— No docs available.
transparency
= false
— Adjusts how the plot deals with transparency. In GLMakie transparency = true
results in using Order Independent Transparency.
visible
= true
— Controls whether the plot will be rendered or not.
TimeseriesMakie.kinetic! Function
kinetic!
is the mutating variant of plotting function kinetic
. Check the docstring for kinetic
for further information.
TimeseriesMakie.shadows Function
shadows(x, y, z; kwargs...)
Plots shadows of a 3D trajectory onto the enclosing axis panes.
Key attributes:
mode
= :projection
: The shadowing mode
swapshadows
= automatic
: Whether to swap the axes for each shadow.
Can be:
true
orfalse
: Swap the axes for all shadows from their default valuesNTuple{3, Bool}
: Swap the default axes for each shadow individually (x, y, z)automatic
: Defaults to(true, true, false)
limits
= automatic
: The targeted axis limits. To ensure the shadows align with the axes, it is best to provide the Axis
limits here. If automatic
, the limits are inferred from the data.
Other attributes are shared with Makie.Lines
.
Plot type
The plot type alias for the shadows
function is Shadows
.
Attributes
alpha
= 1.0
— The alpha value of the colormap or color attribute. Multiple alphas like in plot(alpha=0.2, color=(:red, 0.5)
, will get multiplied.
clip_planes
= @inherit clip_planes automatic
— Clip planes offer a way to do clipping in 3D space. You can set a Vector of up to 8 Plane3f
planes here, behind which plots will be clipped (i.e. become invisible). By default clip planes are inherited from the parent plot or scene. You can remove parent clip_planes
by passing Plane3f[]
.
color
= @inherit linecolor
— The color of the line.
colormap
= @inherit colormap :viridis
— Sets the colormap that is sampled for numeric color
s. PlotUtils.cgrad(...)
, Makie.Reverse(any_colormap)
can be used as well, or any symbol from ColorBrewer or PlotUtils. To see all available color gradients, you can call Makie.available_gradients()
.
colorrange
= automatic
— The values representing the start and end points of colormap
.
colorscale
= identity
— The color transform function. Can be any function, but only works well together with Colorbar
for identity
, log
, log2
, log10
, sqrt
, logit
, Makie.pseudolog10
, Makie.Symlog10
, Makie.AsinhScale
, Makie.SinhScale
, Makie.LogScale
, Makie.LuptonAsinhScale
, and Makie.PowerScale
.
cycle
= [:color]
— Sets which attributes to cycle when creating multiple plots.
depth_shift
= 0.0
— Adjusts the depth value of a plot after all other transformations, i.e. in clip space, where -1 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw).
fxaa
= false
— Adjusts whether the plot is rendered with fxaa (anti-aliasing, GLMakie only).
highclip
= automatic
— The color for any value above the colorrange.
inspectable
= @inherit inspectable
— Sets whether this plot should be seen by DataInspector
. The default depends on the theme of the parent scene.
inspector_clear
= automatic
— Sets a callback function (inspector, plot) -> ...
for cleaning up custom indicators in DataInspector.
inspector_hover
= automatic
— Sets a callback function (inspector, plot, index) -> ...
which replaces the default show_data
methods.
inspector_label
= automatic
— Sets a callback function (plot, index, position) -> string
which replaces the default label generated by DataInspector.
joinstyle
= @inherit joinstyle
— Controls the rendering at corners. Options are :miter
for sharp corners, :bevel
for "cut off" corners, and :round
for rounded corners. If the corner angle is below miter_limit
, :miter
is equivalent to :bevel
to avoid long spikes.
limits
= automatic
— The targeted axis limits
linecap
= @inherit linecap
— Sets the type of line cap used. Options are :butt
(flat without extrusion), :square
(flat with half a linewidth extrusion) or :round
.
linestyle
= nothing
— Sets the dash pattern of the line. Options are :solid
(equivalent to nothing
), :dot
, :dash
, :dashdot
and :dashdotdot
. These can also be given in a tuple with a gap style modifier, either :normal
, :dense
or :loose
. For example, (:dot, :loose)
or (:dashdot, :dense)
.
For custom patterns have a look at Makie.Linestyle
.
linewidth
= @inherit linewidth
— Sets the width of the line in screen units
lowclip
= automatic
— The color for any value below the colorrange.
miter_limit
= @inherit miter_limit
— Sets the minimum inner join angle below which miter joins truncate. See also Makie.miter_distance_to_angle
.
mode
= :projection
— The shadowing mode
model
= automatic
— Sets a model matrix for the plot. This overrides adjustments made with translate!
, rotate!
and scale!
.
nan_color
= :transparent
— The color for NaN values.
overdraw
= false
— Controls if the plot will draw over other plots. This specifically means ignoring depth checks in GL backends
space
= :data
— Sets the transformation space for box encompassing the plot. See Makie.spaces()
for possible inputs.
ssao
= false
— Adjusts whether the plot is rendered with ssao (screen space ambient occlusion). Note that this only makes sense in 3D plots and is only applicable with fxaa = true
.
swapshadows
= automatic
— Whether to swap the axes for each shadow
transformation
= :automatic
— No docs available.
transparency
= false
— Adjusts how the plot deals with transparency. In GLMakie transparency = true
results in using Order Independent Transparency.
visible
= true
— Controls whether the plot will be rendered or not.
TimeseriesMakie.shadows! Function
shadows!
is the mutating variant of plotting function shadows
. Check the docstring for shadows
for further information.
TimeseriesMakie.traces Function
traces(x, y, Z; kwargs...)
Plot the columns of Z
over the domain x
, colored by y
.
Key attributes:
linecolor
=automatic
: Sets the color of the traces.spacing
=0
: The spacing between traces.
Can be a number in data space, or one of the following modes: - :even
: Even spacing equal to the greatest difference between traces. - :close
: Successive traces are spaced by the smallest difference between them.
offset
=1
: The offset factor (offset * spacing)
Other attributes are shared with Makie.Lines
.
Plot type
The plot type alias for the traces
function is Traces
.
Attributes
alpha
= 1.0
— The alpha value of the colormap or color attribute. Multiple alphas like in plot(alpha=0.2, color=(:red, 0.5)
, will get multiplied.
clip_planes
= @inherit clip_planes automatic
— Clip planes offer a way to do clipping in 3D space. You can set a Vector of up to 8 Plane3f
planes here, behind which plots will be clipped (i.e. become invisible). By default clip planes are inherited from the parent plot or scene. You can remove parent clip_planes
by passing Plane3f[]
.
colormap
= @inherit colormap :viridis
— Sets the colormap that is sampled for numeric color
s. PlotUtils.cgrad(...)
, Makie.Reverse(any_colormap)
can be used as well, or any symbol from ColorBrewer or PlotUtils. To see all available color gradients, you can call Makie.available_gradients()
.
colorrange
= automatic
— The values representing the start and end points of colormap
.
colorscale
= identity
— The color transform function. Can be any function, but only works well together with Colorbar
for identity
, log
, log2
, log10
, sqrt
, logit
, Makie.pseudolog10
, Makie.Symlog10
, Makie.AsinhScale
, Makie.SinhScale
, Makie.LogScale
, Makie.LuptonAsinhScale
, and Makie.PowerScale
.
cycle
= [:color]
— Sets which attributes to cycle when creating multiple plots.
depth_shift
= 0.0
— Adjusts the depth value of a plot after all other transformations, i.e. in clip space, where -1 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw).
fxaa
= false
— Adjusts whether the plot is rendered with fxaa (anti-aliasing, GLMakie only).
highclip
= automatic
— The color for any value above the colorrange.
inspectable
= @inherit inspectable
— Sets whether this plot should be seen by DataInspector
. The default depends on the theme of the parent scene.
inspector_clear
= automatic
— Sets a callback function (inspector, plot) -> ...
for cleaning up custom indicators in DataInspector.
inspector_hover
= automatic
— Sets a callback function (inspector, plot, index) -> ...
which replaces the default show_data
methods.
inspector_label
= automatic
— Sets a callback function (plot, index, position) -> string
which replaces the default label generated by DataInspector.
joinstyle
= @inherit joinstyle
— Controls the rendering at corners. Options are :miter
for sharp corners, :bevel
for "cut off" corners, and :round
for rounded corners. If the corner angle is below miter_limit
, :miter
is equivalent to :bevel
to avoid long spikes.
linecap
= @inherit linecap
— Sets the type of line cap used. Options are :butt
(flat without extrusion), :square
(flat with half a linewidth extrusion) or :round
.
linecolor
= automatic
— No docs available.
linestyle
= nothing
— Sets the dash pattern of the line. Options are :solid
(equivalent to nothing
), :dot
, :dash
, :dashdot
and :dashdotdot
. These can also be given in a tuple with a gap style modifier, either :normal
, :dense
or :loose
. For example, (:dot, :loose)
or (:dashdot, :dense)
.
For custom patterns have a look at Makie.Linestyle
.
linewidth
= @inherit linewidth
— Sets the width of the line in screen units
lowclip
= automatic
— The color for any value below the colorrange.
miter_limit
= @inherit miter_limit
— Sets the minimum inner join angle below which miter joins truncate. See also Makie.miter_distance_to_angle
.
model
= automatic
— Sets a model matrix for the plot. This overrides adjustments made with translate!
, rotate!
and scale!
.
nan_color
= :transparent
— The color for NaN values.
offset
= 1
— No docs available.
overdraw
= false
— Controls if the plot will draw over other plots. This specifically means ignoring depth checks in GL backends
space
= :data
— Sets the transformation space for box encompassing the plot. See Makie.spaces()
for possible inputs.
spacing
= 0
— No docs available.
ssao
= false
— Adjusts whether the plot is rendered with ssao (screen space ambient occlusion). Note that this only makes sense in 3D plots and is only applicable with fxaa = true
.
transformation
= :automatic
— No docs available.
transparency
= false
— Adjusts how the plot deals with transparency. In GLMakie transparency = true
results in using Order Independent Transparency.
visible
= true
— Controls whether the plot will be rendered or not.
TimeseriesMakie.traces! Function
traces!
is the mutating variant of plotting function traces
. Check the docstring for traces
for further information.
TimeseriesMakie.trail Function
trail(x, y; kwargs...)
Plot a fading trace of points in 2D or 3D space.
Key attributes:
npoints
= automatic
: Fixes the length of the trail. By default, this is equal to the length of x
and y
. If npoints
is less than the length of x
and y
, the last npoints
will be plotted.
linecolor
= @inherit linecolor
: Sets the color of the trail. Should be a single color (e.g. "red", :red, (:red, 0.2), RGBA(0.1, 0.2, 0.3, 0.4)). This value is overridden by color
color
= nothing
: Specifies the color values for the trail.
If !isnothing(color)
, trail colors will be sampled from the colormap
depending on the value of color
. color
can be:
A collection of numbers representing values to be sampled from the colormap.
A function of the index of a point in the trail (e.g.
Base.Fix2(^, 3)
).
colormap
= @inherit colormap
: Specifies the colormap to use for the trail when !isnothing(color)
.
alpha
= identity
: Controls the transparency profile of the trail. alpha
can be:
A single number (e.g.
0.5
).A function of the index of a point in the trail (e.g.
Base.Fix2(^, 3)
).A collection of numbers representing alpha values for each point in the trail.
To sidestep alpha normalization, explicitly pass a vector of alpha values.
Other attributes are shared with Makie.Lines
.
Plot type
The plot type alias for the trail
function is Trail
.
Attributes
alpha
= identity
— No docs available.
clip_planes
= @inherit clip_planes automatic
— Clip planes offer a way to do clipping in 3D space. You can set a Vector of up to 8 Plane3f
planes here, behind which plots will be clipped (i.e. become invisible). By default clip planes are inherited from the parent plot or scene. You can remove parent clip_planes
by passing Plane3f[]
.
color
= nothing
— No docs available.
colormap
= @inherit colormap
— No docs available.
colorrange
= automatic
— The values representing the start and end points of colormap
.
colorscale
= identity
— The color transform function. Can be any function, but only works well together with Colorbar
for identity
, log
, log2
, log10
, sqrt
, logit
, Makie.pseudolog10
, Makie.Symlog10
, Makie.AsinhScale
, Makie.SinhScale
, Makie.LogScale
, Makie.LuptonAsinhScale
, and Makie.PowerScale
.
depth_shift
= 0.0
— Adjusts the depth value of a plot after all other transformations, i.e. in clip space, where -1 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw).
fxaa
= false
— Adjusts whether the plot is rendered with fxaa (anti-aliasing, GLMakie only).
highclip
= automatic
— The color for any value above the colorrange.
inspectable
= @inherit inspectable
— Sets whether this plot should be seen by DataInspector
. The default depends on the theme of the parent scene.
inspector_clear
= automatic
— Sets a callback function (inspector, plot) -> ...
for cleaning up custom indicators in DataInspector.
inspector_hover
= automatic
— Sets a callback function (inspector, plot, index) -> ...
which replaces the default show_data
methods.
inspector_label
= automatic
— Sets a callback function (plot, index, position) -> string
which replaces the default label generated by DataInspector.
joinstyle
= @inherit joinstyle
— Controls the rendering at corners. Options are :miter
for sharp corners, :bevel
for "cut off" corners, and :round
for rounded corners. If the corner angle is below miter_limit
, :miter
is equivalent to :bevel
to avoid long spikes.
linecap
= @inherit linecap
— Sets the type of line cap used. Options are :butt
(flat without extrusion), :square
(flat with half a linewidth extrusion) or :round
.
linecolor
= @inherit linecolor
— No docs available.
linestyle
= nothing
— Sets the dash pattern of the line. Options are :solid
(equivalent to nothing
), :dot
, :dash
, :dashdot
and :dashdotdot
. These can also be given in a tuple with a gap style modifier, either :normal
, :dense
or :loose
. For example, (:dot, :loose)
or (:dashdot, :dense)
.
For custom patterns have a look at Makie.Linestyle
.
linewidth
= @inherit linewidth
— Sets the width of the line in screen units
lowclip
= automatic
— The color for any value below the colorrange.
miter_limit
= @inherit miter_limit
— Sets the minimum inner join angle below which miter joins truncate. See also Makie.miter_distance_to_angle
.
model
= automatic
— Sets a model matrix for the plot. This overrides adjustments made with translate!
, rotate!
and scale!
.
n_points
= automatic
— No docs available.
nan_color
= :transparent
— The color for NaN values.
overdraw
= false
— Controls if the plot will draw over other plots. This specifically means ignoring depth checks in GL backends
space
= :data
— Sets the transformation space for box encompassing the plot. See Makie.spaces()
for possible inputs.
ssao
= false
— Adjusts whether the plot is rendered with ssao (screen space ambient occlusion). Note that this only makes sense in 3D plots and is only applicable with fxaa = true
.
transformation
= :automatic
— No docs available.
transparency
= false
— Adjusts how the plot deals with transparency. In GLMakie transparency = true
results in using Order Independent Transparency.
visible
= true
— Controls whether the plot will be rendered or not.
TimeseriesMakie.trail! Function
trail!
is the mutating variant of plotting function trail
. Check the docstring for trail
for further information.
TimeseriesMakie.trajectory Function
trajectory(x, y, [z]; kwargs...)
Plots a colored trajectory in 2D or 3D space.
Key attribtues:
color
= :speed
: The coloring method for the trajectory.
Can be one of:
:speed
: Color by speed along the trajectory:time
: Color by time index<: AbstractVector
: Color by a custom vector of valuesUnion{<:Symbol, <:Colorant}
: Color by a fixed color
Other attributes are shared with Makie.Lines
.
Plot type
The plot type alias for the trajectory
function is Trajectory
.
Attributes
alpha
= 1.0
— The alpha value of the colormap or color attribute. Multiple alphas like in plot(alpha=0.2, color=(:red, 0.5)
, will get multiplied.
clip_planes
= @inherit clip_planes automatic
— Clip planes offer a way to do clipping in 3D space. You can set a Vector of up to 8 Plane3f
planes here, behind which plots will be clipped (i.e. become invisible). By default clip planes are inherited from the parent plot or scene. You can remove parent clip_planes
by passing Plane3f[]
.
color
= :speed
— The coloring method for the trajectory
colormap
= @inherit colormap :viridis
— Sets the colormap that is sampled for numeric color
s. PlotUtils.cgrad(...)
, Makie.Reverse(any_colormap)
can be used as well, or any symbol from ColorBrewer or PlotUtils. To see all available color gradients, you can call Makie.available_gradients()
.
colorrange
= automatic
— The values representing the start and end points of colormap
.
colorscale
= identity
— The color transform function. Can be any function, but only works well together with Colorbar
for identity
, log
, log2
, log10
, sqrt
, logit
, Makie.pseudolog10
, Makie.Symlog10
, Makie.AsinhScale
, Makie.SinhScale
, Makie.LogScale
, Makie.LuptonAsinhScale
, and Makie.PowerScale
.
cycle
= [:color]
— Sets which attributes to cycle when creating multiple plots.
depth_shift
= 0.0
— Adjusts the depth value of a plot after all other transformations, i.e. in clip space, where -1 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw).
fxaa
= false
— Adjusts whether the plot is rendered with fxaa (anti-aliasing, GLMakie only).
highclip
= automatic
— The color for any value above the colorrange.
inspectable
= @inherit inspectable
— Sets whether this plot should be seen by DataInspector
. The default depends on the theme of the parent scene.
inspector_clear
= automatic
— Sets a callback function (inspector, plot) -> ...
for cleaning up custom indicators in DataInspector.
inspector_hover
= automatic
— Sets a callback function (inspector, plot, index) -> ...
which replaces the default show_data
methods.
inspector_label
= automatic
— Sets a callback function (plot, index, position) -> string
which replaces the default label generated by DataInspector.
joinstyle
= @inherit joinstyle
— Controls the rendering at corners. Options are :miter
for sharp corners, :bevel
for "cut off" corners, and :round
for rounded corners. If the corner angle is below miter_limit
, :miter
is equivalent to :bevel
to avoid long spikes.
linecap
= @inherit linecap
— Sets the type of line cap used. Options are :butt
(flat without extrusion), :square
(flat with half a linewidth extrusion) or :round
.
linestyle
= nothing
— Sets the dash pattern of the line. Options are :solid
(equivalent to nothing
), :dot
, :dash
, :dashdot
and :dashdotdot
. These can also be given in a tuple with a gap style modifier, either :normal
, :dense
or :loose
. For example, (:dot, :loose)
or (:dashdot, :dense)
.
For custom patterns have a look at Makie.Linestyle
.
linewidth
= @inherit linewidth
— Sets the width of the line in screen units
lowclip
= automatic
— The color for any value below the colorrange.
miter_limit
= @inherit miter_limit
— Sets the minimum inner join angle below which miter joins truncate. See also Makie.miter_distance_to_angle
.
model
= automatic
— Sets a model matrix for the plot. This overrides adjustments made with translate!
, rotate!
and scale!
.
nan_color
= :transparent
— The color for NaN values.
overdraw
= false
— Controls if the plot will draw over other plots. This specifically means ignoring depth checks in GL backends
space
= :data
— Sets the transformation space for box encompassing the plot. See Makie.spaces()
for possible inputs.
ssao
= false
— Adjusts whether the plot is rendered with ssao (screen space ambient occlusion). Note that this only makes sense in 3D plots and is only applicable with fxaa = true
.
transformation
= :automatic
— No docs available.
transparency
= false
— Adjusts how the plot deals with transparency. In GLMakie transparency = true
results in using Order Independent Transparency.
visible
= true
— Controls whether the plot will be rendered or not.
TimeseriesMakie.trajectory! Function
trajectory!
is the mutating variant of plotting function trajectory
. Check the docstring for trajectory
for further information.