This structure stores the parameters required by the two-dimensional mesh placement functions.
Definition at line 142 of file TwoDMesh.h.
Data Fields | |
REAL4 | domain [2] |
The domain \( [x_\mathrm{min},x_\mathrm{max}] \) spanned by the desired parameter region. More... | |
void(* | getRange )(LALStatus *, REAL4[2], REAL4, void *) |
A function that returns in its second argument the range \( [y_1(x),y_2(x)] \) spanned by the parameter region for a specified \( x \) , which is passed in as the third argument; the fourth argument can be used to pass function-specific parameters. More... | |
void * | rangeParams |
The parameters to be passed as the fourth argument of *getRange() , above. More... | |
void(* | getMetric )(LALStatus *, REAL4[3], REAL4[2], void *) |
A function that returns in its second argument the components \( g_{xx} \) , \( g_{yy} \) , and \( g_{xy} \) (in that order) of the metric evaluated at a point \( (x,y) \) , which is passed in as the third argument; the fourth argument can be used to pass function-specific parameters. More... | |
void * | metricParams |
The parameters to be passed as the fourth argument of *getMetric() , above. More... | |
REAL4 | mThresh |
The maximum mismatch \( m_\mathrm{thresh} \) desired between any point in the region and the nearest mesh point; note that the maximum mismatch is equal to 1 minus the minimum match. More... | |
REAL4 | widthMaxFac |
The minimum ratio of mismatch ellipse width (projected onto the horizontal axis) to column width that must be maintained throughout the column: if an ellipse falls below this ratio due to shrinkage or rotation, as in this figure (b), the code will try a narrower column; if set to \( \leq1 \) , the default value TWODMESHINTERNALC_WMAXFAC= \( \sqrt[4]{2} \) will be used. More... | |
REAL4 | widthRetryFac |
If the column is determined to be too wide (e.g. due to the value of widthMaxFac , above), the column width will be reduced by the factor widthRetryFac ; if set to \( \leq1 \) , the default value TWODMESHINTERNALC_WRETRYFAC= \( \sqrt{2} \) will be used. More... | |
UINT4 | maxColumns |
The maximum number of columns the mesh placement routine will try before giving up. More... | |
UINT4 | nIn |
The maximum number of mesh points allowed, after which the placement routine will quit. More... | |
UINT4 | nOut |
The number of mesh points added by the placement routine; if an error occurs, this will store the number of mesh points completed before the error. More... | |
REAL4 TwoDMeshParamStruc::domain[2] |
The domain \( [x_\mathrm{min},x_\mathrm{max}] \) spanned by the desired parameter region.
Definition at line 143 of file TwoDMesh.h.
A function that returns in its second argument the range \( [y_1(x),y_2(x)] \) spanned by the parameter region for a specified \( x \) , which is passed in as the third argument; the fourth argument can be used to pass function-specific parameters.
Definition at line 144 of file TwoDMesh.h.
void* TwoDMeshParamStruc::rangeParams |
The parameters to be passed as the fourth argument of *getRange()
, above.
Definition at line 149 of file TwoDMesh.h.
A function that returns in its second argument the components \( g_{xx} \) , \( g_{yy} \) , and \( g_{xy} \) (in that order) of the metric evaluated at a point \( (x,y) \) , which is passed in as the third argument; the fourth argument can be used to pass function-specific parameters.
Definition at line 150 of file TwoDMesh.h.
void* TwoDMeshParamStruc::metricParams |
The parameters to be passed as the fourth argument of *getMetric()
, above.
Definition at line 155 of file TwoDMesh.h.
REAL4 TwoDMeshParamStruc::mThresh |
The maximum mismatch \( m_\mathrm{thresh} \) desired between any point in the region and the nearest mesh point; note that the maximum mismatch is equal to 1 minus the minimum match.
Definition at line 156 of file TwoDMesh.h.
REAL4 TwoDMeshParamStruc::widthMaxFac |
The minimum ratio of mismatch ellipse width (projected onto the horizontal axis) to column width that must be maintained throughout the column: if an ellipse falls below this ratio due to shrinkage or rotation, as in this figure (b), the code will try a narrower column; if set to \( \leq1 \) , the default value TWODMESHINTERNALC_WMAXFAC=
\( \sqrt[4]{2} \) will be used.
Definition at line 159 of file TwoDMesh.h.
REAL4 TwoDMeshParamStruc::widthRetryFac |
If the column is determined to be too wide (e.g. due to the value of widthMaxFac
, above), the column width will be reduced by the factor widthRetryFac
; if set to \( \leq1 \) , the default value TWODMESHINTERNALC_WRETRYFAC=
\( \sqrt{2} \) will be used.
Definition at line 165 of file TwoDMesh.h.
UINT4 TwoDMeshParamStruc::maxColumns |
The maximum number of columns the mesh placement routine will try before giving up.
If zero, this number is ignored.
Definition at line 169 of file TwoDMesh.h.
UINT4 TwoDMeshParamStruc::nIn |
The maximum number of mesh points allowed, after which the placement routine will quit.
If zero, this number is ignored.
Definition at line 170 of file TwoDMesh.h.
UINT4 TwoDMeshParamStruc::nOut |
The number of mesh points added by the placement routine; if an error occurs, this will store the number of mesh points completed before the error.
Definition at line 171 of file TwoDMesh.h.