HALCON Operator reference

convol_channelsT_convol_channelsConvolChannelsConvolChannelsconvol_channels (Operator)

convol_channelsT_convol_channelsConvolChannelsConvolChannelsconvol_channels — Perform a convolution along the channel dimension.

Signature

convol_channels(MultichannelImage : ImageSmoothed : Filter, Border : )

Herror T_convol_channels(const Hobject MultichannelImage, Hobject* ImageSmoothed, const Htuple Filter, const Htuple Border)

void ConvolChannels(const HObject& MultichannelImage, HObject* ImageSmoothed, const HTuple& Filter, const HTuple& Border)

HImage HImage::ConvolChannels(const HTuple& Filter, const HString& Border) const

HImage HImage::ConvolChannels(const HTuple& Filter, const char* Border) const

HImage HImage::ConvolChannels(const HTuple& Filter, const wchar_t* Border) const   ( Windows only)

static void HOperatorSet.ConvolChannels(HObject multichannelImage, out HObject imageSmoothed, HTuple filter, HTuple border)

HImage HImage.ConvolChannels(HTuple filter, string border)

def convol_channels(multichannel_image: HObject, filter: Sequence[float], border: str) -> HObject

Description

convol_channelsconvol_channelsConvolChannelsConvolChannelsconvol_channels applies the linear filter FilterFilterFilterfilterfilter along the channel dimension of the multichannel image MultichannelImageMultichannelImageMultichannelImagemultichannelImagemultichannel_image and stores the result in ImageSmoothedImageSmoothedImageSmoothedimageSmoothedimage_smoothed. Each pixel is processed independently. Border handling along the channel dimension is specified by BorderBorderBorderborderborder and either continues the current value ('constant'"constant""constant""constant""constant") or mirrors the values ('mirror'"mirror""mirror""mirror""mirror").

This operator can be used, for example, to smooth hyperspectral images across spectra. Filter parameters can be generated, for instance, with gen_savitzky_golay_filtergen_savitzky_golay_filterGenSavitzkyGolayFilterGenSavitzkyGolayFiltergen_savitzky_golay_filter.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Automatically parallelized on domain level.

Parameters

MultichannelImageMultichannelImageMultichannelImagemultichannelImagemultichannel_image (input_object)  multichannel-image(-array) objectHImageHObjectHObjectHobject (byte / uint2 / real)

Multichannel image to be smoothed.

ImageSmoothedImageSmoothedImageSmoothedimageSmoothedimage_smoothed (output_object)  image(-array) objectHImageHObjectHObjectHobject * (real)

Smoothed multichannel image.

FilterFilterFilterfilterfilter (input_control)  real-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Filter coefficients.

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

Type of boundary treatment.

Default: 'constant' "constant" "constant" "constant" "constant"

List of values: 'constant'"constant""constant""constant""constant", 'mirror'"mirror""mirror""mirror""mirror"

Possible Predecessors

gen_savitzky_golay_filtergen_savitzky_golay_filterGenSavitzkyGolayFilterGenSavitzkyGolayFiltergen_savitzky_golay_filter

Module

Foundation