Back to FabImage Library website

You are here: Start » Function Reference » Histogram » Histogram Spatial Transforms » CropHistogram

CropHistogram


Header: FIL.h
Namespace: fil
Module: FoundationBasic

Confines a histogram to its continuous segment.

Syntax

C++
C#
 
void fil::CropHistogram
(
	const fil::Histogram& inHistogram,
	const int inStart,
	const int inBinCount,
	fil::Histogram& outHistogram
)

Parameters

Name Type Range Default Description
Input value
 inHistogram const Histogram& Input histogram
Input value
 inStart const int 0 - Index of the first element of the input histogram that will be included in the output histogram
Input value
 inBinCount const int 0 - Number of bins in the output histogram
Output value
 outHistogram Histogram& Output histogram

Description

Operation crops histogram to bins which are enclosed in inBinCount bins beginning from inStart bin.

Examples

CropHistogram performed on the sample histogram with inStart = 15, inBinCount = 65.

Errors

List of possible exceptions:

Error type Description
DomainError Selected index range exceeds the input histogram in CropHistogram.

See Also