Instance Method

imageByApplyingFilter:withInputParameters:

Returns a new image created by applying a filter to the original image with the specified name and parameters.

Declaration

- (CIImage *)imageByApplyingFilter:(NSString *)filterName withInputParameters:(NSDictionary<NSString *,id> *)params;

Parameters

filterName

The name of the filter to apply, as used when creating a CIFilter instance with the filterWithName: method.

params

A dictionary whose key-value pairs are set as input values to the filter. Each key is a constant that specifies the name of an input parameter for the filter, and the corresponding value is the value for that parameter. See Core Image Filter Reference for built-in filters and their allowed parameters.

Return Value

An image object representing the result of applying the filter.

Discussion

Calling this method is equivalent to the following sequence of steps:

  1. Creating a CIFilter instance

  2. Setting the original image as the filter’s inputImage parameter

  3. Setting the remaining filter parameters from the params dictionary

  4. Retrieving the outputImage object from the filter

See Also

Creating an Image by Modifying an Existing Image

- imageByApplyingFilter:

Applies the filter to an image and returns the output.

- imageByApplyingTransform:

Returns a new image that represents the original image after applying an affine transform.

- imageByCroppingToRect:

Returns a new image with a cropped portion of the original image.

- imageByApplyingOrientation:

Returns a new image created by transforming the original image to the specified EXIF orientation.

- imageByClampingToExtent

Returns a new image created by making the pixel colors along its edges extend infinitely in all directions.

- imageByClampingToRect:

Returns a new image created by cropping to a specified area, then making the pixel colors along the edges of the cropped image extend infinitely in all directions.

- imageByCompositingOverImage:

Returns a new image created by compositing the original image over the specified destination image.

- imageByColorMatchingColorSpaceToWorkingSpace:

Returns a new image created by color matching from the specified color space to the context’s working color space.

- imageByColorMatchingWorkingSpaceToColorSpace:

Returns a new image created by color matching from the context’s working color space to the specified color space.

- imageByPremultiplyingAlpha

Returns a new image created by multiplying the image’s RGB values by its alpha values.

- imageByUnpremultiplyingAlpha

Returns a new image created by dividing the image’s RGB values by its alpha values.

- imageBySettingAlphaOneInExtent:

Returns a new image created by setting all alpha values to 1.0 within the specified rectangle and to 0.0 outside of that area.

- imageByApplyingGaussianBlurWithSigma:

Returns a new image created by applying a Gaussian Blur filter to the image.

- imageBySettingProperties:

Returns a new image created by adding the specified metadata properties to the image.

- imageByInsertingIntermediate

Returns a new image created by inserting an intermediate.

- imageByInsertingIntermediate:

Returns a new image created by inserting a cacheable intermediate.