Back to FabImage Library website
You are here: Start » Function Reference » Image » Image Features » ImageProfileAlongPath
ImageProfileAlongPath
Header: | FIL.h |
---|---|
Namespace: | fil |
Module: | FoundationPro |
Creates a series of segments across the input path, measures the average pixel intensity on each of the segments, and creates the final profile from those values.
Applications: This is the first step of all 1D Edge Detection operations. Here available for direct use by the user.
Syntax
C++
C#
void fil::ImageProfileAlongPath ( ScanMapState& ioState, const fil::Image& inImage, const fil::Path& inScanPath, ftl::Optional<const fil::CoordinateSystem2D&> inScanPathAlignment, int inScanWidth, const fil::SamplingParams& inSamplingParams, float inSmoothingStdDev, fil::AccumulationMode::Type inAccumulationMode, ftl::Optional<fil::Pixel> inBorderColor, fil::Profile& outProfile, fil::Path& outPath, ftl::Optional<fil::Path&> outAlignedScanPath = ftl::NIL, ftl::Array<fil::Path>& diagSamplingPoints, float& diagSamplingStep )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
ioState | ScanMapState& | Object used to maintain state of the function. | |||
inImage | const Image& | Input image | |||
inScanPath | const Path& | Path along which the profile is extracted | |||
inScanPathAlignment | Optional<const CoordinateSystem2D&> | NIL | Adjusts the scan path to the position of the inspected object | ||
inScanWidth | int | 1 - | 5 | Width of the scan field in pixels | |
inSamplingParams | const SamplingParams& | Parameters controlling the sampling process | |||
inSmoothingStdDev | float | 0.0 - | 0.6f | Standard deviation of the gaussian smoothing applied to the extracted profile | |
inAccumulationMode | AccumulationMode::Type | Determines how the pixel values are combined | |||
inBorderColor | Optional<Pixel> | Pixel ( X: 0.0f Y: 0.0f Z: 0.0f W: 0.0f ) | Color of pixel outside image | ||
outProfile | Profile& | The resulting profile of the pixel brightness | |||
outPath | Path& | The path consisting of the points from which the resulting profile is extracted | |||
outAlignedScanPath | Optional<Path&> | NIL | Input scan path after transformation (in the image coordinates) | ||
diagSamplingPoints | Array<Path>& | Array of paths each one containing the sampling points that contributed to a single value of the extracted profile | |||
diagSamplingStep | float& | Used distance between consecutive sampling points on the scan path |
Optional Outputs
The computation of following outputs can be switched off by passing value ftl::NIL
to these parameters: outAlignedScanPath.
Read more about Optional Outputs.