hist_clip_buffer

Cascade Historian: Version 4.1
Prev |  | Next

# `hist_clip_buffer`

`hist_clip_buffer` -- clips `Y` values to fit within a range.

## Syntax

    hist_clip_buffer (buffer, min, max)

## Parameters

`buffer`

  A binary buffer of `X`-`Y` pairs of doubles, as created by a call to `hist_buffer_id_read`.

`min`

  The minimum of the clipping range (`Y` values less than this value will be set to this value).

`max`

  The maximum of the clipping range (`Y` values greater than this value will be set to this value)

## Returns

`t` (true) if the function completed successfully, otherwise `nil`.

## Description

This function clips the `Y`-value data in a buffer to lie within the range specified. The `X`-value data is ignored. The buffer is modified in place (i.e., a new buffer is not created, and the old values cannot be recovered). This function is useful during graphing to ensure the data trace does not go outside the desired graph boundaries.

This function corresponds to the Cogent API function `HI_ClipBuffer`.

## Example

        hist_clip_buffer (buf, target + range, target - range);

Prev | Home | Next
`hist_bufsize` | Up | `hist_count`

Copyright 1995-2002 by Cogent Real-Time Systems, Inc.