PK_EDGE_find_deviation_o_t

struct PK_EDGE_find_deviation_o_s
    {
    int             o_t_version;            --- Version number of option
                                            --- structure

    int             max_samples;            --- How many distances to find(0)

    PK_LOGICAL_t    bound_at_split_vertex;  --- Whether vertices of split ring
                                            --- edges are used to bound overlap
                                            --- regions (PK_LOGICAL_false)

    PK_LOGICAL_t    have_upper_bound;       --- An upper bound is provided
                                            --- (PK_LOGICAL_false)

    double          upper_bound;            --- Upper bound for deviation(0.0)

    };

typedef struct PK_EDGE_find_deviation_o_s PK_EDGE_find_deviation_o_t;


This options structure holds optional controls for PK_EDGE_find_deviation_2.

Used in:

PK_EDGE_find_deviation_2

It has the following fields:

'max_samples'
            Controls the maximum number of samples returned by
            PK_EDGE_deviation_2. The value of 'max_samples' produces three
            different sampling behaviours detailed below:

            ----------------------------------------------------------------
            |  Value      |                                                |
            |    of       |                    Behaviour                   |
            |'max_samples'|                                                |
            ----------------------------------------------------------------
            |     0       | PK_EDGE_find_deviation_2 determines            |
            |             | the appropriate set of points in each region   |
            |             | ( both in number and position. ) Distances are |
            |             | measured and returned at all these points.     |
            ----------------------------------------------------------------
            |     1       | PK_EDGE_find_deviation_2 chooses the same set  |
            |             | of points as for the case 'max_samples' == 0.  |
            |             | However in this case only the pair of points   |
            |             | producing the greatest distance is returned.   |
            ----------------------------------------------------------------
            |   N > 1     | For point-like regions a single sample is      |
            |             | returned. For Extended overlap regions N       |
            |             | samples are returned.                          |
            ----------------------------------------------------------------

'bound_at_split_vertex'
            When the vertex of a split ring edge lies within an overlap
            region, the region may span the vertex, for instance if the
            vertex does not lie at the parameter seam of the periodic edge
            curve.  If this option is set to PK_LOGICAL_true, then such an
            overlap region is adjusted so that the vertex lies at the
            boundary of the region, and may result in the region being split
            into two.  This gives results more similar to those of an open
            edge, where the vertices always bound the overlap regions.

'have_upper_bound'
            An 'upper_bound' has been provided.

'upper_bound'
            If an 'upper_bound' is provided, PK_EDGE_deviation_2 will not
            return any overlap region which has sample distances
            greater than the 'upper_bound'. This may result in no
            overlaps being found.