DATAMANIP (kdatamanip) functions
LIBRARY ROUTINE
lkhisto - compute histograms for data objects
LIBRARY CALL
int lkhisto(
kobject in_obj,
kobject gate_obj,
int w, int h, int d, int t, int e,
double min,
double binwidth,
int bins,
int oob,
int map,
int normalize,
kobject out_obj,
kobject integ_obj)
INPUT
- in_obj - object to be histogrammed
- gate_obj - optional gate object (ROI)
w,h,d,t,
- e - flags that, if set, indicate
that the processing unit for independent
histograms should include the given axis
- min - minimum side of most negative bin
- binwidth - width of each bin
- bins - number of bins
- oob - out-of-bounds flag; append two extra bins
to the histogram to count those values that
fall out of the histogram bounds
- map - if the input object has a map, then pull the data through the map (1) or leave the data unmapped (0)
- normalize - normalize the integrated histogram to [0..1] (1) or just leave it as computed (0)
OUTPUT
- out_obj - contains histograms for the
processing units in the data
kobject
- integ_obj - contains integrated histograms (NULL if integrated histograms are not desired)
RETURN VALUE
TRUE (1) on success, FALSE (0) otherwise
DESCRIPTION
lkhisto computes histogram information for data objects.
The unit of data to be used to compute each histogram can be
selected to lie along any combination of the axes 5D data
model.
For example, it is possible to compute a histogram for each
HxD plane in a data set comprised of a sequence of multiband
volumes.
If the input data object has a map, the input value data
is optionally pulled through the input map before computing the
histogram.
Output histograms are stored as columns in the output object,
one column per unit of data.
The histogram data type is UNSIGNED LONG.
If a gating object is supplied, then only input data that has
a corresponding non-zero value in the gating object is
histogrammed.
The out-of-bounds flags can be used to catch any counts that
lie outside of the histogram array.
ADDITIONAL INFORMATION
none
EXAMPLES
none
SIDE EFFECTS
none
RESTRICTIONS
none
MODIFICATION
none
FILES
$DATAMANIP/objects/library/kdatamanip/src/lkhisto.c
SEE ALSO
kdatamanip(3)
COPYRIGHT
Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.