diff --git a/0.11/.buildinfo b/0.11/.buildinfo index 5fa6159..c97d76e 100644 --- a/0.11/.buildinfo +++ b/0.11/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done. -config: bbe1eb132c2637ef6bc9a5cd0df3840e +config: ef117505268c1385d84f820dd7e05329 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/0.11/.doctrees/api.doctree b/0.11/.doctrees/api.doctree index a5999e2..1f6cf10 100644 Binary files a/0.11/.doctrees/api.doctree and b/0.11/.doctrees/api.doctree differ diff --git a/0.11/.doctrees/autoapi/xplt/base/index.doctree b/0.11/.doctrees/autoapi/xplt/base/index.doctree index f94f78c..98c5d29 100644 Binary files a/0.11/.doctrees/autoapi/xplt/base/index.doctree and b/0.11/.doctrees/autoapi/xplt/base/index.doctree differ diff --git a/0.11/.doctrees/autoapi/xplt/colors/index.doctree b/0.11/.doctrees/autoapi/xplt/colors/index.doctree index 9069bf7..7b8d805 100644 Binary files a/0.11/.doctrees/autoapi/xplt/colors/index.doctree and b/0.11/.doctrees/autoapi/xplt/colors/index.doctree differ diff --git a/0.11/.doctrees/autoapi/xplt/hooks/index.doctree b/0.11/.doctrees/autoapi/xplt/hooks/index.doctree index 95a83a5..37adfdf 100644 Binary files a/0.11/.doctrees/autoapi/xplt/hooks/index.doctree and b/0.11/.doctrees/autoapi/xplt/hooks/index.doctree differ diff --git a/0.11/.doctrees/autoapi/xplt/index.doctree b/0.11/.doctrees/autoapi/xplt/index.doctree index 825ec7d..c608918 100644 Binary files a/0.11/.doctrees/autoapi/xplt/index.doctree and b/0.11/.doctrees/autoapi/xplt/index.doctree differ diff --git a/0.11/.doctrees/autoapi/xplt/line/index.doctree b/0.11/.doctrees/autoapi/xplt/line/index.doctree index 29660c0..8ace98d 100644 Binary files a/0.11/.doctrees/autoapi/xplt/line/index.doctree and b/0.11/.doctrees/autoapi/xplt/line/index.doctree differ diff --git a/0.11/.doctrees/autoapi/xplt/particles/index.doctree b/0.11/.doctrees/autoapi/xplt/particles/index.doctree index 6446a74..2bc6dfd 100644 Binary files a/0.11/.doctrees/autoapi/xplt/particles/index.doctree and b/0.11/.doctrees/autoapi/xplt/particles/index.doctree differ diff --git a/0.11/.doctrees/autoapi/xplt/phasespace/index.doctree b/0.11/.doctrees/autoapi/xplt/phasespace/index.doctree index 09361f9..c069f64 100644 Binary files a/0.11/.doctrees/autoapi/xplt/phasespace/index.doctree and b/0.11/.doctrees/autoapi/xplt/phasespace/index.doctree differ diff --git a/0.11/.doctrees/autoapi/xplt/properties/index.doctree b/0.11/.doctrees/autoapi/xplt/properties/index.doctree index be32a86..798701d 100644 Binary files a/0.11/.doctrees/autoapi/xplt/properties/index.doctree and b/0.11/.doctrees/autoapi/xplt/properties/index.doctree differ diff --git a/0.11/.doctrees/autoapi/xplt/timestructure/index.doctree b/0.11/.doctrees/autoapi/xplt/timestructure/index.doctree index 0ff405d..e363f24 100644 Binary files a/0.11/.doctrees/autoapi/xplt/timestructure/index.doctree and b/0.11/.doctrees/autoapi/xplt/timestructure/index.doctree differ diff --git a/0.11/.doctrees/autoapi/xplt/twiss/index.doctree b/0.11/.doctrees/autoapi/xplt/twiss/index.doctree index 1fa3d9d..afd236d 100644 Binary files a/0.11/.doctrees/autoapi/xplt/twiss/index.doctree and b/0.11/.doctrees/autoapi/xplt/twiss/index.doctree differ diff --git a/0.11/.doctrees/autoapi/xplt/util/index.doctree b/0.11/.doctrees/autoapi/xplt/util/index.doctree index fd5a250..8b29470 100644 Binary files a/0.11/.doctrees/autoapi/xplt/util/index.doctree and b/0.11/.doctrees/autoapi/xplt/util/index.doctree differ diff --git a/0.11/.doctrees/environment.pickle b/0.11/.doctrees/environment.pickle index a4de7cf..b174b19 100644 Binary files a/0.11/.doctrees/environment.pickle and b/0.11/.doctrees/environment.pickle differ diff --git a/0.11/.pre-release b/0.11/.pre-release new file mode 100644 index 0000000..e69de29 diff --git a/0.11/_static/documentation_options.js b/0.11/_static/documentation_options.js index f478391..e530f96 100644 --- a/0.11/_static/documentation_options.js +++ b/0.11/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '0.11.3-rc3', + VERSION: '0.11.3-rc4', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/0.11/api.html b/0.11/api.html index 03bffe9..aafd085 100644 --- a/0.11/api.html +++ b/0.11/api.html @@ -8,7 +8,7 @@ - API documentation — Xplt 0.11.3-rc3 documentation + API documentation — Xplt 0.11.3-rc4 documentation @@ -42,7 +42,7 @@ - + @@ -61,7 +61,7 @@ - + @@ -123,7 +123,7 @@ -

Xplt 0.11.3-rc3 documentation

+

Xplt 0.11.3-rc4 documentation

@@ -442,7 +442,7 @@

API documentation#

-

Version 0.11.3-rc3

+

Version 0.11.3-rc4

@@ -498,7 +498,7 @@

Classes#<

Module Contents#

-class xplt.base.AngleLocator(minor=False, deg=True)[source]#
+class xplt.base.AngleLocator(minor=False, deg=True)[source]#

Bases: ManifoldMultipleLocator

Place evenly spaced ticks, with a cap on the total number of ticks.

Finds nice tick locations with no more than \(nbins + 1\) ticks being within the @@ -626,7 +626,7 @@

Module Contents
-class xplt.base.DiscontinuousFormatter(breaks, **kwargs)[source]#
+class xplt.base.DiscontinuousFormatter(breaks, **kwargs)[source]#

Bases: matplotlib.ticker.ScalarFormatter

Format tick values as a number.

@@ -895,17 +895,17 @@

Module Contents
-class xplt.base.DiscontinuousLinearScale(axis, *, breaks=(), space=0, hide=False)[source]#
+class xplt.base.DiscontinuousLinearScale(axis, *, breaks=(), space=0, hide=False)[source]#

Bases: matplotlib.scale.LinearScale

The default linear scale.

-add_discontinuity_markers(axis)[source]#
+add_discontinuity_markers(axis)[source]#
-get_transform()[source]#
+get_transform()[source]#

Return the transform for linear scaling, which is just the ~matplotlib.transforms.IdentityTransform.

@@ -921,7 +921,7 @@

Module Contents
-set_default_locators_and_formatters(axis)[source]#
+set_default_locators_and_formatters(axis)[source]#

Set the locators and formatters of axis to instances suitable for this scale.

@@ -950,7 +950,7 @@

Module Contents
-class xplt.base.DiscontinuousLocator(breaks, space, **kwargs)[source]#
+class xplt.base.DiscontinuousLocator(breaks, space, **kwargs)[source]#

Bases: matplotlib.ticker.AutoLocator

Place evenly spaced ticks, with the step size and maximum number of ticks chosen automatically.

@@ -997,7 +997,7 @@

Module Contents
-set_params(**kwargs)[source]#
+set_params(**kwargs)[source]#

Set parameters for this locator.

Parameters:
@@ -1067,7 +1067,7 @@

Module Contents
-class xplt.base.DiscontinuousTransform(breaks, space, *, hide=True)[source]#
+class xplt.base.DiscontinuousTransform(breaks, space, *, hide=True)[source]#

Bases: matplotlib.transforms.Transform

The base class of all TransformNode instances that actually perform a transformation.

@@ -1153,7 +1153,7 @@

Module Contents
-inverted()[source]#
+inverted()[source]#

Return the corresponding inverse transformation.

It holds x == self.inverted().transform(self.transform(x)).

The return value of this method should be treated as @@ -1247,7 +1247,7 @@

Module Contents
-transform_non_affine(values)[source]#
+transform_non_affine(values)[source]#

Apply only the non-affine part of this transformation.

transform(values) is always equivalent to transform_affine(transform_non_affine(values)).

@@ -1381,7 +1381,7 @@

Module Contents
-class xplt.base.ManifoldMultipleLocator(fixed_multiples, n=5, minor_n=None)[source]#
+class xplt.base.ManifoldMultipleLocator(fixed_multiples, n=5, minor_n=None)[source]#

Bases: matplotlib.ticker.MaxNLocator

Place evenly spaced ticks, with a cap on the total number of ticks.

Finds nice tick locations with no more than \(nbins + 1\) ticks being within the @@ -1512,7 +1512,7 @@

Module Contents
-class xplt.base.RadiansFormatter[source]#
+class xplt.base.RadiansFormatter[source]#

Bases: matplotlib.ticker.Formatter

A tick formatter to format angles in radians as fractions or multiples of pi

@@ -1581,7 +1581,7 @@

Module Contents
-class xplt.base.TransformedLocator(locator, transform=lambda x: ..., inverse=lambda x: ..., vmin=-np.inf, vmax=np.inf)[source]#
+class xplt.base.TransformedLocator(locator, transform=lambda x: ..., inverse=lambda x: ..., vmin=-np.inf, vmax=np.inf)[source]#

Bases: matplotlib.ticker.Locator

Determine tick locations.

Note that the same locator should not be used across multiple @@ -1646,7 +1646,7 @@

Module Contents
-tick_values(vmin, vmax)[source]#
+tick_values(vmin, vmax)[source]#

Return the values of the located ticks given vmin and vmax.

Note

@@ -1708,7 +1708,7 @@

Module Contents
-class xplt.base.TwinFunctionLocator(twin_locator, function_twin_to_this, function_this_to_twin, granularity=1)[source]#
+class xplt.base.TwinFunctionLocator(twin_locator, function_twin_to_this, function_this_to_twin, granularity=1)[source]#

Bases: matplotlib.ticker.Locator

Determine tick locations.

Note that the same locator should not be used across multiple @@ -1773,7 +1773,7 @@

Module Contents
-tick_values(vmin, vmax)[source]#
+tick_values(vmin, vmax)[source]#

Return the values of the located ticks given vmin and vmax.

Note

@@ -1830,7 +1830,7 @@

Module Contents
-class xplt.base.XManifoldPlot(on_x, on_y, *, on_y_separators=',-+', on_y_subs={}, **kwargs)[source]#
+class xplt.base.XManifoldPlot(on_x, on_y, *, on_y_separators=',-+', on_y_subs={}, **kwargs)[source]#

Bases: XPlot

Base class for plotting manifold plots

A manifold plot consists of multiple subplots, axes and twin axes, all of which @@ -1855,7 +1855,7 @@

Module Contents
-static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#
+static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#

Add a scale patch (a yardstick or ruler)

Parameters:
@@ -1885,12 +1885,12 @@

Module Contents
-annotate(text, **kwargs)[source]#
+annotate(text, **kwargs)[source]#

-artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#
+artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#

Return the artist either by name, or by subplot, twin axes and trace index

Parameters:
@@ -1913,7 +1913,7 @@

Module Contents
-autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#
+autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#

Autoscale the axes of a subplot

Parameters:
@@ -1934,7 +1934,7 @@

Module Contents
-axes(subplots='all', twins='all')[source]#
+axes(subplots='all', twins='all')[source]#

Generator yielding axes for the given flat subplot and twin indices

Parameters:
@@ -1952,7 +1952,7 @@

Module Contents
-axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#
+axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#

Return the axis for a given flat subplot index and twin index, or an artist name

Either get axis by index axis(subplot, twin) or by property name axis(name).

@@ -1975,7 +1975,7 @@

Module Contents
-axline(kind, val, **kwargs)[source]#
+axline(kind, val, **kwargs)[source]#

Plot a vertical or horizontal line for a given coordinate

Parameters:
@@ -1990,7 +1990,7 @@

Module Contents
-axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#
+axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#

Plot a vertical or horizontal span (or line) for a given coordinate

Parameters:
@@ -2015,7 +2015,7 @@

Module Contents
-display_unit_for(p)[source]#
+display_unit_for(p)[source]#

Return display unit for parameter

Parameters:
@@ -2032,7 +2032,7 @@

Module Contents
-factor_for(p)[source]#
+factor_for(p)[source]#

Return factor to convert parameter into display unit

Parameters:
@@ -2049,7 +2049,7 @@

Module Contents
-label_for(*pp, unit=True, description=True)[source]#
+label_for(*pp, unit=True, description=True)[source]#

Return axis label for list of properties, joining where possible

Parameters:
@@ -2070,7 +2070,7 @@

Module Contents
-legend(subplot='all', show=True, **kwargs)[source]#
+legend(subplot='all', show=True, **kwargs)[source]#

Add, update or remove legend for a subplot

Parameters:
@@ -2086,7 +2086,7 @@

Module Contents
-static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#
+static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#

Parse a separated string or nested list or a mixture of both

Parameters:
@@ -2117,7 +2117,7 @@

Module Contents
-static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#
+static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#

Add vertical lines or spans indicating the location of values or spans and their harmonics

Indicates the bands at the h-th harmonics (h = 1, 2, …, n) at

@@ -490,7 +490,7 @@

Functions#

-xplt.colors.make_unicoloured_cmap(color)[source]#
+xplt.colors.make_unicoloured_cmap(color)[source]#

Make a linear colormap of a given color from transparent to black

Parameters:
diff --git a/0.11/autoapi/xplt/hooks/index.html b/0.11/autoapi/xplt/hooks/index.html index 65f9c2e..09f6caa 100644 --- a/0.11/autoapi/xplt/hooks/index.html +++ b/0.11/autoapi/xplt/hooks/index.html @@ -8,7 +8,7 @@ - xplt.hooks — Xplt 0.11.3-rc3 documentation + xplt.hooks — Xplt 0.11.3-rc4 documentation @@ -42,7 +42,7 @@ - + @@ -59,7 +59,7 @@ - + @@ -121,7 +121,7 @@ -

Xplt 0.11.3-rc3 documentation

+

Xplt 0.11.3-rc4 documentation

@@ -472,19 +472,19 @@

Functions#

-xplt.hooks.register_matplotlib_options()[source]#
+xplt.hooks.register_matplotlib_options()[source]#

Register default options for matplotlib

-xplt.hooks.register_pint_options()[source]#
+xplt.hooks.register_pint_options()[source]#

Register default options for pint

-xplt.hooks.try_register_hooks()[source]#
+xplt.hooks.try_register_hooks()[source]#

diff --git a/0.11/autoapi/xplt/index.html b/0.11/autoapi/xplt/index.html index e2c6913..37597de 100644 --- a/0.11/autoapi/xplt/index.html +++ b/0.11/autoapi/xplt/index.html @@ -8,7 +8,7 @@ - xplt — Xplt 0.11.3-rc3 documentation + xplt — Xplt 0.11.3-rc4 documentation @@ -42,7 +42,7 @@ - + @@ -61,7 +61,7 @@ - + @@ -123,7 +123,7 @@ -

Xplt 0.11.3-rc3 documentation

+

Xplt 0.11.3-rc4 documentation

@@ -481,7 +481,7 @@

Functions#

-xplt.apply_style()[source]#
+xplt.apply_style()[source]#

Apply xplt’s matplotlib style sheet and update rcParams

diff --git a/0.11/autoapi/xplt/line/index.html b/0.11/autoapi/xplt/line/index.html index 06bd34d..0a2ac35 100644 --- a/0.11/autoapi/xplt/line/index.html +++ b/0.11/autoapi/xplt/line/index.html @@ -8,7 +8,7 @@ - xplt.line — Xplt 0.11.3-rc3 documentation + xplt.line — Xplt 0.11.3-rc4 documentation @@ -42,7 +42,7 @@ - + @@ -59,7 +59,7 @@ - + @@ -121,7 +121,7 @@ -

Xplt 0.11.3-rc3 documentation

+

Xplt 0.11.3-rc4 documentation

@@ -492,7 +492,7 @@

Functions#

-class xplt.line.FloorPlot(survey=None, line=None, projection='ZX', *, default_boxes=None, boxes=None, labels=False, ignore=None, element_width=1, axis='equal', **kwargs)[source]#
+class xplt.line.FloorPlot(survey=None, line=None, projection='ZX', *, default_boxes=None, boxes=None, labels=False, ignore=None, element_width=1, axis='equal', **kwargs)[source]#

Bases: xplt.base.XPlot

A floor plan of the line based on survey data

@@ -531,7 +531,7 @@

Module Contents
-add_scale(scale=None, label=None, *, loc='auto', color='k', fontsize='x-small')[source]#
+add_scale(scale=None, label=None, *, loc='auto', color='k', fontsize='x-small')[source]#

Add a scale patch (a yardstick or ruler)

Parameters:
@@ -556,12 +556,12 @@

Module Contents
-annotate(text, **kwargs)[source]#
+annotate(text, **kwargs)[source]#

-axes(subplots='all', twins='all')[source]#
+axes(subplots='all', twins='all')[source]#

Generator yielding axes for the given flat subplot and twin indices

Parameters:
@@ -579,7 +579,7 @@

Module Contents
-axis(subplot=0, twin=0)[source]#
+axis(subplot=0, twin=0)[source]#

Return the axis for a given flat subplot index and twin index

Parameters:
@@ -599,7 +599,7 @@

Module Contents
-display_unit_for(p)[source]#
+display_unit_for(p)[source]#

Return display unit for parameter

Parameters:
@@ -616,7 +616,7 @@

Module Contents
-factor_for(p)[source]#
+factor_for(p)[source]#

Return factor to convert parameter into display unit

Parameters:
@@ -633,7 +633,7 @@

Module Contents
-label_for(*pp, unit=True, description=True)[source]#
+label_for(*pp, unit=True, description=True)[source]#

Return axis label for list of properties, joining where possible

Parameters:
@@ -654,12 +654,12 @@

Module Contents
-legend(**kwargs)[source]#
+legend(**kwargs)[source]#

-static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#
+static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#

Add vertical lines or spans indicating the location of values or spans and their harmonics

Indicates the bands at the h-th harmonics (h = 1, 2, …, n) at
    @@ -689,7 +689,7 @@

    Module Contents
    -prop(name)[source]#
    +prop(name)[source]#

    Get property by key

    Parameters:
    @@ -706,7 +706,7 @@

    Module Contents
    -save(fname, **kwargs)[source]#
    +save(fname, **kwargs)[source]#

    Save the figure with sensible default options

    Parameters:
    @@ -720,7 +720,7 @@

    Module Contents
    -title(title, **kwargs)[source]#
    +title(title, **kwargs)[source]#

    Set figure title

    Parameters:
    @@ -734,7 +734,7 @@

    Module Contents
    -update(survey=None, line=None, *, autoscale=None)[source]#
    +update(survey=None, line=None, *, autoscale=None)[source]#

    Update the survey data this plot shows

    Parameters:
    @@ -822,7 +822,7 @@

    Module Contents
    -class xplt.line.KnlPlot(line=None, *, knl=None, filled=True, resolution='auto', **kwargs)[source]#
    +class xplt.line.KnlPlot(line=None, *, knl=None, filled=True, resolution='auto', **kwargs)[source]#

    Bases: xplt.base.XManifoldPlot

    A plot for knl values along line

    @@ -849,7 +849,7 @@

    Module Contents
    -static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#
    +static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#

    Add a scale patch (a yardstick or ruler)

    Parameters:
    @@ -879,12 +879,12 @@

    Module Contents
    -annotate(text, **kwargs)[source]#
    +annotate(text, **kwargs)[source]#

    -artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#
    +artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#

    Return the artist either by name, or by subplot, twin axes and trace index

    Parameters:
    @@ -907,7 +907,7 @@

    Module Contents
    -autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#
    +autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#

    Autoscale the axes of a subplot

    Parameters:
    @@ -928,7 +928,7 @@

    Module Contents
    -axes(subplots='all', twins='all')[source]#
    +axes(subplots='all', twins='all')[source]#

    Generator yielding axes for the given flat subplot and twin indices

    Parameters:
    @@ -946,7 +946,7 @@

    Module Contents
    -axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#
    +axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#

    Return the axis for a given flat subplot index and twin index, or an artist name

    Either get axis by index axis(subplot, twin) or by property name axis(name).

    @@ -969,7 +969,7 @@

    Module Contents
    -axline(kind, val, **kwargs)[source]#
    +axline(kind, val, **kwargs)[source]#

    Plot a vertical or horizontal line for a given coordinate

    Parameters:
    @@ -984,7 +984,7 @@

    Module Contents
    -axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#
    +axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#

    Plot a vertical or horizontal span (or line) for a given coordinate

    Parameters:
    @@ -1009,7 +1009,7 @@

    Module Contents
    -display_unit_for(p)[source]#
    +display_unit_for(p)[source]#

    Return display unit for parameter

    Parameters:
    @@ -1026,7 +1026,7 @@

    Module Contents
    -factor_for(p)[source]#
    +factor_for(p)[source]#

    Return factor to convert parameter into display unit

    Parameters:
    @@ -1043,7 +1043,7 @@

    Module Contents
    -label_for(*pp, unit=True, description=True)[source]#
    +label_for(*pp, unit=True, description=True)[source]#

    Return axis label for list of properties, joining where possible

    Parameters:
    @@ -1064,7 +1064,7 @@

    Module Contents
    -legend(subplot='all', show=True, **kwargs)[source]#
    +legend(subplot='all', show=True, **kwargs)[source]#

    Add, update or remove legend for a subplot

    Parameters:
    @@ -1080,7 +1080,7 @@

    Module Contents
    -static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#
    +static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#

    Parse a separated string or nested list or a mixture of both

    Parameters:
    @@ -1111,7 +1111,7 @@

    Module Contents
    -static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#
    +static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#

    Add vertical lines or spans indicating the location of values or spans and their harmonics

    Indicates the bands at the h-th harmonics (h = 1, 2, …, n) at
      @@ -1141,7 +1141,7 @@

      Module Contents
      -prop(p)[source]#
      +prop(p)[source]#

      Get property by key

      Parameters:
      @@ -1158,7 +1158,7 @@

      Module Contents
      -save(fname, **kwargs)[source]#
      +save(fname, **kwargs)[source]#

      Save the figure with sensible default options

      Parameters:
      @@ -1172,7 +1172,7 @@

      Module Contents
      -title(title, **kwargs)[source]#
      +title(title, **kwargs)[source]#

      Set figure title

      Parameters:
      @@ -1186,7 +1186,7 @@

      Module Contents
      -update(line, *, autoscale=None)[source]#
      +update(line, *, autoscale=None)[source]#

      Update the line data this plot shows

      Parameters:
      @@ -1256,31 +1256,31 @@

      Module Contents
      -xplt.line.effective_order(element)[source]#
      +xplt.line.effective_order(element)[source]#

      Get effective order of element (ignoring zero strength)

      -xplt.line.element_strength(element, n)[source]#
      +xplt.line.element_strength(element, n)[source]#

      Get knl strength of element

      -xplt.line.nominal_order(element)[source]#
      +xplt.line.nominal_order(element)[source]#

      Get nominal element order (even if coefficients might be zero)

      -xplt.line.order(knl)[source]#
      +xplt.line.order(knl)[source]#

      Get order of knl string as int

      -xplt.line.tanc(x)[source]#
      +xplt.line.tanc(x)[source]#

      Tangens cardinalis, i.e. tan(x)/x with limit tanc(0)=1

      diff --git a/0.11/autoapi/xplt/particles/index.html b/0.11/autoapi/xplt/particles/index.html index e7f5c84..a0ab41e 100644 --- a/0.11/autoapi/xplt/particles/index.html +++ b/0.11/autoapi/xplt/particles/index.html @@ -8,7 +8,7 @@ - xplt.particles — Xplt 0.11.3-rc3 documentation + xplt.particles — Xplt 0.11.3-rc4 documentation @@ -42,7 +42,7 @@ - + @@ -61,7 +61,7 @@ - + @@ -123,7 +123,7 @@ -

      Xplt 0.11.3-rc3 documentation

      +

      Xplt 0.11.3-rc4 documentation

      @@ -477,7 +477,7 @@

      Classes#<

      Module Contents#

      -class xplt.particles.ParticleHistogramPlot(property, particles=None, kind='count', *, bin_width=None, bin_count=None, range=None, relative=False, moment=1, mask=None, plot_kwargs=None, add_default_dataset=True, **kwargs)[source]#
      +class xplt.particles.ParticleHistogramPlot(property, particles=None, kind='count', *, bin_width=None, bin_count=None, range=None, relative=False, moment=1, mask=None, plot_kwargs=None, add_default_dataset=True, **kwargs)[source]#

      Bases: xplt.base.XManifoldPlot, ParticlePlotMixin, ParticleHistogramPlotMixin

      A 1D histogram plot for any particle property

      @@ -515,7 +515,7 @@

      Module Contents
      -add_dataset(id=AUTO, *, plot_kwargs=None, **kwargs)[source]#
      +add_dataset(id=AUTO, *, plot_kwargs=None, **kwargs)[source]#

      Create artists for a new dataset to the plot and optionally update their values

      Parameters:
      @@ -530,7 +530,7 @@

      Module Contents
      -static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#
      +static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#

      Add a scale patch (a yardstick or ruler)

      Parameters:
      @@ -560,12 +560,12 @@

      Module Contents
      -annotate(text, **kwargs)[source]#
      +annotate(text, **kwargs)[source]#

      -artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#
      +artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#

      Return the artist either by name, or by subplot, twin axes and trace index

      Parameters:
      @@ -588,7 +588,7 @@

      Module Contents
      -autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#
      +autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#

      Autoscale the axes of a subplot

      Parameters:
      @@ -609,7 +609,7 @@

      Module Contents
      -axes(subplots='all', twins='all')[source]#
      +axes(subplots='all', twins='all')[source]#

      Generator yielding axes for the given flat subplot and twin indices

      Parameters:
      @@ -627,7 +627,7 @@

      Module Contents
      -axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#
      +axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#

      Return the axis for a given flat subplot index and twin index, or an artist name

      Either get axis by index axis(subplot, twin) or by property name axis(name).

      @@ -650,7 +650,7 @@

      Module Contents
      -axline(kind, val, **kwargs)[source]#
      +axline(kind, val, **kwargs)[source]#

      Plot a vertical or horizontal line for a given coordinate

      Parameters:
      @@ -665,7 +665,7 @@

      Module Contents
      -axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#
      +axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#

      Plot a vertical or horizontal span (or line) for a given coordinate

      Parameters:
      @@ -690,13 +690,13 @@

      Module Contents
      -beta(particles=None)[source]#
      +beta(particles=None)[source]#

      Get reference relativistic beta as float

      -display_unit_for(p)[source]#
      +display_unit_for(p)[source]#

      Return display unit for parameter

      Parameters:
      @@ -713,7 +713,7 @@

      Module Contents
      -factor_for(p)[source]#
      +factor_for(p)[source]#

      Return factor to convert parameter into display unit

      Parameters:
      @@ -730,13 +730,13 @@

      Module Contents
      -frev(particles=None)[source]#
      +frev(particles=None)[source]#

      Get reference revolution frequency

      -get_property(name)[source]#
      +get_property(name)[source]#

      Public method to get a particle property by key

      Parameters:
      @@ -753,7 +753,7 @@

      Module Contents
      -label_for(*pp, unit=True, description=True)[source]#
      +label_for(*pp, unit=True, description=True)[source]#

      Return axis label for list of properties, joining where possible

      Parameters:
      @@ -774,7 +774,7 @@

      Module Contents
      -legend(subplot='all', show=True, **kwargs)[source]#
      +legend(subplot='all', show=True, **kwargs)[source]#

      Add, update or remove legend for a subplot

      Parameters:
      @@ -790,7 +790,7 @@

      Module Contents
      -static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#
      +static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#

      Parse a separated string or nested list or a mixture of both

      Parameters:
      @@ -821,7 +821,7 @@

      Module Contents
      -static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#
      +static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#

      Add vertical lines or spans indicating the location of values or spans and their harmonics

      Indicates the bands at the h-th harmonics (h = 1, 2, …, n) at

      @@ -466,7 +466,7 @@

      Classes#<

      Module Contents#

      -class xplt.phasespace.PhaseSpacePlot(particles=None, kind=None, plot='auto', *, scatter_kwargs=None, hist_kwargs=None, mask=None, masks=None, color=None, cmap='magma_r' or 'Blues', cbar_loc='auto', projections='auto', projections_kwargs=None, mean=False, mean_kwargs=None, std=False, std_kwargs=None, percentiles=None, percentile_kwargs=None, nrows=None, ncols=None, titles='auto', animated=False, twiss=None, **kwargs)[source]#
      +class xplt.phasespace.PhaseSpacePlot(particles=None, kind=None, plot='auto', *, scatter_kwargs=None, hist_kwargs=None, mask=None, masks=None, color=None, cmap='magma_r' or 'Blues', cbar_loc='auto', projections='auto', projections_kwargs=None, mean=False, mean_kwargs=None, std=False, std_kwargs=None, percentiles=None, percentile_kwargs=None, nrows=None, ncols=None, titles='auto', animated=False, twiss=None, **kwargs)[source]#

      Bases: xplt.base.XPlot, xplt.particles.ParticlePlotMixin

      A plot for phase space distributions

      @@ -511,7 +511,7 @@

      Module Contents
      -static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#
      +static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#

      Add a scale patch (a yardstick or ruler)

      Parameters:
      @@ -541,12 +541,12 @@

      Module Contents
      -annotate(text, **kwargs)[source]#
      +annotate(text, **kwargs)[source]#

      -axes(subplots='all', twins='all')[source]#
      +axes(subplots='all', twins='all')[source]#

      Generator yielding axes for the given flat subplot and twin indices

      Parameters:
      @@ -564,7 +564,7 @@

      Module Contents
      -axis(subplot=0, twin=0)[source]#
      +axis(subplot=0, twin=0)[source]#

      Return the axis for a given flat subplot index and twin index

      Parameters:
      @@ -584,7 +584,7 @@

      Module Contents
      -axline(kind, val, *, subplots='all', also_on_normalized=False, delta=0, **kwargs)[source]#
      +axline(kind, val, *, subplots='all', also_on_normalized=False, delta=0, **kwargs)[source]#

      Plot a vertical or horizontal line for a given coordinate

      Parameters:
      @@ -602,13 +602,13 @@

      Module Contents
      -beta(particles=None)[source]#
      +beta(particles=None)[source]#

      Get reference relativistic beta as float

      -display_unit_for(p)[source]#
      +display_unit_for(p)[source]#

      Return display unit for parameter

      Parameters:
      @@ -625,7 +625,7 @@

      Module Contents
      -factor_for(p)[source]#
      +factor_for(p)[source]#

      Return factor to convert parameter into display unit

      Parameters:
      @@ -642,13 +642,13 @@

      Module Contents
      -frev(particles=None)[source]#
      +frev(particles=None)[source]#

      Get reference revolution frequency

      -get_property(name)[source]#
      +get_property(name)[source]#

      Public method to get a particle property by key

      Parameters:
      @@ -665,7 +665,7 @@

      Module Contents
      -label_for(*pp, unit=True, description=True)[source]#
      +label_for(*pp, unit=True, description=True)[source]#

      Return axis label for list of properties, joining where possible

      Parameters:
      @@ -686,7 +686,7 @@

      Module Contents
      -plot_hamiltonian_kobayashi(subplots, S, mu, *, delta=0, extend=1, autoscale=1.1, separatrix=True, separatrix_kwargs=None, equipotentials=True, equipotentials_kwargs=None)[source]#
      +plot_hamiltonian_kobayashi(subplots, S, mu, *, delta=0, extend=1, autoscale=1.1, separatrix=True, separatrix_kwargs=None, equipotentials=True, equipotentials_kwargs=None)[source]#

      Plot separatrix and equipotential lines of kobayashi hamiltonian

      Parameters:
      @@ -708,7 +708,7 @@

      Module Contents
      -static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#
      +static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#

      Add vertical lines or spans indicating the location of values or spans and their harmonics

      Indicates the bands at the h-th harmonics (h = 1, 2, …, n) at
        @@ -738,7 +738,7 @@

        Module Contents
        -prop(name)[source]#
        +prop(name)[source]#

        Get property by key

        Parameters:
        @@ -755,7 +755,7 @@

        Module Contents
        -save(fname, **kwargs)[source]#
        +save(fname, **kwargs)[source]#

        Save the figure with sensible default options

        Parameters:
        @@ -769,7 +769,7 @@

        Module Contents
        -title(title, **kwargs)[source]#
        +title(title, **kwargs)[source]#

        Set figure title

        Parameters:
        @@ -783,13 +783,13 @@

        Module Contents
        -title_for(a, b)[source]#
        +title_for(a, b)[source]#

        Plot title for a given pair (a,b) of properties

        -update(particles, *, mask=None, masks=None, autoscale=False)[source]#
        +update(particles, *, mask=None, masks=None, autoscale=False)[source]#

        Update the data this plot shows

        Parameters:
        diff --git a/0.11/autoapi/xplt/properties/index.html b/0.11/autoapi/xplt/properties/index.html index a10851f..3d9219b 100644 --- a/0.11/autoapi/xplt/properties/index.html +++ b/0.11/autoapi/xplt/properties/index.html @@ -8,7 +8,7 @@ - xplt.properties — Xplt 0.11.3-rc3 documentation + xplt.properties — Xplt 0.11.3-rc4 documentation @@ -42,7 +42,7 @@ - + @@ -59,7 +59,7 @@ - + @@ -121,7 +121,7 @@ -

        Xplt 0.11.3-rc3 documentation

        +

        Xplt 0.11.3-rc4 documentation

        @@ -492,7 +492,7 @@

        Functions#

        -class xplt.properties.DataProperty(key, unit, symbol=None, description=None)[source]#
        +class xplt.properties.DataProperty(key, unit, symbol=None, description=None)[source]#

        Bases: Property

        Class for property which can directly be accessed from data

        @@ -509,7 +509,7 @@

        Module Contents
        -prop(name)[source]#
        +prop(name)[source]#

        Find a property by name

        This method is overwritten by plots which provide custom properties

        @@ -524,7 +524,7 @@

        Module Contents
        -values(data, mask=None, *, unit=None)[source]#
        +values(data, mask=None, *, unit=None)[source]#

        Get masked data for this property

        Parameters:
        @@ -550,7 +550,7 @@

        Module Contents
        -with_property_resolver(resolver)[source]#
        +with_property_resolver(resolver)[source]#

        Create a new property with a custom property resolver

        Parameters:
        @@ -583,7 +583,7 @@

        Module Contents
        -class xplt.properties.DerivedProperty(symbol, unit, evaluate, description=None)[source]#
        +class xplt.properties.DerivedProperty(symbol, unit, evaluate, description=None)[source]#

        Bases: Property

        Class for property which is derived from other properties

        @@ -599,7 +599,7 @@

        Module Contents
        -prop(name)[source]#
        +prop(name)[source]#

        Find a property by name

        This method is overwritten by plots which provide custom properties

        @@ -614,7 +614,7 @@

        Module Contents
        -values(data, mask=None, *, unit=None)[source]#
        +values(data, mask=None, *, unit=None)[source]#

        Get masked data for this property

        Parameters:
        @@ -625,7 +625,7 @@

        Module Contents
        -with_property_resolver(resolver)[source]#
        +with_property_resolver(resolver)[source]#

        Create a new property with a custom property resolver

        Parameters:
        @@ -658,7 +658,7 @@

        Module Contents
        -class xplt.properties.Property(symbol, unit, description=None)[source]#
        +class xplt.properties.Property(symbol, unit, description=None)[source]#

        Class holding generic property information

        Parameters:
        @@ -671,7 +671,7 @@

        Module Contents
        -prop(name)[source]#
        +prop(name)[source]#

        Find a property by name

        This method is overwritten by plots which provide custom properties

        @@ -686,7 +686,7 @@

        Module Contents
        -abstract values(data, mask=None, *, unit=None)[source]#
        +abstract values(data, mask=None, *, unit=None)[source]#

        Get masked data for this property

        Parameters:
        @@ -701,7 +701,7 @@

        Module Contents
        -with_property_resolver(resolver)[source]#
        +with_property_resolver(resolver)[source]#

        Create a new property with a custom property resolver

        Parameters:
        @@ -729,7 +729,7 @@

        Module Contents
        -xplt.properties.find_property(name, *, extra_user_properties=None, extra_default_properties=None)[source]#
        +xplt.properties.find_property(name, *, extra_user_properties=None, extra_default_properties=None)[source]#

        Find a Property by name

        Parameters:
        @@ -753,7 +753,7 @@

        Module Contents
        -xplt.properties.register_data_property(name, data_unit, symbol=None, description=None)[source]#
        +xplt.properties.register_data_property(name, data_unit, symbol=None, description=None)[source]#

        Register a user defined data property

        Parameters:
        @@ -769,7 +769,7 @@

        Module Contents
        -xplt.properties.register_derived_property(name, function, unit=None, symbol=None, description=None)[source]#
        +xplt.properties.register_derived_property(name, function, unit=None, symbol=None, description=None)[source]#

        Register a user defined derived property

        Parameters:
        @@ -787,7 +787,7 @@

        Module Contents
        -xplt.properties.register_property(name, property)[source]#
        +xplt.properties.register_property(name, property)[source]#

        Register a user defined property

        Parameters:
        diff --git a/0.11/autoapi/xplt/timestructure/index.html b/0.11/autoapi/xplt/timestructure/index.html index 882e361..3163c2b 100644 --- a/0.11/autoapi/xplt/timestructure/index.html +++ b/0.11/autoapi/xplt/timestructure/index.html @@ -8,7 +8,7 @@ - xplt.timestructure — Xplt 0.11.3-rc3 documentation + xplt.timestructure — Xplt 0.11.3-rc4 documentation @@ -42,7 +42,7 @@ - + @@ -61,7 +61,7 @@ - + @@ -123,7 +123,7 @@ -

        Xplt 0.11.3-rc3 documentation

        +

        Xplt 0.11.3-rc4 documentation

        @@ -495,7 +495,7 @@

        Classes#<

        Module Contents#

        -class xplt.timestructure.MetricesMixin[source]#
        +class xplt.timestructure.MetricesMixin[source]#

        Mixin to evaluate particle fluctuation metrices for spill quality analysis

        The following metrics are implemented:

          @@ -528,7 +528,7 @@

          Module Contents
          -class xplt.timestructure.SpillQualityPlot(particles=None, kind='cv', *, counting_dt=None, evaluate_dt=None, poisson=True, mask=None, timeseries=None, time_range=None, time_offset=0, plot_kwargs=None, poisson_kwargs=None, add_default_dataset=True, **kwargs)[source]#
          +class xplt.timestructure.SpillQualityPlot(particles=None, kind='cv', *, counting_dt=None, evaluate_dt=None, poisson=True, mask=None, timeseries=None, time_range=None, time_offset=0, plot_kwargs=None, poisson_kwargs=None, add_default_dataset=True, **kwargs)[source]#

          Bases: xplt.base.XManifoldPlot, TimePlotMixin, xplt.particles.ParticlePlotMixin, MetricesMixin

          Plot variability of particle time on microscopic scale as function of time on macroscopic scale

          The particle arrival times are histogramed into counting bins, the width of which @@ -562,7 +562,7 @@

          Module Contents
          -add_dataset(id=AUTO, *, plot_kwargs=None, poisson=True, poisson_kwargs=None, **kwargs)[source]#
          +add_dataset(id=AUTO, *, plot_kwargs=None, poisson=True, poisson_kwargs=None, **kwargs)[source]#

          Create artists for a new dataset to the plot and optionally update their values

          Parameters:
          @@ -580,7 +580,7 @@

          Module Contents
          -static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#
          +static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#

          Add a scale patch (a yardstick or ruler)

          Parameters:
          @@ -610,12 +610,12 @@

          Module Contents
          -annotate(text, **kwargs)[source]#
          +annotate(text, **kwargs)[source]#

          -artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#
          +artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#

          Return the artist either by name, or by subplot, twin axes and trace index

          Parameters:
          @@ -638,7 +638,7 @@

          Module Contents
          -autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#
          +autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#

          Autoscale the axes of a subplot

          Parameters:
          @@ -659,7 +659,7 @@

          Module Contents
          -axes(subplots='all', twins='all')[source]#
          +axes(subplots='all', twins='all')[source]#

          Generator yielding axes for the given flat subplot and twin indices

          Parameters:
          @@ -677,7 +677,7 @@

          Module Contents
          -axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#
          +axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#

          Return the axis for a given flat subplot index and twin index, or an artist name

          Either get axis by index axis(subplot, twin) or by property name axis(name).

          @@ -700,7 +700,7 @@

          Module Contents
          -axline(kind, val, **kwargs)[source]#
          +axline(kind, val, **kwargs)[source]#

          Plot a vertical or horizontal line for a given coordinate

          Parameters:
          @@ -715,7 +715,7 @@

          Module Contents
          -axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#
          +axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#

          Plot a vertical or horizontal span (or line) for a given coordinate

          Parameters:
          @@ -740,13 +740,13 @@

          Module Contents
          -beta(particles=None)[source]#
          +beta(particles=None)[source]#

          Get reference relativistic beta as float

          -display_unit_for(p)[source]#
          +display_unit_for(p)[source]#

          Return display unit for parameter

          Parameters:
          @@ -763,7 +763,7 @@

          Module Contents
          -factor_for(p)[source]#
          +factor_for(p)[source]#

          Return factor to convert parameter into display unit

          Parameters:
          @@ -780,13 +780,13 @@

          Module Contents
          -frev(particles=None)[source]#
          +frev(particles=None)[source]#

          Get reference revolution frequency

          -get_property(name)[source]#
          +get_property(name)[source]#

          Public method to get a particle property by key

          Parameters:
          @@ -803,7 +803,7 @@

          Module Contents
          -label_for(*pp, unit=True, description=True)[source]#
          +label_for(*pp, unit=True, description=True)[source]#

          Return axis label for list of properties, joining where possible

          Parameters:
          @@ -824,7 +824,7 @@

          Module Contents
          -legend(subplot='all', show=True, **kwargs)[source]#
          +legend(subplot='all', show=True, **kwargs)[source]#

          Add, update or remove legend for a subplot

          Parameters:
          @@ -840,7 +840,7 @@

          Module Contents
          -static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#
          +static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#

          Parse a separated string or nested list or a mixture of both

          Parameters:
          @@ -871,7 +871,7 @@

          Module Contents
          -static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#
          +static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#

          Add vertical lines or spans indicating the location of values or spans and their harmonics

          Indicates the bands at the h-th harmonics (h = 1, 2, …, n) at
            @@ -901,7 +901,7 @@

            Module Contents
            -prop(name)[source]#
            +prop(name)[source]#

            Get property by key

            Parameters:
            @@ -918,7 +918,7 @@

            Module Contents
            -save(fname, **kwargs)[source]#
            +save(fname, **kwargs)[source]#

            Save the figure with sensible default options

            Parameters:
            @@ -932,7 +932,7 @@

            Module Contents
            -title(title, **kwargs)[source]#
            +title(title, **kwargs)[source]#

            Set figure title

            Parameters:
            @@ -946,7 +946,7 @@

            Module Contents
            -update(particles=None, mask=None, *, autoscale=None, timeseries=None, dataset_id=None)[source]#
            +update(particles=None, mask=None, *, autoscale=None, timeseries=None, dataset_id=None)[source]#

            Update plot with new data

            Parameters:
            @@ -1026,7 +1026,7 @@

            Module Contents
            -class xplt.timestructure.SpillQualityTimescalePlot(particles=None, kind='cv', *, counting_dt_min=None, counting_dt_max=None, counting_bins_per_evaluation=50, std=True, poisson=True, mask=None, timeseries=None, time_range=None, plot_kwargs=None, std_kwargs=None, poisson_kwargs=None, ignore_insufficient_statistics=False, add_default_dataset=True, **kwargs)[source]#
            +class xplt.timestructure.SpillQualityTimescalePlot(particles=None, kind='cv', *, counting_dt_min=None, counting_dt_max=None, counting_bins_per_evaluation=50, std=True, poisson=True, mask=None, timeseries=None, time_range=None, plot_kwargs=None, std_kwargs=None, poisson_kwargs=None, ignore_insufficient_statistics=False, add_default_dataset=True, **kwargs)[source]#

            Bases: xplt.base.XManifoldPlot, TimePlotMixin, xplt.particles.ParticlePlotMixin, MetricesMixin

            Plot variability of particle time as function of timescale

            The particle arrival times are histogramed into counting bins, the width of which @@ -1069,7 +1069,7 @@

            Module Contents
            -add_dataset(id=AUTO, *, plot_kwargs=None, std=True, std_kwargs=None, poisson=True, poisson_kwargs=None, **kwargs)[source]#
            +add_dataset(id=AUTO, *, plot_kwargs=None, std=True, std_kwargs=None, poisson=True, poisson_kwargs=None, **kwargs)[source]#

            Create artists for a new dataset to the plot and optionally update their values

            Parameters:
            @@ -1091,7 +1091,7 @@

            Module Contents
            -static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#
            +static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#

            Add a scale patch (a yardstick or ruler)

            Parameters:
            @@ -1121,12 +1121,12 @@

            Module Contents
            -annotate(text, **kwargs)[source]#
            +annotate(text, **kwargs)[source]#

            -artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#
            +artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#

            Return the artist either by name, or by subplot, twin axes and trace index

            Parameters:
            @@ -1149,7 +1149,7 @@

            Module Contents
            -autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#
            +autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#

            Autoscale the axes of a subplot

            Parameters:
            @@ -1170,7 +1170,7 @@

            Module Contents
            -axes(subplots='all', twins='all')[source]#
            +axes(subplots='all', twins='all')[source]#

            Generator yielding axes for the given flat subplot and twin indices

            Parameters:
            @@ -1188,7 +1188,7 @@

            Module Contents
            -axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#
            +axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#

            Return the axis for a given flat subplot index and twin index, or an artist name

            Either get axis by index axis(subplot, twin) or by property name axis(name).

            @@ -1211,7 +1211,7 @@

            Module Contents
            -axline(kind, val, **kwargs)[source]#
            +axline(kind, val, **kwargs)[source]#

            Plot a vertical or horizontal line for a given coordinate

            Parameters:
            @@ -1226,7 +1226,7 @@

            Module Contents
            -axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#
            +axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#

            Plot a vertical or horizontal span (or line) for a given coordinate

            Parameters:
            @@ -1251,13 +1251,13 @@

            Module Contents
            -beta(particles=None)[source]#
            +beta(particles=None)[source]#

            Get reference relativistic beta as float

            -display_unit_for(p)[source]#
            +display_unit_for(p)[source]#

            Return display unit for parameter

            Parameters:
            @@ -1274,7 +1274,7 @@

            Module Contents
            -factor_for(p)[source]#
            +factor_for(p)[source]#

            Return factor to convert parameter into display unit

            Parameters:
            @@ -1291,13 +1291,13 @@

            Module Contents
            -frev(particles=None)[source]#
            +frev(particles=None)[source]#

            Get reference revolution frequency

            -get_property(name)[source]#
            +get_property(name)[source]#

            Public method to get a particle property by key

            Parameters:
            @@ -1314,7 +1314,7 @@

            Module Contents
            -label_for(*pp, unit=True, description=True)[source]#
            +label_for(*pp, unit=True, description=True)[source]#

            Return axis label for list of properties, joining where possible

            Parameters:
            @@ -1335,7 +1335,7 @@

            Module Contents
            -legend(subplot='all', show=True, **kwargs)[source]#
            +legend(subplot='all', show=True, **kwargs)[source]#

            Add, update or remove legend for a subplot

            Parameters:
            @@ -1351,7 +1351,7 @@

            Module Contents
            -static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#
            +static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#

            Parse a separated string or nested list or a mixture of both

            Parameters:
            @@ -1382,7 +1382,7 @@

            Module Contents
            -static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#
            +static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#

            Add vertical lines or spans indicating the location of values or spans and their harmonics

            Indicates the bands at the h-th harmonics (h = 1, 2, …, n) at
              @@ -1412,7 +1412,7 @@

              Module Contents
              -prop(name)[source]#
              +prop(name)[source]#

              Get property by key

              Parameters:
              @@ -1429,7 +1429,7 @@

              Module Contents
              -save(fname, **kwargs)[source]#
              +save(fname, **kwargs)[source]#

              Save the figure with sensible default options

              Parameters:
              @@ -1443,7 +1443,7 @@

              Module Contents
              -title(title, **kwargs)[source]#
              +title(title, **kwargs)[source]#

              Set figure title

              Parameters:
              @@ -1457,7 +1457,7 @@

              Module Contents
              -update(particles=None, mask=None, autoscale=None, *, timeseries=None, ignore_insufficient_statistics=False, dataset_id=None)[source]#
              +update(particles=None, mask=None, autoscale=None, *, timeseries=None, ignore_insufficient_statistics=False, dataset_id=None)[source]#

              Update plot with new data

              Parameters:
              @@ -1543,7 +1543,7 @@

              Module Contents
              -class xplt.timestructure.TimeBinMetricHelper(*, twiss=None, beta=None, frev=None, circumference=None)[source]#
              +class xplt.timestructure.TimeBinMetricHelper(*, twiss=None, beta=None, frev=None, circumference=None)[source]#

              Bases: xplt.particles.ParticlePlotMixin, MetricesMixin

              Helper class for binning and evaluating metrices on timeseries data

              @@ -1558,13 +1558,13 @@

              Module Contents
              -beta(particles=None)[source]#
              +beta(particles=None)[source]#

              Get reference relativistic beta as float

              -binned_timeseries(particles, dt=None, *, mask=None, t_range=None, what=None, moments=1)[source]#
              +binned_timeseries(particles, dt=None, *, mask=None, t_range=None, what=None, moments=1)[source]#

              Get binned timeseries with equally spaced time bins

              Parameters:
              @@ -1605,7 +1605,7 @@

              Module Contents
              -calculate_metric(counts, metric, nbins, *, sliding_window=False)[source]#
              +calculate_metric(counts, metric, nbins, *, sliding_window=False)[source]#

              Calculate metric on timeseries

              Parameters:
              @@ -1628,13 +1628,13 @@

              Module Contents
              -frev(particles=None)[source]#
              +frev(particles=None)[source]#

              Get reference revolution frequency

              -get_property(name)[source]#
              +get_property(name)[source]#

              Public method to get a particle property by key

              Parameters:
              @@ -1659,7 +1659,7 @@

              Module Contents
              -class xplt.timestructure.TimeBinPlot(particles=None, kind='count', *, bin_time=None, bin_count=None, relative=False, moment=1, mask=None, timeseries=None, time_range=None, time_offset=0, plot_kwargs=None, add_default_dataset=True, **kwargs)[source]#
              +class xplt.timestructure.TimeBinPlot(particles=None, kind='count', *, bin_time=None, bin_count=None, relative=False, moment=1, mask=None, timeseries=None, time_range=None, time_offset=0, plot_kwargs=None, add_default_dataset=True, **kwargs)[source]#

              Bases: xplt.particles.ParticleHistogramPlot, TimePlotMixin

              A binned histogram plot of particles as function of times

              @@ -1699,14 +1699,14 @@

              Module Contents
              -add_dataset(id=AUTO, *, plot_kwargs=None, particles=None, timeseries=None, **kwargs)[source]#
              +add_dataset(id=AUTO, *, plot_kwargs=None, particles=None, timeseries=None, **kwargs)[source]#

              Create artists for a new dataset to the plot and optionally update their values

              See add_dataset().

              -static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#
              +static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#

              Add a scale patch (a yardstick or ruler)

              Parameters:
              @@ -1736,12 +1736,12 @@

              Module Contents
              -annotate(text, **kwargs)[source]#
              +annotate(text, **kwargs)[source]#

              -artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#
              +artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#

              Return the artist either by name, or by subplot, twin axes and trace index

              Parameters:
              @@ -1764,7 +1764,7 @@

              Module Contents
              -autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#
              +autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#

              Autoscale the axes of a subplot

              Parameters:
              @@ -1785,7 +1785,7 @@

              Module Contents
              -axes(subplots='all', twins='all')[source]#
              +axes(subplots='all', twins='all')[source]#

              Generator yielding axes for the given flat subplot and twin indices

              Parameters:
              @@ -1803,7 +1803,7 @@

              Module Contents
              -axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#
              +axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#

              Return the axis for a given flat subplot index and twin index, or an artist name

              Either get axis by index axis(subplot, twin) or by property name axis(name).

              @@ -1826,7 +1826,7 @@

              Module Contents
              -axline(kind, val, **kwargs)[source]#
              +axline(kind, val, **kwargs)[source]#

              Plot a vertical or horizontal line for a given coordinate

              Parameters:
              @@ -1841,7 +1841,7 @@

              Module Contents
              -axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#
              +axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#

              Plot a vertical or horizontal span (or line) for a given coordinate

              Parameters:
              @@ -1866,13 +1866,13 @@

              Module Contents
              -beta(particles=None)[source]#
              +beta(particles=None)[source]#

              Get reference relativistic beta as float

              -display_unit_for(p)[source]#
              +display_unit_for(p)[source]#

              Return display unit for parameter

              Parameters:
              @@ -1889,7 +1889,7 @@

              Module Contents
              -factor_for(p)[source]#
              +factor_for(p)[source]#

              Return factor to convert parameter into display unit

              Parameters:
              @@ -1906,13 +1906,13 @@

              Module Contents
              -frev(particles=None)[source]#
              +frev(particles=None)[source]#

              Get reference revolution frequency

              -get_property(name)[source]#
              +get_property(name)[source]#

              Public method to get a particle property by key

              Parameters:
              @@ -1929,7 +1929,7 @@

              Module Contents
              -label_for(*pp, unit=True, description=True)[source]#
              +label_for(*pp, unit=True, description=True)[source]#

              Return axis label for list of properties, joining where possible

              Parameters:
              @@ -1950,7 +1950,7 @@

              Module Contents
              -legend(subplot='all', show=True, **kwargs)[source]#
              +legend(subplot='all', show=True, **kwargs)[source]#

              Add, update or remove legend for a subplot

              Parameters:
              @@ -1966,7 +1966,7 @@

              Module Contents
              -static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#
              +static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#

              Parse a separated string or nested list or a mixture of both

              Parameters:
              @@ -1997,7 +1997,7 @@

              Module Contents
              -static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#
              +static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#

              Add vertical lines or spans indicating the location of values or spans and their harmonics

              Indicates the bands at the h-th harmonics (h = 1, 2, …, n) at
                @@ -2027,7 +2027,7 @@

                Module Contents
                -prop(name)[source]#
                +prop(name)[source]#

                Get property by key

                Parameters:
                @@ -2044,7 +2044,7 @@

                Module Contents
                -save(fname, **kwargs)[source]#
                +save(fname, **kwargs)[source]#

                Save the figure with sensible default options

                Parameters:
                @@ -2058,7 +2058,7 @@

                Module Contents
                -title(title, **kwargs)[source]#
                +title(title, **kwargs)[source]#

                Set figure title

                Parameters:
                @@ -2072,7 +2072,7 @@

                Module Contents
                -update(particles, mask=None, *, timeseries=None, autoscale=None, dataset_id=None)[source]#
                +update(particles, mask=None, *, timeseries=None, autoscale=None, dataset_id=None)[source]#

                Update plot with new data

                See update().

                @@ -2158,7 +2158,7 @@

                Module Contents
                -class xplt.timestructure.TimeFFTPlot(particles=None, kind='count', *, fmax=None, fsamp=None, fsamp_exact=False, relative=False, scaling=None, welch=None, mask=None, timeseries=None, time_range=None, plot_kwargs=None, averaging=None, averaging_shadow=True, averaging_shadow_kwargs=None, add_default_dataset=True, **kwargs)[source]#
                +class xplt.timestructure.TimeFFTPlot(particles=None, kind='count', *, fmax=None, fsamp=None, fsamp_exact=False, relative=False, scaling=None, welch=None, mask=None, timeseries=None, time_range=None, plot_kwargs=None, averaging=None, averaging_shadow=True, averaging_shadow_kwargs=None, add_default_dataset=True, **kwargs)[source]#

                Bases: xplt.base.XManifoldPlot, TimePlotMixin, xplt.particles.ParticlePlotMixin, xplt.particles.ParticleHistogramPlotMixin

                A frequency plot based on particle arrival times

                @@ -2218,7 +2218,7 @@

                Module Contents
                -add_dataset(id=AUTO, *, plot_kwargs=None, averaging_shadow=True, averaging_shadow_kwargs=None, **kwargs)[source]#
                +add_dataset(id=AUTO, *, plot_kwargs=None, averaging_shadow=True, averaging_shadow_kwargs=None, **kwargs)[source]#

                Create artists for a new dataset to the plot and optionally update their values

                Parameters:
                @@ -2236,7 +2236,7 @@

                Module Contents
                -static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#
                +static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#

                Add a scale patch (a yardstick or ruler)

                Parameters:
                @@ -2266,12 +2266,12 @@

                Module Contents
                -annotate(text, **kwargs)[source]#
                +annotate(text, **kwargs)[source]#

                -artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#
                +artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#

                Return the artist either by name, or by subplot, twin axes and trace index

                Parameters:
                @@ -2294,7 +2294,7 @@

                Module Contents
                -autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#
                +autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#

                Autoscale the axes of a subplot

                Parameters:
                @@ -2315,7 +2315,7 @@

                Module Contents
                -axes(subplots='all', twins='all')[source]#
                +axes(subplots='all', twins='all')[source]#

                Generator yielding axes for the given flat subplot and twin indices

                Parameters:
                @@ -2333,7 +2333,7 @@

                Module Contents
                -axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#
                +axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#

                Return the axis for a given flat subplot index and twin index, or an artist name

                Either get axis by index axis(subplot, twin) or by property name axis(name).

                @@ -2356,7 +2356,7 @@

                Module Contents
                -axline(kind, val, **kwargs)[source]#
                +axline(kind, val, **kwargs)[source]#

                Plot a vertical or horizontal line for a given coordinate

                Parameters:
                @@ -2371,7 +2371,7 @@

                Module Contents
                -axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#
                +axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#

                Plot a vertical or horizontal span (or line) for a given coordinate

                Parameters:
                @@ -2396,13 +2396,13 @@

                Module Contents
                -beta(particles=None)[source]#
                +beta(particles=None)[source]#

                Get reference relativistic beta as float

                -display_unit_for(p)[source]#
                +display_unit_for(p)[source]#

                Return display unit for parameter

                Parameters:
                @@ -2419,7 +2419,7 @@

                Module Contents
                -factor_for(p)[source]#
                +factor_for(p)[source]#

                Return factor to convert parameter into display unit

                Parameters:
                @@ -2436,7 +2436,7 @@

                Module Contents
                -fmax(particles=None, *, default=None)[source]#
                +fmax(particles=None, *, default=None)[source]#

                Return the maximum frequency this plot should show

                Parameters:
                @@ -2459,13 +2459,13 @@

                Module Contents
                -frev(particles=None)[source]#
                +frev(particles=None)[source]#

                Get reference revolution frequency

                -get_property(name)[source]#
                +get_property(name)[source]#

                Public method to get a particle property by key

                Parameters:
                @@ -2482,7 +2482,7 @@

                Module Contents
                -label_for(*pp, unit=True, description=True)[source]#
                +label_for(*pp, unit=True, description=True)[source]#

                Return axis label for list of properties, joining where possible

                Parameters:
                @@ -2503,7 +2503,7 @@

                Module Contents
                -legend(subplot='all', show=True, **kwargs)[source]#
                +legend(subplot='all', show=True, **kwargs)[source]#

                Add, update or remove legend for a subplot

                Parameters:
                @@ -2519,7 +2519,7 @@

                Module Contents
                -static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#
                +static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#

                Parse a separated string or nested list or a mixture of both

                Parameters:
                @@ -2550,7 +2550,7 @@

                Module Contents
                -plot_harmonics(f, df=0, *, n=20, relative=False, **plot_kwargs)[source]#
                +plot_harmonics(f, df=0, *, n=20, relative=False, **plot_kwargs)[source]#

                Add vertical lines or spans indicating the location of values or spans and their harmonics

                Parameters:
                @@ -2568,7 +2568,7 @@

                Module Contents
                -prop(name)[source]#
                +prop(name)[source]#

                Get property by key

                Parameters:
                @@ -2585,7 +2585,7 @@

                Module Contents
                -save(fname, **kwargs)[source]#
                +save(fname, **kwargs)[source]#

                Save the figure with sensible default options

                Parameters:
                @@ -2599,7 +2599,7 @@

                Module Contents
                -title(title, **kwargs)[source]#
                +title(title, **kwargs)[source]#

                Set figure title

                Parameters:
                @@ -2613,7 +2613,7 @@

                Module Contents
                -update(particles=None, mask=None, *, autoscale=None, timeseries=None, dataset_id=None)[source]#
                +update(particles=None, mask=None, *, autoscale=None, timeseries=None, dataset_id=None)[source]#

                Update plot with new data

                Parameters:
                @@ -2701,7 +2701,7 @@

                Module Contents
                -class xplt.timestructure.TimeIntervalPlot(particles=None, kind='count', *, dt_max, bin_time=None, bin_count=None, exact_bin_time=True, relative=False, poisson=False, mask=None, time_range=None, plot_kwargs=None, poisson_kwargs=None, add_default_dataset=True, **kwargs)[source]#
                +class xplt.timestructure.TimeIntervalPlot(particles=None, kind='count', *, dt_max, bin_time=None, bin_count=None, exact_bin_time=True, relative=False, poisson=False, mask=None, time_range=None, plot_kwargs=None, poisson_kwargs=None, add_default_dataset=True, **kwargs)[source]#

                Bases: xplt.base.XManifoldPlot, TimePlotMixin, xplt.particles.ParticlePlotMixin, xplt.particles.ParticleHistogramPlotMixin

                A histogram plot of particle arrival intervals (i.e. delay between consecutive particles)

                @@ -2740,7 +2740,7 @@

                Module Contents
                -add_dataset(id=AUTO, *, plot_kwargs=None, poisson=False, poisson_kwargs=None, **kwargs)[source]#
                +add_dataset(id=AUTO, *, plot_kwargs=None, poisson=False, poisson_kwargs=None, **kwargs)[source]#

                Create artists for a new dataset to the plot and optionally update their values

                Parameters:
                @@ -2758,7 +2758,7 @@

                Module Contents
                -static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#
                +static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#

                Add a scale patch (a yardstick or ruler)

                Parameters:
                @@ -2788,12 +2788,12 @@

                Module Contents
                -annotate(text, **kwargs)[source]#
                +annotate(text, **kwargs)[source]#

                -artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#
                +artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#

                Return the artist either by name, or by subplot, twin axes and trace index

                Parameters:
                @@ -2816,7 +2816,7 @@

                Module Contents
                -autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#
                +autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#

                Autoscale the axes of a subplot

                Parameters:
                @@ -2837,7 +2837,7 @@

                Module Contents
                -axes(subplots='all', twins='all')[source]#
                +axes(subplots='all', twins='all')[source]#

                Generator yielding axes for the given flat subplot and twin indices

                Parameters:
                @@ -2855,7 +2855,7 @@

                Module Contents
                -axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#
                +axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#

                Return the axis for a given flat subplot index and twin index, or an artist name

                Either get axis by index axis(subplot, twin) or by property name axis(name).

                @@ -2878,7 +2878,7 @@

                Module Contents
                -axline(kind, val, **kwargs)[source]#
                +axline(kind, val, **kwargs)[source]#

                Plot a vertical or horizontal line for a given coordinate

                Parameters:
                @@ -2893,7 +2893,7 @@

                Module Contents
                -axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#
                +axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#

                Plot a vertical or horizontal span (or line) for a given coordinate

                Parameters:
                @@ -2918,13 +2918,13 @@

                Module Contents
                -beta(particles=None)[source]#
                +beta(particles=None)[source]#

                Get reference relativistic beta as float

                -display_unit_for(p)[source]#
                +display_unit_for(p)[source]#

                Return display unit for parameter

                Parameters:
                @@ -2941,7 +2941,7 @@

                Module Contents
                -factor_for(p)[source]#
                +factor_for(p)[source]#

                Return factor to convert parameter into display unit

                Parameters:
                @@ -2958,13 +2958,13 @@

                Module Contents
                -frev(particles=None)[source]#
                +frev(particles=None)[source]#

                Get reference revolution frequency

                -get_property(name)[source]#
                +get_property(name)[source]#

                Public method to get a particle property by key

                Parameters:
                @@ -2981,7 +2981,7 @@

                Module Contents
                -label_for(*pp, unit=True, description=True)[source]#
                +label_for(*pp, unit=True, description=True)[source]#

                Return axis label for list of properties, joining where possible

                Parameters:
                @@ -3002,7 +3002,7 @@

                Module Contents
                -legend(subplot='all', show=True, **kwargs)[source]#
                +legend(subplot='all', show=True, **kwargs)[source]#

                Add, update or remove legend for a subplot

                Parameters:
                @@ -3018,7 +3018,7 @@

                Module Contents
                -static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#
                +static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#

                Parse a separated string or nested list or a mixture of both

                Parameters:
                @@ -3049,7 +3049,7 @@

                Module Contents
                -plot_harmonics(t, *, n=20, **plot_kwargs)[source]#
                +plot_harmonics(t, *, n=20, **plot_kwargs)[source]#

                Add vertical lines or spans indicating the location of values or spans and their harmonics

                Parameters:
                @@ -3064,7 +3064,7 @@

                Module Contents
                -prop(name)[source]#
                +prop(name)[source]#

                Get property by key

                Parameters:
                @@ -3081,7 +3081,7 @@

                Module Contents
                -save(fname, **kwargs)[source]#
                +save(fname, **kwargs)[source]#

                Save the figure with sensible default options

                Parameters:
                @@ -3095,7 +3095,7 @@

                Module Contents
                -title(title, **kwargs)[source]#
                +title(title, **kwargs)[source]#

                Set figure title

                Parameters:
                @@ -3109,7 +3109,7 @@

                Module Contents
                -update(particles, mask=None, *, autoscale=None, dataset_id=None)[source]#
                +update(particles, mask=None, *, autoscale=None, dataset_id=None)[source]#

                Update plot with new data

                Parameters:
                @@ -3194,7 +3194,7 @@

                Module Contents
                -class xplt.timestructure.TimePlot(particles=None, kind='x+y', **kwargs)[source]#
                +class xplt.timestructure.TimePlot(particles=None, kind='x+y', **kwargs)[source]#

                Bases: xplt.particles.ParticlesPlot

                A plot of particle properties as function of time

                A thin wrapper around the ParticlesPlot plotting data as function of time. @@ -3219,7 +3219,7 @@

                Module Contents
                -add_dataset(id=AUTO, *, plot_kwargs=None, **kwargs)[source]#
                +add_dataset(id=AUTO, *, plot_kwargs=None, **kwargs)[source]#

                Create artists for a new dataset to the plot and optionally update their values

                Parameters:
                @@ -3234,7 +3234,7 @@

                Module Contents
                -static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#
                +static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#

                Add a scale patch (a yardstick or ruler)

                Parameters:
                @@ -3264,12 +3264,12 @@

                Module Contents
                -annotate(text, **kwargs)[source]#
                +annotate(text, **kwargs)[source]#

                -artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#
                +artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#

                Return the artist either by name, or by subplot, twin axes and trace index

                Parameters:
                @@ -3292,7 +3292,7 @@

                Module Contents
                -autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#
                +autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#

                Autoscale the axes of a subplot

                Parameters:
                @@ -3313,7 +3313,7 @@

                Module Contents
                -axes(subplots='all', twins='all')[source]#
                +axes(subplots='all', twins='all')[source]#

                Generator yielding axes for the given flat subplot and twin indices

                Parameters:
                @@ -3331,7 +3331,7 @@

                Module Contents
                -axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#
                +axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#

                Return the axis for a given flat subplot index and twin index, or an artist name

                Either get axis by index axis(subplot, twin) or by property name axis(name).

                @@ -3354,7 +3354,7 @@

                Module Contents
                -axline(kind, val, **kwargs)[source]#
                +axline(kind, val, **kwargs)[source]#

                Plot a vertical or horizontal line for a given coordinate

                Parameters:
                @@ -3369,7 +3369,7 @@

                Module Contents
                -axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#
                +axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#

                Plot a vertical or horizontal span (or line) for a given coordinate

                Parameters:
                @@ -3394,13 +3394,13 @@

                Module Contents
                -beta(particles=None)[source]#
                +beta(particles=None)[source]#

                Get reference relativistic beta as float

                -display_unit_for(p)[source]#
                +display_unit_for(p)[source]#

                Return display unit for parameter

                Parameters:
                @@ -3417,7 +3417,7 @@

                Module Contents
                -factor_for(p)[source]#
                +factor_for(p)[source]#

                Return factor to convert parameter into display unit

                Parameters:
                @@ -3434,13 +3434,13 @@

                Module Contents
                -frev(particles=None)[source]#
                +frev(particles=None)[source]#

                Get reference revolution frequency

                -get_property(name)[source]#
                +get_property(name)[source]#

                Public method to get a particle property by key

                Parameters:
                @@ -3457,7 +3457,7 @@

                Module Contents
                -label_for(*pp, unit=True, description=True)[source]#
                +label_for(*pp, unit=True, description=True)[source]#

                Return axis label for list of properties, joining where possible

                Parameters:
                @@ -3478,7 +3478,7 @@

                Module Contents
                -legend(subplot='all', show=True, **kwargs)[source]#
                +legend(subplot='all', show=True, **kwargs)[source]#

                Add, update or remove legend for a subplot

                Parameters:
                @@ -3494,7 +3494,7 @@

                Module Contents
                -static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#
                +static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#

                Parse a separated string or nested list or a mixture of both

                Parameters:
                @@ -3525,7 +3525,7 @@

                Module Contents
                -static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#
                +static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#

                Add vertical lines or spans indicating the location of values or spans and their harmonics

                Indicates the bands at the h-th harmonics (h = 1, 2, …, n) at
                  @@ -3555,7 +3555,7 @@

                  Module Contents
                  -prop(name)[source]#
                  +prop(name)[source]#

                  Get property by key

                  Parameters:
                  @@ -3572,7 +3572,7 @@

                  Module Contents
                  -save(fname, **kwargs)[source]#
                  +save(fname, **kwargs)[source]#

                  Save the figure with sensible default options

                  Parameters:
                  @@ -3586,7 +3586,7 @@

                  Module Contents
                  -title(title, **kwargs)[source]#
                  +title(title, **kwargs)[source]#

                  Set figure title

                  Parameters:
                  @@ -3600,7 +3600,7 @@

                  Module Contents
                  -update(particles, mask=None, *, autoscale=None, dataset_id=None)[source]#
                  +update(particles, mask=None, *, autoscale=None, dataset_id=None)[source]#

                  Update plot with new data

                  Parameters:
                  @@ -3673,11 +3673,11 @@

                  Module Contents
                  -class xplt.timestructure.TimePlotMixin[source]#
                  +class xplt.timestructure.TimePlotMixin[source]#

                  Mixin for plotting time based data

                  -_init_time_mixin(*, time_range=None, time_offset=0.0, **kwargs)[source]#
                  +_init_time_mixin(*, time_range=None, time_offset=0.0, **kwargs)[source]#

                  Initializes the mixin by providing associated information

                  Parameters:
                  @@ -3698,7 +3698,7 @@

                  Module Contents
                  -class xplt.timestructure.Timeseries[source]#
                  +class xplt.timestructure.Timeseries[source]#

                  Class holding timeseries data

                  Parameters:
                  @@ -3711,7 +3711,7 @@

                  Module Contents
                  -crop(t_start=None, t_stop=None)[source]#
                  +crop(t_start=None, t_stop=None)[source]#

                  Crop data to time range

                  Parameters:
                  @@ -3731,13 +3731,13 @@

                  Module Contents
                  -static from_timestamps(times, *, what=None, n=None, dt=None, t_range=None, moments=1, make_n_power_of_two=False)[source]#
                  +static from_timestamps(times, *, what=None, n=None, dt=None, t_range=None, moments=1, make_n_power_of_two=False)[source]#

                  Create a timeseries from the timestamps provided

                  -resample(dt, *, mode='mean')[source]#
                  +resample(dt, *, mode='mean')[source]#

                  Resample data to reduced time resolution

                  Parameters:
                  @@ -3758,7 +3758,7 @@

                  Module Contents
                  -times(endpoint=False)[source]#
                  +times(endpoint=False)[source]#

                  Array of times associated with the datapoints

                  Parameters:
                  diff --git a/0.11/autoapi/xplt/twiss/index.html b/0.11/autoapi/xplt/twiss/index.html index e97dc4c..29b4412 100644 --- a/0.11/autoapi/xplt/twiss/index.html +++ b/0.11/autoapi/xplt/twiss/index.html @@ -8,7 +8,7 @@ - xplt.twiss — Xplt 0.11.3-rc3 documentation + xplt.twiss — Xplt 0.11.3-rc4 documentation @@ -42,7 +42,7 @@ - + @@ -59,7 +59,7 @@ - + @@ -121,7 +121,7 @@ -

                  Xplt 0.11.3-rc3 documentation

                  +

                  Xplt 0.11.3-rc4 documentation

                  @@ -466,7 +466,7 @@

                  Classes#<

                  Module Contents#

                  -class xplt.twiss.TwissPlot(twiss=None, kind='bet-dx,x+y', *, line=None, line_kwargs={}, **kwargs)[source]#
                  +class xplt.twiss.TwissPlot(twiss=None, kind='bet-dx,x+y', *, line=None, line_kwargs={}, **kwargs)[source]#

                  Bases: xplt.base.XManifoldPlot

                  A plot for twiss parameters and closed orbit

                  @@ -484,7 +484,7 @@

                  Module Contents
                  -static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#
                  +static add_scale(ax, scale, label=None, *, vertical=False, width=0.01, padding=0.1, loc='auto', color='k', fontsize='x-small')[source]#

                  Add a scale patch (a yardstick or ruler)

                  Parameters:
                  @@ -514,12 +514,12 @@

                  Module Contents
                  -annotate(text, **kwargs)[source]#
                  +annotate(text, **kwargs)[source]#

                  -artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#
                  +artist(name=None, subplot=None, twin=None, trace=None, *, dataset_id=None)[source]#

                  Return the artist either by name, or by subplot, twin axes and trace index

                  Parameters:
                  @@ -542,7 +542,7 @@

                  Module Contents
                  -autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#
                  +autoscale(subplot='all', *, axis='xy', reset=False, freeze=True, tight=None)[source]#

                  Autoscale the axes of a subplot

                  Parameters:
                  @@ -563,7 +563,7 @@

                  Module Contents
                  -axes(subplots='all', twins='all')[source]#
                  +axes(subplots='all', twins='all')[source]#

                  Generator yielding axes for the given flat subplot and twin indices

                  Parameters:
                  @@ -581,7 +581,7 @@

                  Module Contents
                  -axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#
                  +axis(subplot_or_name=0, twin=0, *, subplot=None, name=None)[source]#

                  Return the axis for a given flat subplot index and twin index, or an artist name

                  Either get axis by index axis(subplot, twin) or by property name axis(name).

                  @@ -604,7 +604,7 @@

                  Module Contents
                  -axline(kind, val, **kwargs)[source]#
                  +axline(kind, val, **kwargs)[source]#

                  Plot a vertical or horizontal line for a given coordinate

                  Parameters:
                  @@ -619,7 +619,7 @@

                  Module Contents
                  -axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#
                  +axspan(kind, val, val_to=None, *, subplots='all', annotation=None, annotation_loc=None, annotation_kwargs=None, **kwargs)[source]#

                  Plot a vertical or horizontal span (or line) for a given coordinate

                  Parameters:
                  @@ -644,7 +644,7 @@

                  Module Contents
                  -display_unit_for(p)[source]#
                  +display_unit_for(p)[source]#

                  Return display unit for parameter

                  Parameters:
                  @@ -661,7 +661,7 @@

                  Module Contents
                  -factor_for(p)[source]#
                  +factor_for(p)[source]#

                  Return factor to convert parameter into display unit

                  Parameters:
                  @@ -678,7 +678,7 @@

                  Module Contents
                  -label_for(*pp, unit=True, description=True)[source]#
                  +label_for(*pp, unit=True, description=True)[source]#

                  Return axis label for list of properties, joining where possible

                  Parameters:
                  @@ -699,7 +699,7 @@

                  Module Contents
                  -legend(subplot='all', show=True, **kwargs)[source]#
                  +legend(subplot='all', show=True, **kwargs)[source]#

                  Add, update or remove legend for a subplot

                  Parameters:
                  @@ -715,7 +715,7 @@

                  Module Contents
                  -static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#
                  +static parse_nested_list_string(list_string, separators=',-+', subs={}, *, strip_off_methods=False)[source]#

                  Parse a separated string or nested list or a mixture of both

                  Parameters:
                  @@ -746,7 +746,7 @@

                  Module Contents
                  -plot_apertures(data, which=None, **kwargs)[source]#
                  +plot_apertures(data, which=None, **kwargs)[source]#

                  Plot apertures onto the relevant axes

                  Parameters:
                  @@ -763,7 +763,7 @@

                  Module Contents
                  -static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#
                  +static plot_harmonics(ax, v, dv=0, *, n=20, scale_width=True, vertical=True, inverse=False, **plot_kwargs)[source]#

                  Add vertical lines or spans indicating the location of values or spans and their harmonics

                  Indicates the bands at the h-th harmonics (h = 1, 2, …, n) at
                    @@ -793,7 +793,7 @@

                    Module Contents
                    -prop(name)[source]#
                    +prop(name)[source]#

                    Get property by key

                    Parameters:
                    @@ -810,7 +810,7 @@

                    Module Contents
                    -save(fname, **kwargs)[source]#
                    +save(fname, **kwargs)[source]#

                    Save the figure with sensible default options

                    Parameters:
                    @@ -824,7 +824,7 @@

                    Module Contents
                    -title(title, **kwargs)[source]#
                    +title(title, **kwargs)[source]#

                    Set figure title

                    Parameters:
                    @@ -838,7 +838,7 @@

                    Module Contents
                    -update(twiss, *, autoscale=None, line=None)[source]#
                    +update(twiss, *, autoscale=None, line=None)[source]#

                    Update the twiss data this plot shows

                    Parameters:
                    diff --git a/0.11/autoapi/xplt/util/index.html b/0.11/autoapi/xplt/util/index.html index 15be6a6..5cbe7d8 100644 --- a/0.11/autoapi/xplt/util/index.html +++ b/0.11/autoapi/xplt/util/index.html @@ -8,7 +8,7 @@ - xplt.util — Xplt 0.11.3-rc3 documentation + xplt.util — Xplt 0.11.3-rc4 documentation @@ -42,7 +42,7 @@ - + @@ -58,7 +58,7 @@ - + @@ -120,7 +120,7 @@ -

                    Xplt 0.11.3-rc3 documentation

                    +

                    Xplt 0.11.3-rc4 documentation

                    @@ -535,7 +535,7 @@

                    Functions#

                    -class xplt.util.AttrDict(*args, **kwargs)[source]#
                    +class xplt.util.AttrDict(*args, **kwargs)[source]#

                    Bases: dict

                    Dict which allows accessing values via key attributes

                    Initialize self. See help(type(self)) for accurate signature.

                    @@ -543,7 +543,7 @@

                    Module Contents
                    -xplt.util.apertures(line, at_s=None)[source]#
                    +xplt.util.apertures(line, at_s=None)[source]#

                    Determine aperture

                    Parameters:
                    @@ -557,7 +557,7 @@

                    Module Contents
                    -xplt.util.average(*data, n=100, function=np.mean, logspace=False, keepdim=False)[source]#
                    +xplt.util.average(*data, n=100, function=np.mean, logspace=False, keepdim=False)[source]#

                    Average the data

                    Applies the function to n subsequent points of the data (along last axis) to yield one point in the output

                    @@ -580,7 +580,7 @@

                    Module Contents
                    -xplt.util.binned_data(values, *, what=None, n=None, dv=None, v_range=None, moments=1, make_n_power_of_two=False)[source]#
                    +xplt.util.binned_data(values, *, what=None, n=None, dv=None, v_range=None, moments=1, make_n_power_of_two=False)[source]#

                    Get histogrammed data with equally spaced bins

                    From the non-equally distributed values, a histogram or timeseries with equally spaced bins is derived. The parameter what determines what is returned for the timeseries. @@ -623,7 +623,7 @@

                    Module Contents
                    -xplt.util.defaults(kwargs, /, **default_kwargs)[source]#
                    +xplt.util.defaults(kwargs, /, **default_kwargs)[source]#

                    Return keyword arguments with defaults

                    Returns a union of keyword arguments, where kwargs take precedence over default_kwargs.

                    @@ -638,7 +638,7 @@

                    Module Contents
                    -xplt.util.defaults_for(alias_provider, kwargs, /, **default_kwargs)[source]#
                    +xplt.util.defaults_for(alias_provider, kwargs, /, **default_kwargs)[source]#

                    Return normalized keyword arguments with defaults

                    Returns a union of keyword arguments, where kwargs take precedence over default_kwargs. All keyword arguments are normalized beforehand via matplotlib.cbook.normalize_kwargs().

                    @@ -655,7 +655,7 @@

                    Module Contents
                    -xplt.util.denormalized_coordinates(X, Px, twiss, xy, delta=0)[source]#
                    +xplt.util.denormalized_coordinates(X, Px, twiss, xy, delta=0)[source]#

                    Convert normalized to physical coordinates

                    Parameters:
                    @@ -682,25 +682,25 @@

                    Module Contents
                    -xplt.util.evaluate_expression_wrapper(expression, key, data)[source]#
                    +xplt.util.evaluate_expression_wrapper(expression, key, data)[source]#

                    Evaluate the expression wrapper

                    -xplt.util.flattened(lists)[source]#
                    +xplt.util.flattened(lists)[source]#

                    Flatten a list of nested lists recursively

                    -xplt.util.fmt(t, unit='s')[source]#
                    +xplt.util.fmt(t, unit='s')[source]#

                    Human-readable representation of value in unit (latex syntax)

                    -xplt.util.get(obj, value, default=VOID)[source]#
                    +xplt.util.get(obj, value, default=VOID)[source]#

                    Get value from object

                    Tries to get the value using attributes and indices, and handles special objects like pandas data frames.

                    @@ -726,7 +726,7 @@

                    Module Contents
                    -xplt.util.hamiltonian_kobayashi(X, Px, S, mu, twiss, xy='x', delta=0, *, normalized=False)[source]#
                    +xplt.util.hamiltonian_kobayashi(X, Px, S, mu, twiss, xy='x', delta=0, *, normalized=False)[source]#

                    Calculate the kobayashi hamiltonian

                    Parameters:
                    @@ -756,13 +756,13 @@

                    Module Contents
                    -xplt.util.ieee_mod(values, m)[source]#
                    +xplt.util.ieee_mod(values, m)[source]#

                    Return the IEEE remainder (in range -x/2 .. x/2)

                    -xplt.util.iter_elements(line, *, s=None, mask_nearest=False)[source]#
                    +xplt.util.iter_elements(line, *, s=None, mask_nearest=False)[source]#

                    Iterate over elements in line

                    Parameters:
                    @@ -788,7 +788,7 @@

                    Module Contents
                    -xplt.util.normalized_coordinates(x, px, twiss, xy, delta=0)[source]#
                    +xplt.util.normalized_coordinates(x, px, twiss, xy, delta=0)[source]#

                    Convert physical to normalized coordinates

                    Parameters:
                    @@ -815,7 +815,7 @@

                    Module Contents
                    -xplt.util.smooth(*data, n)[source]#
                    +xplt.util.smooth(*data, n)[source]#

                    Smooth the data over n consecutive bins

                    Parameters:
                    @@ -836,13 +836,13 @@

                    Module Contents
                    -xplt.util.val(obj)[source]#
                    +xplt.util.val(obj)[source]#

                    Return the value if this is an array of size 1, object otherwise

                    -xplt.util.virtual_sextupole(line, particle_ref=None, *, verbose=False)[source]#
                    +xplt.util.virtual_sextupole(line, particle_ref=None, *, verbose=False)[source]#

                    Determine virtual sextupole strength from the line

                    The normalized strenght is defined as S = -1/2 * betx^(3/2) * k2l

                    The implementation considers only normal sextupole components.

                    diff --git a/0.11/examples/animations.html b/0.11/examples/animations.html index 04f2a85..35031b8 100644 --- a/0.11/examples/animations.html +++ b/0.11/examples/animations.html @@ -5,7 +5,7 @@ -Animations — Xplt 0.11.3-rc3 documentation +Animations — Xplt 0.11.3-rc4 documentation + @@ -49,7 +49,7 @@ - + @@ -74,7 +74,7 @@