Skip to content

objects.md

Latest commit

 

History

History
739 lines (298 loc) · 6.71 KB

objects.md

File metadata and controls

739 lines (298 loc) · 6.71 KB

Autofig Objects

import autofig
import numpy as np
import astropy.units as u

autofig works by creating a hierarchy of objects which dictates how a figure should be rendered. These exist at three main levels:

  • Figure
  • Axes
    • AxesDimension (i, x, y, z, c, s)
  • Call (Plot or Mesh)
    • CallDimension (i, x, y, z, c, s)

Calling autofig.plot is simply a shortcut to accessing a built-in Figure object. We can access this object via autofig.gcf() (get current figure) at anytime, or can call the plot method of an instantiated Figure directly.

autofig.reset()
autofig.plot(x=[1,2,3], xunit='s', y=[1,2,3], c=[1,2,3], i='x', uncover=True)
autofig.gcf()
<Figure | 1 axes | 1 call(s)>

figure = autofig.Figure()
figure.plot(x=[1,2,3], xunit='s', y=[1,2,3], c=[1,2,3], i='x', uncover=True)
figure
<Figure | 1 axes | 1 call(s)>

Figure

Options

The Figure object holds the collection of Axes objects and is in charge of the subplot layout. As such, it does not currently accept or hold many options.

Methods

The Figure object has the following methods:

  • plot
  • mesh (not yet implemented)
  • reset_draw
  • draw
  • animate
  • add_axes
  • add_call

Hierarchy Links

From the Figure object, you can access the list of children axes:

figure.axes
<AxesGroup | 1 items | >

as well as the list of all Call objects in those axes:

figure.calls
<PlotGroup | 1 items | >

Axes

axes = figure.axes[0]
axes
<Axes | 1 call(s) | dims: c>

Options

equal_aspect

axes.equal_aspect
False

pad_aspect

axes.pad_aspect
False

Methods

The Axes object has the following methods:

  • draw
  • add_call

Hierarchy Links

From the Axes object, you can access the parent Figure or a list of the children Call objects

axes.figure
<Figure | 1 axes | 1 call(s)>

axes.calls
<PlotGroup | 1 items | >

As well as any of its dimensions (i, x, y, z)

axes.x
<x | limits: (None, None) | type: time | label: >

Or a combination of the cartesian dimensions

axes.xyz
<AxDimensionGroup | 3 items | directions: x, y, z | labels: , , >

axes.xy
<AxDimensionGroup | 2 items | directions: x, y | labels: , >

or a list of its color/size dimensions (cs, ss)

axes.cs
<AxDimensionGroup | 1 items | directions: c | labels: >

AxesDimension

ad = axes.x
ad
<x | limits: (None, None) | type: time | label: >

Options

unit

The unit in the AxesDimension will be those actually plotted (i.e. all values will be converted from their stored units to these)

ad.unit

$\mathrm{s}$

ad.unit='d'
ad.unit

$\mathrm{d}$

pad

Padding provided to an AxesDimension will override the default padding on the Axes itself. Here since it has not been set yet, it defaults to the value from the Axes

ad.pad
0.1

axes.pad=0.05
ad.pad
0.1

ad.pad=0.15
axes.pad=0.08
ad.pad
0.15

lim

Limits will adhere to the padding of the same AxesDimension.

ad.lim
(None, None)

ad.pad=0.0
ad.lim
(None, None)

label

ad.label
''

ad.label='mylabel'
ad.label_with_units
'mylabel [$\\mathrm{d}$]'

Hierarchy Links

The AxesDimension object has a link back to its parent Axes

ad.axes
<Axes | 1 call(s) | dims: c>

Cyclers

lsc = axes.linestylecycler
lsc
<linestylecycler | cycle: ['solid', 'dashed', 'dotted', 'dashdot'] | used: []>

Options

cycle

The cycle defines the order at which the properties will be drawn.

lsc.cycle
['solid', 'dashed', 'dotted', 'dashdot']

If desired, you can change this default order (Note: the cycle can be shorter than the original, but you cannot add new items)

lsc.cycle = ['dashed', 'dotted', 'dashdot', 'solid']

Plot (Call)

plot = axes.calls[0]
plot
<Call:Plot | dims: i, x, y, c>

Options

kwargs (sent on to matplotlib, when possible)

plot.kwargs
{}

highlight

plot.highlight
True

plot.highlight_marker
'o'

If None, highlight_size will default to size

plot.highlight_size
0.04

plot.highlight_linestyle
'None'

If None, highlight_color will default to color

plot.highlight_color

uncover

plot.uncover
True

plot.uncover=True
ad.get_lim(i=1.5)
(1.1574074074074073e-05, 3.472222222222222e-05)

plot.uncover=False
ad.get_lim(i=1.5)
(1.1574074074074073e-05, 3.472222222222222e-05)

consider for limits

plot.consider_for_limits=False
ad.get_lim(i=1.5)
(None, None)

plot.consider_for_limits=True
ad.get_lim(i=1.5)
(1.1574074074074073e-05, 3.472222222222222e-05)

Methods

The Plot object has the following methods:

  • draw

Hierarchy Links

The Plot object has a link back to its parent Axes and grandparent Figure objects.

plot.axes
<Axes | 1 call(s) | dims: c>

plot.figure
<Figure | 1 axes | 1 call(s)>

PlotDimension

pd = plot.x
pd
<x | len: 3 | type: time | label: None>

Options

unit

The unit in PlotDimension holds the units of the provided array. These will be converted to the necessary units for plotting. Changing this unit does not do any converting of the array, so change with caution.

pd.unit

$\mathrm{s}$

label

pd.label

Methods

get_value

In addition to the 'value' property, get_value will handle hiding values after 'i' and interpolating to that exact value.

pd.get_value()
array([1, 2, 3])

plot.uncover=False
pd.get_value(i=1.5)
array([1, 2, 3])

plot.uncover=True
pd.get_value(i=1.5)
array([1. , 1.5])

get_error (for cartesian only)

Same as above for get_value, except interpolation will not be used for the final value.

interpolate_at_i

interpolate_at_i simply interpolates the value for a given value of the independent variable

pd.interpolate_at_i(i=1.5)
1.5

Hierarchy Links

The CallDimension objects have shortcuts back to their parent Call (Plot or Mesh)

pd.call
<Call:Plot | dims: i, x, y, c>