magneticalc.Format.Format

class documentation

class Format:

View In Hierarchy

Format class.

Static Method	`absolute_filename`	Converts a filename to an absolute filename.
Static Method	`filename_uri`	Converts a filename to a filename URI.
Static Method	`float_to_str`	Converts a float value to string.
Static Method	`point_to_str`	Converts a single 3D point to string.
Static Method	`points_to_str`	Converts list of 3D points to string.
Static Method	`str_to_point`	Converts string to single 3D point.
Static Method	`str_to_points`	Converts string to list of 3D points.
Class Variable	`CoordinatePrecision`	Undocumented
Class Variable	`FloatPrecision`	Coordinate precision.

@staticmethod
def absolute_filename(filename):

Converts a filename to an absolute filename.

Parameters
filename:`str`	Filename
Returns
`str`	Absolute filename

@staticmethod
def filename_uri(filename):

Converts a filename to a filename URI.

Parameters
filename:`str`	Filename
Returns
`str`	Filename URI

@staticmethod
def float_to_str(value):

Converts a float value to string.

Parameters
value:`float`	Undocumented
Returns
`str`	Undocumented

@staticmethod
def point_to_str(point):

Converts a single 3D point to string.

Parameters
point:`Union[np.ndarray, List[float]]`	Single 3D point
Returns
`str`	String

@staticmethod
def points_to_str(points):

Converts list of 3D points to string.

Parameters
points:`Union[np.ndarray, List[List[float]]]`	List of 3D points
Returns
`str`	String

@staticmethod
def str_to_point(str_point):

Converts string to single 3D point.

Parameters
str_point:`str`	String
Returns
`Union[np.ndarray, List[float]]`	Single 3D point

@staticmethod
def str_to_points(str_points):

Converts string to list of 3D points.

Parameters
str_points:`str`	String
Returns
`Union[np.ndarray, List[List[float]]]`	List of 3D points

CoordinatePrecision: int =

Undocumented

FloatPrecision: int =

Coordinate precision.