Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALPulsar 7.1.1.1-8a6b96f
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
TwoDMeshPlotStruc Struct Reference

Detailed Description

This structure stores parameters specifying how to plot a PostScript diagram of the parameter mesh.

Definition at line 85 of file TwoDMeshPlot.h.

Data Fields

REAL4 theta
 Angle from the horizontal direction of the plot counterclockwise to the \( x \) -coordinate axis of the mesh, in degrees. More...
 
REAL4 xScale
 
REAL4 yScale
 Plotting scale of the mesh coordinate axes, in points per unit \( x \) or \( y \) (a point is 1/72 of an inch) More...
 
REAL4 bBox [4]
 Bounding box surrounding the figure in plot coordinates, measured in points. More...
 
BOOLEAN autoscale
 If true, xScale and yScale will be adjusted so that the drawn figure will lie within the bBox. More...
 
REAL4 clipBox [4]
 Four components \( x_\mathrm{min} \) , \( y_\mathrm{min} \) , \( x_\mathrm{max} \) , \( y_\mathrm{max} \) (in that order) specifying the corners of a box in the \( x \) - \( y \) coordinate system outside of which no marks will be made; if either max value is less than or equal to the corresponding min value, clipBox will be ignored. More...
 
UINT4 nLevels
 The number of levels of recursive submeshes to plot. More...
 
UINT4 nBoundary
 half the number of points to plot along the boundary of the parameter region; at least 4 points are required; if plotBoundary \( <2 \) , none will be plotted. More...
 
INT2plotPoints
 An array from [0] to [nLevels] indicating how to plot the mesh points at each recursive level: a value of 0 means don't plot mesh points, a positive value means to plot filled circles of that diameter (in points), a negative value means to plot empty circles of that diameter (in points) More...
 
BOOLEANplotTiles
 An array from [0] to [nLevels] indicating whether to plot the tiles around each mesh point, at each recursive level. More...
 
BOOLEANplotEllipses
 An array from [0] to [nLevels] indicating whether to plot the mismatch ellipses around each mesh point, at each recursive level. More...
 
TwoDMeshParamStrucparams
 An array from [0] to [nLevels] of parameter structures used to generate the meshes at each recursive level (making the assumption that all submeshes of the same level used the same parameters); in general only the getMetric() and mThresh fields are used from parameter structures after the first. More...
 
BOOLEAN clip
 [private] whether to use clipBox, above More...
 
REAL4 cosTheta
 
REAL4 sinTheta
 [private] cosine and sine of theta, above More...
 

Field Documentation

◆ theta

REAL4 TwoDMeshPlotStruc::theta

Angle from the horizontal direction of the plot counterclockwise to the \( x \) -coordinate axis of the mesh, in degrees.

Definition at line 86 of file TwoDMeshPlot.h.

◆ xScale

REAL4 TwoDMeshPlotStruc::xScale

Definition at line 87 of file TwoDMeshPlot.h.

◆ yScale

REAL4 TwoDMeshPlotStruc::yScale

Plotting scale of the mesh coordinate axes, in points per unit \( x \) or \( y \) (a point is 1/72 of an inch)

Definition at line 87 of file TwoDMeshPlot.h.

◆ bBox

REAL4 TwoDMeshPlotStruc::bBox[4]

Bounding box surrounding the figure in plot coordinates, measured in points.

Definition at line 88 of file TwoDMeshPlot.h.

◆ autoscale

BOOLEAN TwoDMeshPlotStruc::autoscale

If true, xScale and yScale will be adjusted so that the drawn figure will lie within the bBox.

If false, bBox will be adjusted to enclose the figure, given xScale and yScale.

Definition at line 89 of file TwoDMeshPlot.h.

◆ clipBox

REAL4 TwoDMeshPlotStruc::clipBox[4]

Four components \( x_\mathrm{min} \) , \( y_\mathrm{min} \) , \( x_\mathrm{max} \) , \( y_\mathrm{max} \) (in that order) specifying the corners of a box in the \( x \) - \( y \) coordinate system outside of which no marks will be made; if either max value is less than or equal to the corresponding min value, clipBox will be ignored.

Definition at line 92 of file TwoDMeshPlot.h.

◆ nLevels

UINT4 TwoDMeshPlotStruc::nLevels

The number of levels of recursive submeshes to plot.

If zero, the mesh will not be plotted (although the boundary may be)

Definition at line 96 of file TwoDMeshPlot.h.

◆ nBoundary

UINT4 TwoDMeshPlotStruc::nBoundary

half the number of points to plot along the boundary of the parameter region; at least 4 points are required; if plotBoundary \( <2 \) , none will be plotted.

Definition at line 97 of file TwoDMeshPlot.h.

◆ plotPoints

INT2* TwoDMeshPlotStruc::plotPoints

An array from [0] to [nLevels] indicating how to plot the mesh points at each recursive level: a value of 0 means don't plot mesh points, a positive value means to plot filled circles of that diameter (in points), a negative value means to plot empty circles of that diameter (in points)

Definition at line 100 of file TwoDMeshPlot.h.

◆ plotTiles

BOOLEAN* TwoDMeshPlotStruc::plotTiles

An array from [0] to [nLevels] indicating whether to plot the tiles around each mesh point, at each recursive level.

Definition at line 104 of file TwoDMeshPlot.h.

◆ plotEllipses

BOOLEAN* TwoDMeshPlotStruc::plotEllipses

An array from [0] to [nLevels] indicating whether to plot the mismatch ellipses around each mesh point, at each recursive level.

Definition at line 107 of file TwoDMeshPlot.h.

◆ params

TwoDMeshParamStruc* TwoDMeshPlotStruc::params

An array from [0] to [nLevels] of parameter structures used to generate the meshes at each recursive level (making the assumption that all submeshes of the same level used the same parameters); in general only the getMetric() and mThresh fields are used from parameter structures after the first.

Definition at line 110 of file TwoDMeshPlot.h.

◆ clip

BOOLEAN TwoDMeshPlotStruc::clip

[private] whether to use clipBox, above

Definition at line 115 of file TwoDMeshPlot.h.

◆ cosTheta

REAL4 TwoDMeshPlotStruc::cosTheta

Definition at line 116 of file TwoDMeshPlot.h.

◆ sinTheta

REAL4 TwoDMeshPlotStruc::sinTheta

[private] cosine and sine of theta, above

Definition at line 116 of file TwoDMeshPlot.h.