3.1.9.2.10. Options for PlotCoeffIter
subfigure¶
Option aliases:
ErrPltOptions -> EpsilonPlotOptions
ErrorFormat -> EpsilonFormat
DeltaOptions -> DeltaPlotOptions
IterativeError -> KEpsilon
LineOptions -> PlotOptions
MeanOptions -> MuPlotOptions
NMin -> NMinStats
StDevOptions -> SigmaPlotOptions
col -> Coefficient
nMaxStats -> NMaxStats
nMin -> NMinStats
nMinStats -> NMinStats
nStats -> NStats
nAverage -> NStats
nAvg -> NStats
nEpsilon -> KEpsilon
nPlotFirst -> NPlotFirst
nFirst -> NPlotFirst
nPlotIters -> NPlotIters
nPlotLast -> NPlotLast
FigHeight -> FigureHeight
FigWidth -> FigureWidth
GridStyle -> GridPlotOptions
MinorGridStyle -> MinorGridPlotOptions
RestrictionLocation -> RestrictionLoc
RestrictionX -> RestrictionXPosition
RestrictionY -> RestrictionYPosition
dpi -> DPI
Parent -> Type
parent -> Type
pos -> Position
type -> Type
width -> Width
Sigma -> KSigma
StandardDeviation -> KSigma
ksig -> KSigma
nSigma -> KSigma
sig -> NSigma
sigma -> KSigma
Recognized options:
- Alignment: {
'center'
} |object
value of option “Alignment”
- Caption: {
None
} |str
subfigure caption
- CaptionComponent: {
None
} |str
explicit text for component portion of caption
- Coefficient: {
None
} |str
value of option “Coefficient”
- Component: {
None
} |str
value of option “Component”
- DNStats: {
None
} |int
interval between candidate averaging window sizes
- DPI: {
150
} |int
dots per inch if saving as rasterized image
- Delta: {
0.0
} |float
specified interval(s) to plot above and below mean
- DeltaFormat: {
'%.4f'
} |str
printf-style flag for ShowDelta value
- DeltaPlotOptions: {
None
} |PlotCoeffIterDeltaPlotOpts
plot options for fixed-width above and below mu
- EpsilonFormat: {
'%.4f'
} |str
printf-style flag for ShowEpsilon value
- EpsilonPlotOptions: {
None
} |PlotCoeffIterEpsilonPlotOpts
value of option “EpsilonPlotOptions”
- FigureHeight: {
4.5
} |float
height of subfigure graphics in inches
- FigureWidth: {
6.0
} |float
width of subfigure graphics in inches
- Format:
'jpeg'
|'jpg'
| {'pdf'
} |'png'
|'svg'
image file format
- Grid: {
None
} |True
|False
whether to show axes grid in background
- GridPlotOptions: {
{}
} |dict
plot options for major grid, if shown
- KEpsilon: {
0.0
} |float
multiple of iterative error to plot
- KSigma: {
None
} |float
value of option “KSigma”
- MinorGrid: {
None
} |True
|False
whether to show axes minor grid
- MinorGridPlotOptions: {
{}
} |dict
plot options for minor grid, if shown
- MuFormat: {
'%.4f'
} |str
printf-style flag for ShowMu value
- MuPlotOptions: {
None
} |PlotCoeffIterMuPlotOpts
plot options for horizontal line showing mean
- NMaxStats: {
None
} |int
maximum averaging window size
- NMinStats: {
None
} |int
minimum iteration allowed to be in averaging window
- NPlotFirst: {
1
} |int
iteration at which to start figure
- NPlotIters: {
None
} |int
value of option “NPlotIters”
- NPlotLast: {
None
} |int
value of option “NPlotLast”
- NStats: {
None
} |int
nominal number of iterations in averaging window
- PlotOptions: {
None
} |PlotCoeffIterPlotOpts
options for main line(s) of plot
- Position: {
'b'
} |'c'
|'t'
subfigure vertical alignment
- Restriction: {
''
} |str
data restriction to place on figure
- RestrictionLoc:
'bottom'
|'bottom left'
|'bottom right'
|'left'
|'lower left'
|'lower right'
|'right'
| {'top'
} |'top left'
|'top right'
|'upper left'
|'upper right'
location for subfigure restriction text
- RestrictionOptions: {
{}
} |dict
additional opts to
text()
for restriction- RestrictionXPosition: {
None
} |float
explicit x-coord of restriction
- RestrictionYPosition: {
None
} |float
explicit y-coord of restriction
- ShowDelta: {
True
} |False
option to print value of Delta
- ShowEpsilon: {
False
} |True
option to print value of iterative sampling error
- ShowMu: {
True
} |False
option to print value of mean over window
- ShowSigma: {
True
} |False
option to print value of standard deviation
- SigmaFormat: {
'%.4f'
} |object
printf-style flag for ShowSigma value
- SigmaPlotOptions: {
None
} |PlotCoeffSigmaPlotOpts
value of option “SigmaPlotOptions”
- TickLabelOptions: {
None
} |dict
common options for ticks of both axes
- TickLabels: {
None
} |True
|False
common value(s) for ticks of both axes
- Ticks: {
None
} |True
|False
value of option “Ticks”
- Type: {
None
} |str
subfigure type or parent
- Width: {
0.33
} |float
value of option “Width”
- XLabel: {
None
} |str
manual label for x-axis
- XLabelOptions: {
None
} |dict
text options for x-axis label
- XLim: {
None
} |object
explicit min and max limits for x-axis
- XLimMax: {
None
} |object
outer limits for min and max x-axis limits
- XMax: {
None
} |float
explicit upper limit for x-axis limits
- XMin: {
None
} |float
explicit lower limit for x-axis limits
- XTickLabelOptions: {
None
} |dict
text options for x-axis tick labels
- XTickLabels: {
None
} |True
|False
|float
|str
option to turn off x-axis tick labels or set values
- XTicks: {
None
} |True
|False
|float
option to turn off x-axis ticks or set values
- YLabel: {
None
} |str
manual label for y-axis
- YLabelOptions: {
None
} |dict
text options for y-axis label
- YLim: {
None
} |object
explicit min and max limits for y-axis
- YLimMax: {
None
} |object
outer limits for min and max y-axis limits
- YMax: {
None
} |float
explicit upper limit for y-axis limits
- YMin: {
None
} |float
explicit lower limit for y-axis limits
- YTickLabelOptions: {
None
} |dict
text options for y-axis tick labels
- YTickLabels: {
None
} |True
|False
|float
|str
option to turn off x-axis tick labels or set values
- YTicks: {
None
} |True
|False
|float
option to turn off y-axis ticks or set values