Skip to content

convol_channelsConvolChannelsConvolChannelsconvol_channelsT_convol_channels🔗

Short description🔗

convol_channelsConvolChannelsConvolChannelsconvol_channelsT_convol_channels — Perform a convolution along the channel dimension.

Signature🔗

convol_channels( image MultichannelImage, out image ImageSmoothed, real Filter, string Border )void ConvolChannels( const HObject& MultichannelImage, HObject* ImageSmoothed, const HTuple& Filter, const HTuple& Border )static void HOperatorSet.ConvolChannels( HObject multichannelImage, out HObject imageSmoothed, HTuple filter, HTuple border )def convol_channels( multichannel_image: HObject, filter: Sequence[float], border: str ) -> HObject

Herror T_convol_channels( 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)

HImage HImage.ConvolChannels( HTuple filter, string border )

Description🔗

convol_channelsConvolChannels applies the linear filter Filterfilterfilter along the channel dimension of the multichannel image MultichannelImagemultichannelImagemultichannel_image and stores the result in ImageSmoothedimageSmoothedimage_smoothed. Each pixel is processed independently. Border handling along the channel dimension is specified by Borderborderborder and either continues the current value ('constant'"constant") or mirrors the values ('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_filterGenSavitzkyGolayFilter.

Execution information🔗

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🔗

MultichannelImagemultichannelImagemultichannel_image (input_object) multichannel-image(-array) → object (byte / uint2 / real)HObject (byte / uint2 / real)HImage (byte / uint2 / real)HObject (byte / uint2 / real)Hobject (byte / uint2 / real)

Multichannel image to be smoothed.

ImageSmoothedimageSmoothedimage_smoothed (output_object) image(-array) → object (real)HObject (real)HImage (real)HObject (real)Hobject * (real)

Smoothed multichannel image.

Filterfilterfilter (input_control) real-array → (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

Filter coefficients.

Borderborderborder (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Type of boundary treatment.

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

Combinations with other operators🔗

Combinations

Possible predecessors

gen_savitzky_golay_filterGenSavitzkyGolayFilter

Module🔗

Foundation