Coding Ref

How to use numpy.clip() in Python

How to use numpy.clip() in Python

In Python, numpy.clip() is a function that is used to clip values in an array to be within a specified range.

This function is often used to clip outliers in data to make the data more manageable or to prevent certain values from causing problems in downstream analyses.

Syntax

Here is the syntax for numpy.clip():

main.py
numpy.clip(a, a_min, a_max, out=None)

This function takes the following arguments:

  • a: The input array. This is the array whose values will be clipped.
  • a_min: The minimum value that elements of a can take. Any values in a that are less than a_min will be set to a_min.
  • a_max: The maximum value that elements of a can take. Any values in a that are greater than a_max will be set to a_max.
  • out (optional): The output array. If provided, the clipped values will be stored in this array. Otherwise, a new array will be created to hold the clipped values.

Examples

Here is an example of how you might use numpy.clip() to clip values in an array.

Suppose you have the following array:

main.py
import numpy as np

a = np.array([1, 5, 10, -2, -5, 20])

You can use numpy.clip() to clip all values in this array that are less than 0 to 0 and all values that are greater than 10 to 10, like this:

main.py
a_clipped = np.clip(a, 0, 10)

This will result in the following array:

output
array([1, 5, 10, 0, 0, 10])

You can also use numpy.clip() to clip values in place, without creating a new array.

To do this, you can provide the out argument to numpy.clip(), like this:

main.py
np.clip(a, 0, 10, out=a)
output
array([1, 5, 10, 0, 0, 10])

This will modify the original a array in place, so that all values less than 0 are set to 0 and all values greater than 10 are set to 10.

You'll also like

Related tutorials curated for you

    NumPy numpy.transpose()

    How to use numpy.percentile() in Python

    How to use numpy.clip() in Python

    How to use numpy.linspace() in Python

    How to use numpy.ravel() in Python

    How to use numpy.ndarray.flatten() in Python

    How to use numpy.random.uniform() in Python

    ModuleNotFoundError: No module named 'numpy' in Python

    What does numpy.arrange() do?

    How to use numpy.round() in Python

    How to use numpy.vstack() in Python

    How to use numpy.exp() in Python