single_cell_parserscalar_fieldScalarFieldget_scalar

ScalarField.get_scalar

single_cell_parser.scalar_field.ScalarField.get_scalar(xyz)

Fetch the scalar value of the voxel containing the point xyz.

Warning

Returns 0 if xyz is outside the bounding box.

Parameters:

xyz (tuple) – The 3D coordinates of the point.

Returns:

The scalar value of the voxel containing the point, 0 if outside bounding box.

Return type:

float