Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

User Guide

AIDA Users Guide 

Style Parameters

source: freehep-jaida/src/main/java/hep/aida/ref/plotter/PlotterRegion.java

ParameterDescriptionParameter LocationAffectsValues
xAxisLowerLimit
 

PlotterStylex axis
 

lowerLimitaxis lower limitPlotterStyle.xAxisStyle or yAxisStyleaxis
 

xAxisUpperLimit
 

PlotterStylex axis
 

upperLimitaxis upper limitPlotterStyle.xAxisStyle or yAxisStyleaxis
 

yAxisLowerLimit
 

PlotterStyley axis
 

yAxisUpperLimit
 

PlotterStyley axis
 

xAxisLabel
 

PlotterStylex axis
 

yAxisLabel
 

PlotterStyley axis
 

errorBarDecoration
 

PlotterStyle.errorBarStyle()error barsfloat
allowZeroSuppression
 

PlotterStyle.xAxisStyle() or Plotter.yAxisStyle()x axisboolean
showAsScatterPlot
 

PlotterStyleHistogram2D
 

showZeroHeightBins
 

PlotterStyle.dataStyle().fillStyle()Histogram2D
 

hist2DStyle
 

PlotterStyleHistogram2D

box

ellipse

colorMap

colorMapScheme
 

PlotterStyle.dataStyle().fillStyle()Histogram2D (when displayed as color map)

warm or 0

cool or 1

thermal or 2

rainbow or 3

grayscale or 4

userdefined or 5

lineType
 

lineStyle()
 

solid or 0

dotted or 1

dashed or 2

dotdash or 3

markerShape
 

markerStyle()
 

dot or 0

box or 1

triangle or 2

star or 4

verticalLine or 5

horizontalLine or 6

cross or 7

cricle or 8

square or 9

 


markerShape (scatter)
 

markerStyle()
 

box or 1

triangle or 2

star or 4

verticalLine or 5

horizontalLine or 6

cross or 7

square or 9

globalIndexstyle global indexPlotterStyle
  


customOverlay
    




timeZonetime zone for date plotsPlotterStyle.dataStyle()
 

valid time zone string
profileErrorsdisplay error on the mean or spread
 

IProfile

errorOnMean or 1

spread or 0

normalization
 

PlotterStyle.dataStyle()
 

none

entries

maxbin

area

dataAreaBorderType
 

PlotterStyle.dataBoxStyle().borderStyle().borderType()
 

bevelIn or 0

bevelOut or 1

etched or 2

line or 3

shadow or 4

labelVerticalmake X axis label vertical instead of horizontalPlotterStyle.xAxisStyle() or Plotter.yAxisStyle()
 

boolean
loglog scaling (apparently parameter only has to start with "log")PlotterStyle.xAxisStyle() or Plotter.yAxisStyle()
  


yAxisputs yAxis on right (default is left)
  


Y1

 


Plot and Fitting Options

options format:

...

someBooleanOption <= means set option to true 


ParameterDescriptionAffectsValues
autoconvertwhether to autoconvert from cloud to histogramCloudboolean
rangerange for function fitfitting

examples

(,-9)

(-1.,0.)

(2.,3.)

(5,)

noClonewhether function is cloned ???)fittingboolean
annotationsee hep.aida.ref.histogram.AbstractBaseHistogramBaseHistogram
 

margin???Cloud
 

typebasic type of histogramHistogram1D

default

efficiency

useOutflowsInStatistics???

Histogram1D

Histogram2D

Histogram3D

boolean
OverlayIndex
  


int
modeoverlay mode
 

replace

overlay

add

stack

length
 

TupleColumnint
maxlength
 

TupleColumnint
calculatestatistics
 

TupleColumnint
compress
 

file writing

zip

yes

true

binary
 

file writingboolean
skip???file writingboolean

Notes

"By default the histogram's fill color, the contour of the histogram bar and the line between the points are taken from the line color. If the fill color is set and the histogram's bars are filled, the different color is used. Same for the line between the points."