y.p.OptsBase(object) : class documentation

Part of yampex.plot View In Hierarchy Source for plot.py Project Page for yampex

Known subclasses: yampex.plot.Plotter

No class docstring
Method set_loglog Makes both axes logarithmic, unless called with False.
Method set_semilogx Makes x-axis logarithmic, unless called with False.
Method set_semilogy Makes y-axis logarithmic, unless called with False.
Method set_useLabels Has annotation labels point to each plot line instead of a legend, with text taken from the legend list. Call with False to revert to default legend-box behavior.
Method set_grid Adds a grid, unless called with False.
Method set_timex Uses intelligent time scaling for the x-axis, unless called with False.
Method set_firstVectorTop Has the first dependent vector (the second argument to the Plotter object call) determine the top (maximum) of the displayed plot boundary.
Method set_bump No summary
Method set_zeroBottom No summary
Method add_marker No summary
Method add_line No summary
Method set_yscale Manually sets the y-axis scaling.
Method set_axvline Adds a vertical dashed line at the data point with index k.
Method set_xlabel Sets the x-axis label. (Ignored if time-x mode has been activated with a call to set_timex.)
Method set_ylabel Sets the y-axis label.
Method add_legend No summary
Method clear_legend Clears the list of legend entries.
Method set_legend Sets the list of legend entries.
Method add_annotation No summary
Method clear_annotations Clears the list of annotations.
Method set_title Sets a subplot title. You may include a text prototype with format-substitution args, or just supply the final text string with no further arguments.
def set_loglog(self, yes=True):

Makes both axes logarithmic, unless called with False.

def set_semilogx(self, yes=True):

Makes x-axis logarithmic, unless called with False.

def set_semilogy(self, yes=True):

Makes y-axis logarithmic, unless called with False.

def set_useLabels(self, yes=True):

Has annotation labels point to each plot line instead of a legend, with text taken from the legend list. Call with False to revert to default legend-box behavior.

def set_grid(self, yes=True):

Adds a grid, unless called with False.

def set_timex(self, yes=True):

Uses intelligent time scaling for the x-axis, unless called with False.

def set_firstVectorTop(self):

Has the first dependent vector (the second argument to the Plotter object call) determine the top (maximum) of the displayed plot boundary.

def set_bump(self, yes=True):

If you don't manually set a yscale with a call to set_yscale, you can call this method to bump the common y-axis upper limit to 120% of what Matplotlib decides. Call with False to disable the bump.

def set_zeroBottom(self, yes=True):

Sets the bottom (minimum) of the Y-axis range to zero, unless called with False. This is useful for plotting values that are never negative and where zero is a meaningful absolute minimum.

def add_marker(self, x):

Appends the supplied marker style character to the list of markers being used. The first and possibly only marker in the list applies to the first vector plotted within a given subplot. If there is an additional vector being plotted within a given subplot (three or more arguments supplied when calling the Plotter object, and more than one marker has been added to the list, then the second marker in the list is used for that second vector plot line. Otherwise, the first (only) marker in the list is used for the second plot line as well.

def add_line(self, x=None):

Appends the supplied line style character to the list of line styles being used. The first and possibly only line style in the list applies to the first vector plotted within a given subplot. If there is an additional vector being plotted within a given subplot (three or more arguments supplied when calling the Plotter object, and more than one line style has been added to the list, then the second line style in the list is used for that second vector plot line. Otherwise, the first (only) line style in the list is used for the second plot line as well.

If no line style character or None is supplied, clears the list of line styles.

def set_yscale(self, x):

Manually sets the y-axis scaling.

def set_axvline(self, k):

Adds a vertical dashed line at the data point with index k.

def set_xlabel(self, x):

Sets the x-axis label. (Ignored if time-x mode has been activated with a call to set_timex.)

def set_ylabel(self, x):

Sets the y-axis label.

def add_legend(self, proto, *args):

Adds the supplied format-substituted text to the list of legend entries. You may include a text prototype with format-substitution args, or just supply the final text string with no further arguments.

def clear_legend(self):

Clears the list of legend entries.

def set_legend(self, *args):

Sets the list of legend entries.

def add_annotation(self, k, text, kVector=0):

Adds the supplied text as an annotation at index k of the plotted vector. If there is more than one vector being plotted within the same subplot, you can have the annotation refer to a vector other than the first one by supplying an additional integer argument.

def clear_annotations(self):

Clears the list of annotations.

def set_title(self, proto, *args):

Sets a subplot title. You may include a text prototype with format-substitution args, or just supply the final text string with no further arguments.

API Documentation for yampex, generated by pydoctor at 2018-09-19 15:04:47.