pysdic.Connectivity.get_property

Connectivity.get_property(key)

Get a property of the connectivity by its key/name.

Note

The returned array is a unwritable view to prevent accidental modifications and is of type numpy.float64.

Note

The property can also be accessed using dictionary-like syntax:

property_values = connectivity['property_key']

Parameters:

key (str) – The key/name of the property to retrieve.

Returns:

A NumPy array of shape \((N_p, A)\) representing the property values for each element in the connectivity.

Return type:

numpy.ndarray

Raises:

KeyError – If the property with the given key does not exist.

Examples

Get a property of the connectivity.

import numpy
from pysdic import Connectivity

connectivity = Connectivity.from_array(numpy.random.rand(100, 3))
intensity = numpy.random.rand(100)
connectivity.set_property('intensity', intensity)
retrieved_intensity = connectivity.get_property('intensity')