gen_image_surface_first_ordergen_image_surface_first_orderGenImageSurfaceFirstOrderGenImageSurfaceFirstOrdergen_image_surface_first_order (Operator)
Name
gen_image_surface_first_ordergen_image_surface_first_orderGenImageSurfaceFirstOrderGenImageSurfaceFirstOrdergen_image_surface_first_order — Create a tilted gray surface with first order polynomial.
Signature
Herror gen_image_surface_first_order(Hobject* ImageSurface, const char* Type, double Alpha, double Beta, double Gamma, double Row, double Column, const Hlong Width, const Hlong Height)
Herror T_gen_image_surface_first_order(Hobject* ImageSurface, const Htuple Type, const Htuple Alpha, const Htuple Beta, const Htuple Gamma, const Htuple Row, const Htuple Column, const Htuple Width, const Htuple Height)
void GenImageSurfaceFirstOrder(HObject* ImageSurface, const HTuple& Type, const HTuple& Alpha, const HTuple& Beta, const HTuple& Gamma, const HTuple& Row, const HTuple& Column, const HTuple& Width, const HTuple& Height)
void HImage::GenImageSurfaceFirstOrder(const HString& Type, double Alpha, double Beta, double Gamma, double Row, double Column, Hlong Width, Hlong Height)
void HImage::GenImageSurfaceFirstOrder(const char* Type, double Alpha, double Beta, double Gamma, double Row, double Column, Hlong Width, Hlong Height)
void HImage::GenImageSurfaceFirstOrder(const wchar_t* Type, double Alpha, double Beta, double Gamma, double Row, double Column, Hlong Width, Hlong Height)
(Windows only)
static void HOperatorSet.GenImageSurfaceFirstOrder(out HObject imageSurface, HTuple type, HTuple alpha, HTuple beta, HTuple gamma, HTuple row, HTuple column, HTuple width, HTuple height)
void HImage.GenImageSurfaceFirstOrder(string type, double alpha, double beta, double gamma, double row, double column, int width, int height)
Description
The operator gen_image_surface_first_ordergen_image_surface_first_orderGenImageSurfaceFirstOrderGenImageSurfaceFirstOrderGenImageSurfaceFirstOrdergen_image_surface_first_order creates a tilted
gray value surface according to the following equation:
ImageSurfaceImageSurfaceImageSurfaceImageSurfaceimageSurfaceimage_surface(r,c) = AlphaAlphaAlphaAlphaalphaalpha(r - RowRowRowRowrowrow) +
BetaBetaBetaBetabetabeta(c - ColumnColumnColumnColumncolumncolumn) +
GammaGammaGammaGammagammagamma
The size of the image is determined by WidthWidthWidthWidthwidthwidth and HeightHeightHeightHeightheightheight.
The parameters RowRowRowRowrowrow and ColumnColumnColumnColumncolumncolumn define the reference point
of the created gray surface.
The gray values are of the type TypeTypeTypeTypetypetype (see gen_image_constgen_image_constGenImageConstGenImageConstGenImageConstgen_image_const
for a detailed description of the pixel types).
Gray values outside the valid area are clipped.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
ImageSurfaceImageSurfaceImageSurfaceImageSurfaceimageSurfaceimage_surface (output_object) image → objectHImageHObjectHImageHobject * (byte / uint2 / real)
Created image with new image matrix.
TypeTypeTypeTypetypetype (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Pixel type.
Default value:
'byte'
"byte"
"byte"
"byte"
"byte"
"byte"
List of values: 'byte'"byte""byte""byte""byte""byte", 'real'"real""real""real""real""real", 'uint2'"uint2""uint2""uint2""uint2""uint2"
AlphaAlphaAlphaAlphaalphaalpha (input_control) number → HTuplefloatHTupleHtuple (real) (double) (double) (double)
First order coefficient in vertical direction.
Default value: 1.0
Suggested values: -2.0, -1.0, -0.5, -0.0, 0.5, 1.0, 2.0
Minimum increment: 0.000001
Recommended increment: -0.005
BetaBetaBetaBetabetabeta (input_control) number → HTuplefloatHTupleHtuple (real) (double) (double) (double)
First order coefficient in horizontal direction.
Default value: 1.0
Suggested values: -2.0, -1.0, -0.5, -0.0, 0.5, 1.0, 2.0
Minimum increment: 0.000001
Recommended increment: -0.005
GammaGammaGammaGammagammagamma (input_control) number → HTuplefloatHTupleHtuple (real) (double) (double) (double)
Zero order coefficient.
Default value: 1.0
Suggested values: -2.0, -1.0, -0.5, -0.0, 0.5, 1.0, 2.0
Minimum increment: 0.000001
Recommended increment: -0.005
RowRowRowRowrowrow (input_control) number → HTuplefloatHTupleHtuple (real) (double) (double) (double)
Row coordinate of the reference point of the surface.
Default value: 256.0
Suggested values: 0.0, 128.0, 256.0, 512.0
Minimum increment: 0.000001
Recommended increment: -0.005
ColumnColumnColumnColumncolumncolumn (input_control) number → HTuplefloatHTupleHtuple (real) (double) (double) (double)
Column coordinate of the reference point of the surface.
Default value: 256.0
Suggested values: 0.0, 128.0, 256.0, 512.0
Minimum increment: 0.000001
Recommended increment: -0.005
WidthWidthWidthWidthwidthwidth (input_control) extent.x → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Width of image.
Default value: 512
Suggested values: 128, 256, 512, 1024
Typical range of values: 1
≤
Width
Width
Width
Width
width
width
≤
512 (lin)
Minimum increment: 1
Recommended increment: 10
Restriction: Width >= 1
HeightHeightHeightHeightheightheight (input_control) extent.y → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Height of image.
Default value: 512
Suggested values: 128, 256, 512, 1024
Typical range of values: 1
≤
Height
Height
Height
Height
height
height
≤
512 (lin)
Minimum increment: 1
Recommended increment: 10
Restriction: Height >= 1
Result
If the parameter values are correct gen_image_surface_first_ordergen_image_surface_first_orderGenImageSurfaceFirstOrderGenImageSurfaceFirstOrderGenImageSurfaceFirstOrdergen_image_surface_first_order
returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.
Possible Predecessors
fit_surface_first_orderfit_surface_first_orderFitSurfaceFirstOrderFitSurfaceFirstOrderFitSurfaceFirstOrderfit_surface_first_order
Possible Successors
sub_imagesub_imageSubImageSubImageSubImagesub_image
See also
gen_image_gray_rampgen_image_gray_rampGenImageGrayRampGenImageGrayRampGenImageGrayRampgen_image_gray_ramp,
gen_image_surface_second_ordergen_image_surface_second_orderGenImageSurfaceSecondOrderGenImageSurfaceSecondOrderGenImageSurfaceSecondOrdergen_image_surface_second_order,
gen_image_constgen_image_constGenImageConstGenImageConstGenImageConstgen_image_const
Module
Foundation