Point

class sknano.core.math.Point

Bases: numpy.ndarray

Abstract object representation for a point in \(R^n\).

Parameters:

• p (array_like, optional) – \(x, y\) coordinates of point in \(R^2\) space. \(x, y, z\) coordinates of point in \(R^3\) space.
• nd ({None, int}, optional) –
• dtype (data-type, optional) –
• copy (bool, optional) –

Attributes

T	Same as self.transpose(), except that self is returned if self.ndim < 2.
base	Base object if memory is from some other object.
column_matrix	Return column matrix representation of Point coordinates.
ctypes	An object to simplify the interaction of the array with the ctypes module.
data	Python buffer object pointing to the start of the array’s data.
dtype	Data-type of the array’s elements.
flags	Information about the memory layout of the array.
flat	A 1-D iterator over the array.
imag	The imaginary part of the array.
itemsize	Length of one array element in bytes.
nbytes	Total bytes consumed by the elements of the array.
ndim	Number of array dimensions.
real	The real part of the array.
row_matrix	Return row matrix representation of Point coordinates.
shape	Tuple of array dimensions.
size	Number of elements in the array.
strides	Tuple of bytes to step in each dimension when traversing an array.

Methods

all([axis, out, keepdims])	Returns True if all elements evaluate to True.
any([axis, out, keepdims])	Returns True if any of the elements of a evaluate to True.
argmax([axis, out])	Return indices of the maximum values along the given axis.
argmin([axis, out])	Return indices of the minimum values along the given axis of a.
argpartition(kth[, axis, kind, order])	Returns the indices that would partition this array.
argsort([axis, kind, order])	Returns the indices that would sort this array.
astype(dtype[, order, casting, subok, copy])	Copy of the array, cast to a specified type.
byteswap(inplace)	Swap the bytes of the array elements
choose(choices[, out, mode])	Use an index array to construct a new array from a set of choices.
clip([min, max, out])	Return an array whose values are limited to [min, max].
compress(condition[, axis, out])	Return selected slices of this array along given axis.
conj()	Complex-conjugate all elements.
conjugate()	Return the complex conjugate, element-wise.
copy([order])	Return a copy of the array.
cumprod([axis, dtype, out])	Return the cumulative product of the elements along the given axis.
cumsum([axis, dtype, out])	Return the cumulative sum of the elements along the given axis.
diagonal([offset, axis1, axis2])	Return specified diagonals.
dot(b[, out])	Dot product of two arrays.
dump(file)	Dump a pickle of the array to the specified file.
dumps()	Returns the pickle of the array as a string.
euclidean_distance(pt)	Compute the euclidean distance between pt and self.
fill(value)	Fill the array with a scalar value.
flatten([order])	Return a copy of the array collapsed into one dimension.
getfield(dtype[, offset])	Returns a field of the given array as a certain type.
item(*args)	Copy an element of an array to a standard Python scalar and return it.
itemset(*args)	Insert scalar into an array (scalar is cast to array’s dtype, if possible)
max([axis, out])	Return the maximum along a given axis.
mean([axis, dtype, out, keepdims])	Returns the average of the array elements along given axis.
min([axis, out, keepdims])	Return the minimum along a given axis.
newbyteorder([new_order])	Return the array with the same data viewed with a different byte order.
nonzero()	Return the indices of the elements that are non-zero.
partition(kth[, axis, kind, order])	Rearranges the elements in the array in such a way that value of the element in kth position is in the position it would be in a sorted array.
prod([axis, dtype, out, keepdims])	Return the product of the array elements over the given axis
ptp([axis, out])	Peak to peak (maximum - minimum) value along a given axis.
put(indices, values[, mode])	Set a.flat[n] = values[n] for all n in indices.
ravel([order])	Return a flattened array.
repeat(repeats[, axis])	Repeat elements of an array.
reshape(shape[, order])	Returns an array containing the same data with a new shape.
resize(new_shape[, refcheck])	Change shape and size of array in-place.
rezero([epsilon])	Re-zero Point coordinates near zero.
rezero_coords([epsilon])	Alias for Point.rezero.
rotate([angle, axis, anchor_point, ...])	Rotate Point coordinates.
round([decimals, out])	Return a with each element rounded to the given number of decimals.
searchsorted(v[, side, sorter])	Find indices where elements of v should be inserted in a to maintain order.
setfield(val, dtype[, offset])	Put a value into a specified place in a field defined by a data-type.
setflags([write, align, uic])	Set array flags WRITEABLE, ALIGNED, and UPDATEIFCOPY, respectively.
sort([axis, kind, order])	Sort an array, in-place.
squeeze([axis])	Remove single-dimensional entries from the shape of a.
std([axis, dtype, out, ddof, keepdims])	Returns the standard deviation of the array elements along given axis.
sum([axis, dtype, out, keepdims])	Return the sum of the array elements over the given axis.
swapaxes(axis1, axis2)	Return a view of the array with axis1 and axis2 interchanged.
take(indices[, axis, out, mode])	Return an array formed from the elements of a at the given indices.
tobytes([order])	Construct Python bytes containing the raw data bytes in the array.
tofile(fid[, sep, format])	Write array to a file as text or binary (default).
tolist()	List of Point coordinates formatted for pretty output.
tostring([order])	Construct Python bytes containing the raw data bytes in the array.
trace([offset, axis1, axis2, dtype, out])	Return the sum along diagonals of the array.
translate(t)	Translate Point coordinates by Vector t.
transpose(*axes)	Returns a view of the array with axes transposed.
var([axis, dtype, out, ddof, keepdims])	Returns the variance of the array elements, along given axis.
view([dtype, type])	New view of array with the same data.

Attributes Summary

column_matrix	Return column matrix representation of Point coordinates.
row_matrix	Return row matrix representation of Point coordinates.

Methods Summary

euclidean_distance(pt)	Compute the euclidean distance between pt and self.
rezero([epsilon])	Re-zero Point coordinates near zero.
rezero_coords([epsilon])	Alias for Point.rezero.
rotate([angle, axis, anchor_point, ...])	Rotate Point coordinates.
tolist()	List of Point coordinates formatted for pretty output.
translate(t)	Translate Point coordinates by Vector t.

Attributes Documentation

column_matrix

Return column matrix representation of Point coordinates.

row_matrix

Return row matrix representation of Point coordinates.

Methods Documentation

euclidean_distance(pt)

Compute the euclidean distance between pt and self.

rezero(epsilon=1e-10)

Re-zero Point coordinates near zero.

Set Point coordinates with absolute value less than epsilon to zero.

Parameters:epsilon (float, optional) – Smallest allowed absolute value of any \(x,y,z\) coordinate.

rezero_coords(epsilon=1e-10)

Alias for Point.rezero.

rotate(angle=None, axis=None, anchor_point=None, rot_point=None, from_vector=None, to_vector=None, degrees=False, transform_matrix=None, verbose=False, **kwargs)

Rotate Point coordinates.

Parameters:

• angle (float) –
• axis (Vector, optional) –
• anchor_point (Point, optional) –
• rot_point (Point, optional) –
• to_vector (from_vector,) –
• degrees (bool, optional) –
• transform_matrix (ndarray) –

See also

core.math.rotate

tolist()

List of Point coordinates formatted for pretty output.

translate(t)

Translate Point coordinates by Vector t.

Parameters:t (Vector) –

See also

core.math.translate