protected function Sharpen::arguments in Imagick 8

Returns the definition of the operation arguments.

Image toolkit operation implementers must implement this method to "document" their operation, thus also if no arguments are expected.

Return value

array An array whose keys are the names of the arguments (e.g. "width", "degrees") and each value is an associative array having the following keys:

• description: A string with the argument description. This is used only internally for documentation purposes, so it does not need to be translatable.
• required: (optional) A boolean indicating if this argument should be provided or not. Defaults to TRUE.
• default: (optional) When the argument is set to "required" = FALSE, this must be set to a default value. Ignored for "required" = TRUE arguments.

Overrides ImageToolkitOperationBase::arguments

File

src/Plugin/ImageToolkit/Operation/imagick/Sharpen.php, line 23

Class

Sharpen

Defines imagick sharpen operation.

Namespace

Drupal\imagick\Plugin\ImageToolkit\Operation\imagick

Code

protected function arguments() {
  return [
    'radius' => [
      'description' => 'The radius of the Gaussian, in pixels, not counting the center pixel. Use 0 for auto-select.',
    ],
    'sigma' => [
      'description' => 'The standard deviation of the Gaussian, in pixels.',
    ],
    'amount' => [
      'description' => 'The fraction of the difference between the original and the blur image that is added back into the original.',
    ],
    'threshold' => [
      'description' => 'The threshold, as a fraction of QuantumRange, needed to apply the difference amount.',
    ],
  ];
}