Marblecore Imaging Library Documentation

Documentation Introduction
Documentation / Marblecore Imaging / Methods / SaveHistogramToImage

SaveHistogramToImage method

Retrieves the histogram graph of the image and replaces the image with the histogram image.

Syntax

Boolean SaveHistogramToImage(nWidth As Number, nHeight As Number, nBackgroundColor As Number, nGraphColor As Number, nBackgroundOpacity As Number, nGraphOpacity As Number, nChannel As Channel)

Return value

Returns true if the function succeeded.

Parameters

ParameterTypeRequiredDescription
nWidthNumberNoOptional parameter which specifies the width of the histogram.
nHeightNumberNoOptional parameter which specifies the height of the histogram.
nBackgroundColorNumberNoOptional parameter which specifies the graph background color.
nGraphColorNumberNoOptional parameter which specifies the graph bar color.
nBackgroundOpacityNumberNoOptional parameter which specifies the opacity of the graph background.
nGraphOpacityNumberNoOptional parameter which specifies the opacity of the graph bar.
nChannelChannel (Enumeration)NoOptional parameter which specifies the color channel.

Example

The example below shows the effect of this method and how to use it. You can slide the marker in the before/after picture to see the difference. If you take a look at the example code, assume there is a reference to the Marblecore Imaging object with the name 'MarblecoreImaging'. Transparent parts of the image are displayed using a checkerboard pattern.
 
before
after
 
1 // Load the specified image in memory
2 MarblecoreImaging.LoadFromFile("example-savehistogramtoimage-before.jpg");
3 
4 // Execute the operation
5 MarblecoreImaging.SaveHistogramToImage();
6 
7 // Save the modified image to the specified file
8 MarblecoreImaging.SaveToFile("example-savehistogramtoimage-after.jpg");

Category

Histogram

See also

GetHistogramAverage | GetHistogramCount | GetHistogramMean | GetHistogramPercentile | GetHistogramPixels | InsertHistogram | LoadHistogramFromBase64 | LoadHistogramFromFile | LoadHistogramFromSerializedStream | LoadHistogramFromStream | LoadHistogramFromURL | SaveHistogramToFile | SaveHistogramToSerializedStream | SaveHistogramToStream