cloudViewer.utility.ScalarField#

class cloudViewer.utility.ScalarField#

A simple scalar field (to be associated to a point cloud).

static Is_Valid_Value(value: SupportsFloat) → bool#: Returns whether a scalar value is valid or not.

static Nan() → float#: Returns the specific NaN value

__init__(self: cloudViewer.utility.ScalarField, name: str = 'ScalarField') → None#

add_element(self, value)#

Adds element.

Parameters:: value (SupportsFloat) –
Returns:: None

compute_mean_variance(self)#

Computes the mean value (and optionally the variance value) of the scalar field.

Returns:: tuple[float, float]

compute_min_max(self)#

Determines the min and max values

Returns:: None

current_size(self)#

Returns current size.

Returns:: int

fill(self, fill_value=0)#

Returns the maximum value.

Parameters:: fill_value (SupportsFloat, optional, default=0) –
Returns:: None

get_link_count(self)#

Returns the current link count.

Returns:: int

get_max(self)#

Returns the maximum value.

Returns:: float

get_min(self)#

Returns the minimum value.

Returns:: float

get_name(self)#

Returns scalar field name.

Returns:: str

get_value(*args, **kwargs)#

Overloaded function.

get_value(self, index)
Gets value.

Parameters:: index (SupportsInt) –
Returns:: float

get_value(self, index)
Gets value(const version).

Parameters:: index (SupportsInt) –
Returns:: float

invalid_value(self, index)#

Sets the value as ‘invalid’ (i.e. NAN_VALUE).

Parameters:: index (SupportsInt) –
Returns:: None

link(self)#

Increase counter.

Returns:: None

release(self)#

Decrease counter and deletes object when 0.

Returns:: None

reserve(self, count)#

Reserves memory (no exception thrown).

Parameters:: count (SupportsInt) –
Returns:: bool

resize(self, count, is_fill=False, value=0)#

Resizes memory (no exception thrown).

Parameters:

count (SupportsInt) –
is_fill (bool, optional, default=False) –
value (SupportsFloat, optional, default=0) –

Returns:

bool

set_name(self, name)#

Sets scalar field name.

Parameters:: name (str) –
Returns:: None

set_value(self, index, value)#

Sets value.

Parameters:

index (SupportsInt) –
value (SupportsFloat) –

Returns:

None

swap(self, i1, i2)#

Swaps scalar value.

Parameters:

i1 (SupportsInt) –
i2 (SupportsInt) –

Returns:

None