ContourPlot
extends Plot
in package
This class represent a plotting of a contour outline of data given as a X-Y matrice
Table of Contents
Properties
- $color : mixed
- $coords : mixed
- $csimalts : mixed
- $csimareas : mixed
- $csimtargets : mixed
- $csimwintargets : mixed
- $hidelegend : mixed
- $legend : mixed
- $legendcsimalt : mixed
- $legendcsimtarget : mixed
- $legendcsimwintarget : mixed
- $line_weight : mixed
- $numpoints : mixed
- $value : mixed
- $center : mixed
- $inputValues : mixed
- $isRunningClear : mixed
- $weight : mixed
Methods
- __construct() : an
- Construct a contour plotting algorithm. The end result of the algorithm is a sequence of line segments for each isobar given as two vertices.
- Clear() : mixed
- DoLegend() : mixed
- GetCSIMareas() : mixed
- HideLegend() : mixed
- Invertlegend() : unknown_type
- Legend() : mixed
- Internal ramewrok method to setup the legend to be used for this plot.
- Max() : mixed
- Min() : mixed
- PreScaleSetup() : mixed
- Framework function which gets called before the Stroke() method is called
- PreStrokeAdjust() : mixed
- SetCenter() : mixed
- SetColor() : mixed
- SetCSIMTargets() : mixed
- SetInvert() : mixed
- Flipe the data around the center
- SetIsobarColors() : mixed
- Set the colors for the isobar lines
- SetLegend() : mixed
- SetLineWeight() : mixed
- SetWeight() : mixed
- ShowLegend() : mixed
- Show the legend
- Stroke() : mixed
- Internal method. Stroke the contour plot to the graph
- StrokeDataValue() : mixed
- StrokeMargin() : mixed
- UseHighContrastColor() : mixed
- Use high contrast color schema
Properties
$color
public
mixed
$color
= 'black'
$coords
public
mixed
$coords
= array()
$csimalts
public
mixed
$csimalts
= \null
$csimareas
public
mixed
$csimareas
= ''
$csimtargets
public
mixed
$csimtargets
= array()
$csimwintargets
public
mixed
$csimwintargets
= array()
$hidelegend
public
mixed
$hidelegend
= \false
$legend
public
mixed
$legend
= ''
$legendcsimalt
public
mixed
$legendcsimalt
= ''
$legendcsimtarget
public
mixed
$legendcsimtarget
= ''
$legendcsimwintarget
public
mixed
$legendcsimwintarget
= ''
$line_weight
public
mixed
$line_weight
= 1
$numpoints
public
mixed
$numpoints
= 0
$value
public
mixed
$value
$center
protected
mixed
$center
= \false
$inputValues
protected
mixed
$inputValues
$isRunningClear
protected
mixed
$isRunningClear
= \false
$weight
protected
mixed
$weight
= 1
Methods
__construct()
Construct a contour plotting algorithm. The end result of the algorithm is a sequence of line segments for each isobar given as two vertices.
public
__construct(mixed $aDataMatrix[, mixed $aIsobar = 10 ][, mixed $aFactor = 1 ][, mixed $aInvert = false ][, mixed $aIsobarColors = array() ]) : an
Parameters
- $aDataMatrix : mixed
-
The Z-data to be used
- $aIsobar : mixed = 10
-
A mixed variable, if it is an integer then this specified the number of isobars to use. The values of the isobars are automatically detrmined to be equ-spaced between the min/max value of the data. If it is an array then it explicetely gives the isobar values
- $aFactor : mixed = 1
- $aInvert : mixed = false
-
By default the matrice with row index 0 corresponds to Y-value 0, i.e. in the bottom of the plot. If this argument is true then the row with the highest index in the matrice corresponds to Y-value 0. In affect flipping the matrice around an imaginary horizontal axis.
- $aIsobarColors : mixed = array()
Return values
an —instance of the contour plot algorithm
Clear()
public
Clear() : mixed
DoLegend()
public
DoLegend(mixed $graph) : mixed
Parameters
- $graph : mixed
GetCSIMareas()
public
GetCSIMareas() : mixed
HideLegend()
public
HideLegend([mixed $f = true ]) : mixed
Parameters
- $f : mixed = true
Invertlegend()
public
Invertlegend([mixed $aFlg = true ]) : unknown_type
Parameters
- $aFlg : mixed = true
-
true if the legend should start with the lowest isobar on top
Return values
unknown_typeLegend()
Internal ramewrok method to setup the legend to be used for this plot.
public
Legend(mixed $aGraph) : mixed
Parameters
- $aGraph : mixed
-
The parent graph class
Max()
public
Max() : mixed
Min()
public
Min() : mixed
PreScaleSetup()
Framework function which gets called before the Stroke() method is called
public
PreScaleSetup(mixed $aGraph) : mixed
@see Plot#PreScaleSetup($aGraph)
Parameters
- $aGraph : mixed
PreStrokeAdjust()
public
PreStrokeAdjust(mixed $aGraph) : mixed
Parameters
- $aGraph : mixed
SetCenter()
public
SetCenter([mixed $aCenter = true ]) : mixed
Parameters
- $aCenter : mixed = true
SetColor()
public
SetColor(mixed $aColor) : mixed
Parameters
- $aColor : mixed
SetCSIMTargets()
public
SetCSIMTargets(mixed $aTargets[, mixed $aAlts = '' ][, mixed $aWinTargets = '' ]) : mixed
Parameters
- $aTargets : mixed
- $aAlts : mixed = ''
- $aWinTargets : mixed = ''
SetInvert()
Flipe the data around the center
public
SetInvert([mixed $aFlg = true ]) : mixed
Parameters
- $aFlg : mixed = true
SetIsobarColors()
Set the colors for the isobar lines
public
SetIsobarColors(mixed $aColorArray) : mixed
Parameters
- $aColorArray : mixed
SetLegend()
public
SetLegend(mixed $aLegend[, mixed $aCSIM = '' ][, mixed $aCSIMAlt = '' ][, mixed $aCSIMWinTarget = '' ]) : mixed
Parameters
- $aLegend : mixed
- $aCSIM : mixed = ''
- $aCSIMAlt : mixed = ''
- $aCSIMWinTarget : mixed = ''
SetLineWeight()
public
SetLineWeight([mixed $aWeight = 1 ]) : mixed
Parameters
- $aWeight : mixed = 1
SetWeight()
public
SetWeight(mixed $aWeight) : mixed
Parameters
- $aWeight : mixed
ShowLegend()
Show the legend
public
ShowLegend([mixed $aFlg = true ]) : mixed
Parameters
- $aFlg : mixed = true
-
true if the legend should be shown
Stroke()
Internal method. Stroke the contour plot to the graph
public
Stroke(mixed $img, mixed $xscale, mixed $yscale) : mixed
Parameters
- $img : mixed
-
Image handler
- $xscale : mixed
-
Instance of the xscale to use
- $yscale : mixed
-
Instance of the yscale to use
StrokeDataValue()
public
StrokeDataValue(mixed $img, mixed $aVal, mixed $x, mixed $y) : mixed
Parameters
- $img : mixed
- $aVal : mixed
- $x : mixed
- $y : mixed
StrokeMargin()
public
StrokeMargin(mixed $aImg) : mixed
Parameters
- $aImg : mixed
UseHighContrastColor()
Use high contrast color schema
public
UseHighContrastColor([mixed $aFlg = true ][, mixed $aBW = false ]) : mixed
Parameters
- $aFlg : mixed = true
-
True, to use high contrast color
- $aBW : mixed = false
-
True, Use only black and white color schema