BioSimSpace.Types.Length

class BioSimSpace.Types.Length(*args)

A length type.

__init__(*args)

Constructor.

*args can be a magnitude and unit, or a string representation of the length, e.g. “12 Angstrom”.

Parameters
  • magnitude (float) – The magnitude.

  • unit (str) – The unit.

  • string (str) – A string representation of the length.

Examples

Create an object representing a length of 148.6 Angstrom then print the length in nanometers.

>>> import BioSimSpace as BSS
>>> length = BSS.Types.Length(148.6, "A")
>>> print(length.nanometers())

The same as above, except passing a string representation of the length to the constructor.

>>> import BioSimSpace as BSS
>>> length = BSS.Types.Length("148.6 A")
>>> print(length.nanometers())

The string matching is extremeley flexible, so all of the following would be valid arguments: “148.6 A”, “148.6 angstrom”, “1.48e2 Angstrom”.

Methods

__add__(other)

Addition operator.

__delattr__

Implement delattr(self, name).

__dir__

Default dir() implementation.

__eq__(other)

Equals to operator.

__format__

Default object formatter.

__ge__(other)

Greater than or equal to operator.

__getattribute__

Return getattr(self, name).

__gt__(other)

Gretear than operator.

__init__(*args)

Constructor.

__init_subclass__

This method is called when a class is subclassed.

__le__(other)

Less than or equal to operator.

__lt__(other)

Less than operator.

__mul__(other)

Multiplication operator.

__ne__(other)

Not equals to operator.

__neg__()

Unary - operator.

__new__

Create and return a new object.

__pos__()

Unary + operator.

__reduce__

Helper for pickle.

__reduce_ex__

Helper for pickle.

__repr__()

Return a human readable string representation of the object.

__rmul__(other)

Multiplication operator.

__setattr__

Implement setattr(self, name, value).

__sizeof__

Size of object in memory, in bytes.

__str__()

Return a human readable string representation of the object.

__sub__(other)

Subtraction operator.

__subclasshook__

Abstract classes can override this to customize issubclass().

__truediv__(other)

Division operator.

_convert_to(unit)

Return the length in a different unit.

_default_unit([mag])

Internal method to return an object of the same type in the default unit.

_from_string(string)

Convert a string to an object of the same type.

_validate_unit(unit)

Validate that the unit are supported.

angstroms()

Return the length in angstroms.

centimeters()

Return the length in centimeters.

magnitude()

Return the magnitude.

meters()

Return the length in meters.

millimeters()

Return the length in millimeters.

nanometers()

Return the length in nanometers.

picometers()

Return the length in picometers.

unit()

Return the unit.

Attributes

__dict__

__doc__

__hash__

__module__

__weakref__

list of weak references to the object (if defined)

_abbreviations

_doc_strings

_null_unit

_print_format

_supported_units

angstroms()

Return the length in angstroms.

Returns

length – The length in angstrom.

Return type

Length

centimeters()

Return the length in centimeters.

Returns

length – The length in centimeters.

Return type

Length

magnitude()

Return the magnitude.

Returns

magnitude – The magnitude of the type.

Return type

float

meters()

Return the length in meters.

Returns

length – The length in meters.

Return type

Length

millimeters()

Return the length in millimeters.

Returns

length – The length in millimeters.

Return type

Length

nanometers()

Return the length in nanometers.

Returns

length – The length in nanometers.

Return type

Length

picometers()

Return the length in picometers.

Returns

length – The length in picometers.

Return type

Length

unit()

Return the unit.

Returns

unit – The unit of the type.

Return type

str