get_grayval_interpolatedget_grayval_interpolatedGetGrayvalInterpolatedGetGrayvalInterpolatedget_grayval_interpolated (Operator)

Name

get_grayval_interpolatedget_grayval_interpolatedGetGrayvalInterpolatedGetGrayvalInterpolatedget_grayval_interpolated — Return gray values of an image at the positions given by tuples of rows and columns.

Signature

get_grayval_interpolated(Image : : Row, Column, Interpolation : Grayval)

Herror get_grayval_interpolated(const Hobject Image, double Row, double Column, const char* Interpolation, double* Grayval)

Herror T_get_grayval_interpolated(const Hobject Image, const Htuple Row, const Htuple Column, const Htuple Interpolation, Htuple* Grayval)

void GetGrayvalInterpolated(const HObject& Image, const HTuple& Row, const HTuple& Column, const HTuple& Interpolation, HTuple* Grayval)

HTuple HImage::GetGrayvalInterpolated(const HTuple& Row, const HTuple& Column, const HString& Interpolation) const

double HImage::GetGrayvalInterpolated(double Row, double Column, const HString& Interpolation) const

double HImage::GetGrayvalInterpolated(double Row, double Column, const char* Interpolation) const

double HImage::GetGrayvalInterpolated(double Row, double Column, const wchar_t* Interpolation) const   (Windows only)

static void HOperatorSet.GetGrayvalInterpolated(HObject image, HTuple row, HTuple column, HTuple interpolation, out HTuple grayval)

HTuple HImage.GetGrayvalInterpolated(HTuple row, HTuple column, string interpolation)

double HImage.GetGrayvalInterpolated(double row, double column, string interpolation)

def get_grayval_interpolated(image: HObject, row: MaybeSequence[Union[float, int]], column: MaybeSequence[Union[float, int]], interpolation: str) -> Sequence[float]

def get_grayval_interpolated_s(image: HObject, row: MaybeSequence[Union[float, int]], column: MaybeSequence[Union[float, int]], interpolation: str) -> float

Description

The operator get_grayval_interpolatedget_grayval_interpolatedGetGrayvalInterpolatedGetGrayvalInterpolatedGetGrayvalInterpolatedget_grayval_interpolated returns interpolated gray values at several subpixel positions of an ImageImageImageImageimageimage. The coordinates of the row positions are given in the tuple RowRowRowRowrowrow, the coordinates of column positions are given in the tuple ColumnColumnColumnColumncolumncolumn. The gray values are returned in GrayvalGrayvalGrayvalGrayvalgrayvalgrayval as a tuple of floating point numbers.

The interpolation method can be selected via the parameter InterpolationInterpolationInterpolationInterpolationinterpolationinterpolation. The following interpolation methods are supported:

'bilinear'"bilinear""bilinear""bilinear""bilinear""bilinear":

The parameter GrayvalGrayvalGrayvalGrayvalgrayvalgrayval is computed using a bilinear interpolation of the four neighboring gray values of the selected coordinates. Note: direction and cyclic images are treated like byte images.

'bicubic'"bicubic""bicubic""bicubic""bicubic""bicubic":

The parameter GrayvalGrayvalGrayvalGrayvalgrayvalgrayval is computed using a bicubic interpolation of sixteen neighboring gray values of the selected coordinates. Direction and cyclic images are treated like byte images. In this mode, the resulting gray values may contain values that lie outside of the range of numbers that can be represented by the input image type.

'bicubic_clipped'"bicubic_clipped""bicubic_clipped""bicubic_clipped""bicubic_clipped""bicubic_clipped":

The parameter GrayvalGrayvalGrayvalGrayvalgrayvalgrayval is computed using a bicubic interpolation of sixteen neighboring gray values of the selected coordinates. Direction and cyclic images are treated like byte images. In this mode, resulting gray values that lie outside of the range of numbers that can be represented by the input image type are clipped to that range.

Note that get_grayval_interpolatedget_grayval_interpolatedGetGrayvalInterpolatedGetGrayvalInterpolatedGetGrayvalInterpolatedget_grayval_interpolated does not take the domain of the image into account, i.e., if the domain has been reduced, e.g., with reduce_domainreduce_domainReduceDomainReduceDomainReduceDomainreduce_domain, gray values are returned even for points that lie outside the domain.

Execution Information

Parameters

ImageImageImageImageimageimage (input_object)  singlechannelimage objectHImageHObjectHImageHobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / real / complex)

Image whose gray values are to be accessed.

RowRowRowRowrowrow (input_control)  point.y(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Row coordinates of positions.

Default value: 0

Suggested values: 0, 64, 128, 256, 512, 1024

Typical range of values: -0.5 ≤ Row Row Row Row row row

Restriction: -0.5 <= Row && Row < height(Image) - 0.5

ColumnColumnColumnColumncolumncolumn (input_control)  point.x(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Column coordinates of positions.

Number of elements: Column == Row

Default value: 0

Suggested values: 0, 64, 128, 256, 512, 1024

Typical range of values: -0.5 ≤ Column Column Column Column column column

Restriction: -0.5 <= Column && Column < width(Image) - 0.5

InterpolationInterpolationInterpolationInterpolationinterpolationinterpolation (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Interpolation method.

Default value: 'bilinear' "bilinear" "bilinear" "bilinear" "bilinear" "bilinear"

List of values: 'bicubic'"bicubic""bicubic""bicubic""bicubic""bicubic", 'bicubic_clipped'"bicubic_clipped""bicubic_clipped""bicubic_clipped""bicubic_clipped""bicubic_clipped", 'bilinear'"bilinear""bilinear""bilinear""bilinear""bilinear"

GrayvalGrayvalGrayvalGrayvalgrayvalgrayval (output_control)  grayval(-array) HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Gray values of the selected image coordinates.

Result

If the parameters are valid, the operator get_grayval_interpolatedget_grayval_interpolatedGetGrayvalInterpolatedGetGrayvalInterpolatedGetGrayvalInterpolatedget_grayval_interpolated returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Predecessors

read_imageread_imageReadImageReadImageReadImageread_image

Alternatives

get_grayval_contour_xldget_grayval_contour_xldGetGrayvalContourXldGetGrayvalContourXldGetGrayvalContourXldget_grayval_contour_xld, get_grayvalget_grayvalGetGrayvalGetGrayvalGetGrayvalget_grayval

Module

Foundation