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 @@ -
Xplt 0.11.3-rc3 documentation
+Xplt 0.11.3-rc4 documentation
@@ -442,7 +442,7 @@Version 0.11.3-rc3
+Version 0.11.3-rc4
Xplt 0.11.3-rc3 documentation
+Xplt 0.11.3-rc4 documentation
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 @@
Bases: matplotlib.ticker.ScalarFormatter
Format tick values as a number.
Bases: matplotlib.scale.LinearScale
The default linear scale.
Return the transform for linear scaling, which is just the ~matplotlib.transforms.IdentityTransform.
Set the locators and formatters of axis to instances suitable for this scale.
Bases: matplotlib.ticker.AutoLocator
Place evenly spaced ticks, with the step size and maximum number of ticks chosen automatically.
@@ -997,7 +997,7 @@Set parameters for this locator.
Bases: matplotlib.transforms.Transform
The base class of all TransformNode instances that actually perform a transformation.
@@ -1153,7 +1153,7 @@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 @@
Apply only the non-affine part of this transformation.
transform(values)
is always equivalent to
transform_affine(transform_non_affine(values))
.
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 @@
Bases: matplotlib.ticker.Formatter
A tick formatter to format angles in radians as fractions or multiples of pi
Bases: matplotlib.ticker.Locator
Determine tick locations.
Note that the same locator should not be used across multiple @@ -1646,7 +1646,7 @@
Return the values of the located ticks given vmin and vmax.
Note
@@ -1708,7 +1708,7 @@Bases: matplotlib.ticker.Locator
Determine tick locations.
Note that the same locator should not be used across multiple @@ -1773,7 +1773,7 @@
Return the values of the located ticks given vmin and vmax.
Note
@@ -1830,7 +1830,7 @@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 @@
Add a scale patch (a yardstick or ruler)
Return the artist either by name, or by subplot, twin axes and trace index
Autoscale the axes of a subplot
Generator yielding axes for the given flat subplot and twin indices
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)
.
Plot a vertical or horizontal line for a given coordinate
Plot a vertical or horizontal span (or line) for a given coordinate
Return display unit for parameter
Return factor to convert parameter into display unit
Return axis label for list of properties, joining where possible
Add, update or remove legend for a subplot
Parse a separated string or nested list or a mixture of both
Add vertical lines or spans indicating the location of values or spans and their harmonics
Get property by key
Save the figure with sensible default options
Set figure title
Base class for plotting
Initialize the subplots, axes and twin axes
Add a scale patch (a yardstick or ruler)
Generator yielding axes for the given flat subplot and twin indices
Return the axis for a given flat subplot index and twin index
Return display unit for parameter
Return factor to convert parameter into display unit
Return axis label for list of properties, joining where possible
Add vertical lines or spans indicating the location of values or spans and their harmonics
Get property by key
Save the figure with sensible default options
Set figure title
Xplt 0.11.3-rc3 documentation
+Xplt 0.11.3-rc4 documentation
Make a linear colormap of a given color from transparent to black
Xplt 0.11.3-rc3 documentation
+Xplt 0.11.3-rc4 documentation
Register default options for matplotlib
Register default options for pint
Xplt 0.11.3-rc3 documentation
+Xplt 0.11.3-rc4 documentation
@@ -481,7 +481,7 @@Apply xplt’s matplotlib style sheet and update rcParams
Xplt 0.11.3-rc3 documentation
+Xplt 0.11.3-rc4 documentation
@@ -492,7 +492,7 @@Bases: xplt.base.XPlot
A floor plan of the line based on survey data
Add a scale patch (a yardstick or ruler)
Generator yielding axes for the given flat subplot and twin indices
Return the axis for a given flat subplot index and twin index
Return display unit for parameter
Return factor to convert parameter into display unit
Return axis label for list of properties, joining where possible
Add vertical lines or spans indicating the location of values or spans and their harmonics
Get property by key
Save the figure with sensible default options
Set figure title
Update the survey data this plot shows
Bases: xplt.base.XManifoldPlot
A plot for knl values along line
Add a scale patch (a yardstick or ruler)
Return the artist either by name, or by subplot, twin axes and trace index
Autoscale the axes of a subplot
Generator yielding axes for the given flat subplot and twin indices
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)
.
Plot a vertical or horizontal line for a given coordinate
Plot a vertical or horizontal span (or line) for a given coordinate
Return display unit for parameter
Return factor to convert parameter into display unit
Return axis label for list of properties, joining where possible
Add, update or remove legend for a subplot
Parse a separated string or nested list or a mixture of both
Add vertical lines or spans indicating the location of values or spans and their harmonics
Get property by key
Save the figure with sensible default options
Set figure title
Update the line data this plot shows
Get effective order of element (ignoring zero strength)
Get knl strength of element
Get nominal element order (even if coefficients might be zero)
Get order of knl string as int
Tangens cardinalis, i.e. tan(x)/x with limit tanc(0)=1
Xplt 0.11.3-rc3 documentation
+Xplt 0.11.3-rc4 documentation
@@ -477,7 +477,7 @@Bases: xplt.base.XManifoldPlot
, ParticlePlotMixin
, ParticleHistogramPlotMixin
A 1D histogram plot for any particle property
Create artists for a new dataset to the plot and optionally update their values
Add a scale patch (a yardstick or ruler)
Return the artist either by name, or by subplot, twin axes and trace index
Autoscale the axes of a subplot
Generator yielding axes for the given flat subplot and twin indices
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)
.
Plot a vertical or horizontal line for a given coordinate
Plot a vertical or horizontal span (or line) for a given coordinate
Get reference relativistic beta as float
Return display unit for parameter
Return factor to convert parameter into display unit
Get reference revolution frequency
Public method to get a particle property by key
Return axis label for list of properties, joining where possible
Add, update or remove legend for a subplot
Parse a separated string or nested list or a mixture of both
Add vertical lines or spans indicating the location of values or spans and their harmonics
Get property by key
Save the figure with sensible default options
Set figure title
Update plot with new data
Mixin for plotting of histogram particle data
Initializes the mixin by providing associated information
Mixin for plotting of particle data
Initializes the mixin by providing associated information
For a given particle object with inherent properties like x
, y
, px
, py
, zeta
, delta
, etc.
this mixin allows determination of the following derived properties:
Get reference relativistic beta as float
Public method to get a particle property by key
Bases: xplt.base.XManifoldPlot
, ParticlePlotMixin
A plot of particle properties as function of another property
Create artists for a new dataset to the plot and optionally update their values
Add a scale patch (a yardstick or ruler)
Return the artist either by name, or by subplot, twin axes and trace index
Autoscale the axes of a subplot
Generator yielding axes for the given flat subplot and twin indices
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)
.
Plot a vertical or horizontal line for a given coordinate
Plot a vertical or horizontal span (or line) for a given coordinate
Get reference relativistic beta as float
Return display unit for parameter
Return factor to convert parameter into display unit
Get reference revolution frequency
Public method to get a particle property by key
Return axis label for list of properties, joining where possible
Add, update or remove legend for a subplot
Parse a separated string or nested list or a mixture of both
Add vertical lines or spans indicating the location of values or spans and their harmonics
Get property by key
Save the figure with sensible default options
Set figure title
Update plot with new data
Xplt 0.11.3-rc3 documentation
+Xplt 0.11.3-rc4 documentation
Bases: xplt.base.XPlot
, xplt.particles.ParticlePlotMixin
A plot for phase space distributions
Add a scale patch (a yardstick or ruler)
Generator yielding axes for the given flat subplot and twin indices
Return the axis for a given flat subplot index and twin index
Plot a vertical or horizontal line for a given coordinate
Get reference relativistic beta as float
Return display unit for parameter
Return factor to convert parameter into display unit
Get reference revolution frequency
Public method to get a particle property by key
Return axis label for list of properties, joining where possible
Plot separatrix and equipotential lines of kobayashi hamiltonian
Add vertical lines or spans indicating the location of values or spans and their harmonics
Get property by key
Save the figure with sensible default options
Set figure title
Plot title for a given pair (a,b) of properties
Update the data this plot shows
Xplt 0.11.3-rc3 documentation
+Xplt 0.11.3-rc4 documentation
Bases: Property
Class for property which can directly be accessed from data
Find a property by name
This method is overwritten by plots which provide custom properties
Get masked data for this property
Create a new property with a custom property resolver
Bases: Property
Class for property which is derived from other properties
Find a property by name
This method is overwritten by plots which provide custom properties
Get masked data for this property
Create a new property with a custom property resolver
Class holding generic property information
Find a property by name
This method is overwritten by plots which provide custom properties
Get masked data for this property
Create a new property with a custom property resolver
Find a Property by name
Register a user defined data property
Register a user defined derived property
Register a user defined property
Xplt 0.11.3-rc3 documentation
+Xplt 0.11.3-rc4 documentation
Mixin to evaluate particle fluctuation metrices for spill quality analysis
The following metrics are implemented:
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 @@
Create artists for a new dataset to the plot and optionally update their values
Add a scale patch (a yardstick or ruler)
Return the artist either by name, or by subplot, twin axes and trace index
Autoscale the axes of a subplot
Generator yielding axes for the given flat subplot and twin indices
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)
.
Plot a vertical or horizontal line for a given coordinate
Plot a vertical or horizontal span (or line) for a given coordinate
Get reference relativistic beta as float
Return display unit for parameter
Return factor to convert parameter into display unit
Get reference revolution frequency
Public method to get a particle property by key
Return axis label for list of properties, joining where possible
Add, update or remove legend for a subplot
Parse a separated string or nested list or a mixture of both
Add vertical lines or spans indicating the location of values or spans and their harmonics
Get property by key
Save the figure with sensible default options
Set figure title
Update plot with new data
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 @@
Create artists for a new dataset to the plot and optionally update their values
Add a scale patch (a yardstick or ruler)
Return the artist either by name, or by subplot, twin axes and trace index
Autoscale the axes of a subplot
Generator yielding axes for the given flat subplot and twin indices
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)
.
Plot a vertical or horizontal line for a given coordinate
Plot a vertical or horizontal span (or line) for a given coordinate
Get reference relativistic beta as float
Return display unit for parameter
Return factor to convert parameter into display unit
Get reference revolution frequency
Public method to get a particle property by key
Return axis label for list of properties, joining where possible
Add, update or remove legend for a subplot
Parse a separated string or nested list or a mixture of both
Add vertical lines or spans indicating the location of values or spans and their harmonics
Get property by key
Save the figure with sensible default options
Set figure title
Update plot with new data
Bases: xplt.particles.ParticlePlotMixin
, MetricesMixin
Helper class for binning and evaluating metrices on timeseries data
Get reference relativistic beta as float
Get binned timeseries with equally spaced time bins
Calculate metric on timeseries
Get reference revolution frequency
Public method to get a particle property by key
Bases: xplt.particles.ParticleHistogramPlot
, TimePlotMixin
A binned histogram plot of particles as function of times
Create artists for a new dataset to the plot and optionally update their values
See add_dataset()
.
Add a scale patch (a yardstick or ruler)
Return the artist either by name, or by subplot, twin axes and trace index
Autoscale the axes of a subplot
Generator yielding axes for the given flat subplot and twin indices
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)
.
Plot a vertical or horizontal line for a given coordinate
Plot a vertical or horizontal span (or line) for a given coordinate
Get reference relativistic beta as float
Return display unit for parameter
Return factor to convert parameter into display unit
Get reference revolution frequency
Public method to get a particle property by key