keep#

VectorArray.keep(condition, squeeze=True, setval=nan)[source]#

Keep all vectors i where condition[i] == True.

Parameters:
conditionndarray of booleans

Mask controlling which vectors are kept.

squeezebool, default True.

If false, fill all vectors that are not kept with setval instead of removing them.

setvalfloat, default np.nan

If squeeze is false, fill removed data with this.

Returns:
vectorsVectorArray

Examples

>>> vecs = ap.VectorArray([[1, 2, 3], [4, 5, 6], [6, 7, 8]])
>>> vecs.keep(vecs.x != 1)
VectorArray([[4. 5. 6.]
             [6. 7. 8.]])
>>> vecs.keep(vecs.x != 1, squeeze = False)
VectorArray([[nan nan nan]
             [ 4.  5.  6.]
             [ 6.  7.  8.]])
>>> vecs.keep(vecs.x != 1, squeeze = False, setval=0.0)
VectorArray([[0. 0. 0.]
             [4. 5. 6.]
             [6. 7. 8.]])