Constructor

VipsImagemask_butterworth_ring

Declaration [src]

int
vips_mask_butterworth_ring (
  VipsImage** out,
  int width,
  int height,
  double order,
  double frequency_cutoff,
  double amplitude_cutoff,
  double ringwidth,
  ...
)

Description [src]

Make a butterworth ring-pass or ring-reject filter, that is, one with a variable, smooth transition positioned at frequency_cutoff of width width, where frequency_cutoff is in the range 0 - 1.

The shape of the curve is controlled by order — higher values give a sharper transition. See Gonzalez and Wintz, Digital Image Processing, 1987.

::: tip “Optional arguments” * nodc: gboolean, don’t set the DC pixel * reject: gboolean, invert the filter sense * optical: gboolean, coordinates in optical space * uchar: gboolean, output a uchar image

::: seealso vips_mask_ideal().

Parameters

`out`	`VipsImage`
	Output image.
	The argument will be set by the function.
	The called function takes ownership of the data, and is responsible for freeing it.
`width`	`int`
	Image size.
`height`	`int`
	Image size.
`order`	`double`
	Filter order.
`frequency_cutoff`	`double`
	Frequency threshold.
`amplitude_cutoff`	`double`
	Amplitude threshold.
`ringwidth`	`double`
	Ringwidth.
`...`	`none`
	`NULL`-terminated list of optional named arguments.

Return value

Returns:	`int`
	0 on success, -1 on error.