Back to Aurora Vision Library website
You are here: Start » Function Reference » Image » Image Basics » CreateImageFromSurface
CreateImageFromSurface
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | Vision3DStandard |
Creates a depth image from the Z-values of the input surface.
Applications: Allows for performing 2D operations on 3D data.
Syntax
C++
C#
void avl::CreateImageFromSurface ( const avl::Surface& inSurface, avl::PlainType::Type inPixelType, avl::ResampleSurfaceMode::Type inResampleSurfaceMode, atl::Optional<double> inXOffset, atl::Optional<double> inYOffset, atl::Optional<double> inPixelOffset, atl::Optional<double> inPixelScale, atl::Optional<float> inMissingPointValue, avl::Image& outImage, atl::Optional<avl::SurfaceFormat&> outSurfaceFormat = atl::NIL )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inSurface | const Surface& | Input surface | |||
inPixelType | PlainType::Type | Real | Output image pixel type | ||
inResampleSurfaceMode | ResampleSurfaceMode::Type | ||||
inXOffset | Optional<double> | NIL | Offset for the X axis of the output image; if set to Nil, surface X offset is chosen | ||
inYOffset | Optional<double> | NIL | Offset for the Y axis of the output image; if set to Nil, surface Y offset is chosen | ||
inPixelOffset | Optional<double> | NIL | Offset that the input surface values have in the output image; if set to Nil, surface Z offset is chosen | ||
inPixelScale | Optional<double> | 0.0 - | 1.0D | Scale that the input surface values have in the output image; if set to Nil, surface Z scale is chosen | |
inMissingPointValue | Optional<float> | 0.0f | Value assigned to pixels where point is undefined | ||
outImage | Image& | Input surface depth image | |||
outSurfaceFormat | Optional<SurfaceFormat&> | NIL | Format of the surface that the output image represents |
Optional Outputs
The computation of following outputs can be switched off by passing value atl::NIL
to these parameters: outSurfaceFormat.
Read more about Optional Outputs.