measure module

This is the measure module.

This module contains measure types defined in the ISO 19103:2015 specification for which no equivalence is already present in the Python standard library.

Acceleration

Bases: DirectedMeasure

Acceleration is the rate of change of velocity per unit of time.

Source code in opengis/util/measure.py

class Acceleration(DirectedMeasure):
    """
    Acceleration is the rate of change of velocity per unit of time.
    """

Angle

Bases: Measure

Angle is the amount of rotation needed to bring one line or plane into coincidence with another, generally measured in radians or degrees.

Source code in opengis/util/measure.py

class Angle(Measure):
    """
    Angle is the amount of rotation needed to bring one line or plane into
    coincidence with another, generally measured in radians or degrees.
    """

    @property
    @abstractmethod
    def unit_of_measure(self) -> UomAngle:
        """The units of the angle."""

unit_of_measure: UomAngle abstractmethod property

The units of the angle.

AngularAcceleration

Bases: DirectedMeasure

AngularAcceleration is the rate of change of angular velocity per unit of time.

Source code in opengis/util/measure.py

class AngularAcceleration(DirectedMeasure):
    """
    AngularAcceleration is the rate of change of angular velocity per unit
    of time.
    """

AngularSpeed

Bases: Measure

AngularSpeed (often known as angular velocity) is the magnitude of the rate of change of angular position of a rotating body. Angular speed is always positive.

Source code in opengis/util/measure.py

class AngularSpeed(Measure):
    """
    AngularSpeed (often known as angular velocity) is the magnitude of the
    rate of change of angular position of a rotating body. Angular speed
    is always positive.
    """

    @property
    @abstractmethod
    def unit_of_measure(self) -> UomAngularSpeed:
        """The units of the angular speed."""

unit_of_measure: UomAngularSpeed abstractmethod property

The units of the angular speed.

AngularVelocity

Bases: DirectedMeasure

AngularVelocity is the instantaneous rate of change of angular displacement with time.

Source code in opengis/util/measure.py

class AngularVelocity(DirectedMeasure):
    """
    AngularVelocity is the instantaneous rate of change of angular
    displacement with time.
    """

    @property
    @abstractmethod
    def unit_of_measure(self) -> UomSpeed:
        """The units of the speed."""

    @property
    @abstractmethod
    def time(self) -> UomTime:
        """The units of the time."""

    @property
    @abstractmethod
    def angle(self) -> UomAngle:
        """The units of the angle."""

angle: UomAngle abstractmethod property

The units of the angle.

time: UomTime abstractmethod property

The units of the time.

unit_of_measure: UomSpeed abstractmethod property

The units of the speed.

Area

Bases: Measure

Area is the measure of the physical extent of any 2-D geometric object.

Source code in opengis/util/measure.py

class Area(Measure):
    """
    Area is the measure of the physical extent of any 2-D geometric object.
    """

    @property
    @abstractmethod
    def unit_of_measure(self) -> UomArea:
        """The units of the area."""

unit_of_measure: UomArea abstractmethod property

The units of the area.

Currency

Bases: Measure

Currency is a system of money in general use in a particular country or countries.

Source code in opengis/util/measure.py

class Currency(Measure):
    """
    Currency is a system of money in general use in a particular country
    or countries.
    """

    @property
    @abstractmethod
    def unit_of_measure(self) -> UomCurrency:
        """The units of the currency."""

unit_of_measure: UomCurrency abstractmethod property

The units of the currency.

DirectedMeasure

Bases: ABC

A DirectedMeasure is the result of ascertaining the value of a characteristic of some entity where direction is an essential aspect of the characteristic.

Source code in opengis/util/measure.py

class DirectedMeasure(ABC):
    """
    A DirectedMeasure is the result of ascertaining the value of
    a characteristic of some entity where direction is an essential aspect
    of the characteristic.
    """

    @property
    @abstractmethod
    def value(self) -> Vector:
        """
        The magnitude and direction of the directed measure.
        """

    @property
    @abstractmethod
    def unit_of_measure(self) -> UnitOfMeasure:
        """The units of the directed measure."""

unit_of_measure: UnitOfMeasure abstractmethod property

The units of the directed measure.

value: Vector abstractmethod property

The magnitude and direction of the directed measure.

Distance

Bases: Length

Distance is used as a type for returning the separation between two points.

Source code in opengis/util/measure.py

class Distance(Length):
    """
    Distance is used as a type for returning the separation between two points.
    """

Length

Bases: Measure

Length is the measure of distance as an integral, for example the length of curve, the perimeter of a polygon as the length of the boundary.

Source code in opengis/util/measure.py

class Length(Measure):
    """
    Length is the measure of distance as an integral, for example the length
    of curve, the perimeter of a polygon as the length of the boundary.
    """

    @property
    @abstractmethod
    def unit_of_measure(self) -> UomLength:
        """The units of the length."""

unit_of_measure: UomLength abstractmethod property

The units of the length.

Measure

Bases: ABC

A Measure is the result from performing the act or process of ascertaining the value of a characteristic of some entity.

Source code in opengis/util/measure.py

class Measure(ABC):
    """
    A Measure is the result from performing the act or process of
    ascertaining the value of a characteristic of some entity.
    """

    @property
    @abstractmethod
    def value(self) -> float:
        """The value of the measure."""

    @property
    @abstractmethod
    def unit_of_measure(self) -> UnitOfMeasure:
        """The units of the measure."""

unit_of_measure: UnitOfMeasure abstractmethod property

The units of the measure.

value: float abstractmethod property

The value of the measure.

Scale

Bases: Measure

Scale is the ratio of one quantity to another, often unitless.

Source code in opengis/util/measure.py

class Scale(Measure):
    """Scale is the ratio of one quantity to another, often unitless."""

    @property
    @abstractmethod
    def unit_of_measure(self) -> UomScale:
        """The units of the length."""

    @property
    @abstractmethod
    def source_units(self) -> UomLength:
        """The units of the source measure."""

    @property
    @abstractmethod
    def target_units(self) -> UomLength:
        """The units of the target measure."""

source_units: UomLength abstractmethod property

The units of the source measure.

target_units: UomLength abstractmethod property

The units of the target measure.

unit_of_measure: UomScale abstractmethod property

The units of the length.

Speed

Bases: Measure

Speed is the rate at which someone or something moves, generally expressed as distance over time. It is distinct from velocity in that speed can be measured along a curve.

Source code in opengis/util/measure.py

class Speed(Measure):
    """
    Speed is the rate at which someone or something moves, generally expressed
    as distance over time. It is distinct from velocity in that speed can be
    measured along a curve.
    """

    @property
    @abstractmethod
    def time(self) -> UomTime:
        "The units of measure for the time."

    @property
    @abstractmethod
    def distance(self) -> UomLength:
        "The units of measure for the distance."

    @property
    @abstractmethod
    def unit_of_measure(self) -> UomSpeed:
        """The units of the speed."""

distance: UomLength abstractmethod property

The units of measure for the distance.

time: UomTime abstractmethod property

The units of measure for the time.

unit_of_measure: UomSpeed abstractmethod property

The units of the speed.

StandardUnits

Bases: Enum

Standard units are the base and named derived units that form part of the International System of Units (SI), plus units which are based on SI units and are required for the other measures, for example metres per second.

Source code in opengis/util/measure.py

class StandardUnits(Enum):
    """
    Standard units are the base and named derived units that form part of the
    International System of Units (SI), plus units which are based on SI units
    and are required for the other measures, for example metres per second.
    """
    METRE = "metre"
    SECOND = "second"
    RADIAN = "radian"
    SQUARE_METRE = "squareMetre"
    CUBIC_METRE = "cubicMetre"
    METER_PR_SECOND = "metrePrSecond"
    METRE_PR_METRE = "metrePrMetre"
    METRE_PR_SECOND_PR_SECOND = "metrePrSecondPrSecond"
    RADIAN_PR_SECOND = "radianPrSecond"
    RADIAN_PR_SECOND_PR_SECOND = "radianPrSecondPrSecond"
    KILOGRAM = "kilomgram"

SubUnitsPerUnit

Bases: ABC

Sub units per unit.

Source code in opengis/util/measure.py

class SubUnitsPerUnit(ABC):
    """Sub units per unit."""

    @property
    @abstractmethod
    def factor(self) -> float:
        """The number of sub units per unit."""

factor: float abstractmethod property

The number of sub units per unit.

TimeMeasure

Bases: Measure

TimeMeasure is the designation of an instant on a selected time scale, astronomical or atomic. It is used in the sense of time of day.

Source code in opengis/util/measure.py

class TimeMeasure(Measure):
    """
    TimeMeasure is the designation of an instant on a selected time scale,
    astronomical or atomic. It is used in the sense of time of day.
    """

    @property
    @abstractmethod
    def unit_of_measure(self) -> UomTime:
        """The units of the time."""

unit_of_measure: UomTime abstractmethod property

The units of the time.

UnitOfMeasure

Bases: ABC

A UnitOfMeasure is a quantity adopted as a standard of measurement for other quantities of the same kind.

Source code in opengis/util/measure.py

class UnitOfMeasure(ABC):
    """
    A UnitOfMeasure is a quantity adopted as a standard of measurement
    for other quantities of the same kind.
    """

    @property
    @abstractmethod
    def uom_identifier(self) -> str:
        """
        A string used to identify the unit of measure.

        EXAMPLES: foot, metre, radian, degree, inch, minute,
        kilometres per hour
        """

    @property
    @abstractmethod
    def subunit(self) -> Optional[SubUnitsPerUnit]:
        """The sub units per unit"""

subunit: Optional[SubUnitsPerUnit] abstractmethod property

The sub units per unit

uom_identifier: str abstractmethod property

A string used to identify the unit of measure.

EXAMPLES: foot, metre, radian, degree, inch, minute, kilometres per hour

UnitsList

Bases: Enum

This code list contains other units which are not part of SI, but are in common use in some parts of the world.

Source code in opengis/util/measure.py

class UnitsList(Enum):
    """
    This code list contains other units which are not part of SI, but are
    in common use in some parts of the world.
    """
    METRE = "metre"
    SECOND = "second"
    RADIAN = "radian"
    SQUARE_METRE = "squareMetre"
    CUBIC_METRE = "cubicMetre"
    METER_PR_SECOND = "metrePrSecond"
    METRE_PR_METRE = "metrePrMetre"
    METRE_PR_SECOND_PR_SECOND = "metrePrSecondPrSecond"
    RADIAN_PR_SECOND = "radianPrSecond"
    RADIAN_PR_SECOND_PR_SECOND = "radianPrSecondPrSecond"
    KILOGRAM = "kilomgram"
    FOOT = "foot"
    SQUARE_FOOT = "squareFoot"
    CUBIC_YARD = "cubicYard"

UomAcceleration

Bases: UnitOfMeasure

UomAcceleration provides both the unit of measure of the velocity and of the time, for example metres per second, per second.

Source code in opengis/util/measure.py

class UomAcceleration(UnitOfMeasure):
    """
    UomAcceleration provides both the unit of measure of the velocity and of
    the time, for example metres per second, per second.
    """

UomAngle

Bases: UnitOfMeasure

UomAngle is any of the reference quantities used to express the value of angles. In the US, the sexagesimal system of degrees, minutes and seconds is frequently used. The radian measurement system is also used. In other parts of the world the grad angle, gon, measuring system is used.

Source code in opengis/util/measure.py

class UomAngle(UnitOfMeasure):
    """
    UomAngle is any of the reference quantities used to express the value of
    angles. In the US, the sexagesimal system of degrees, minutes and seconds
    is frequently used. The radian measurement system is also used. In other
    parts of the world the grad angle, gon, measuring system is used.
    """

UomAngularAcceleration

Bases: UnitOfMeasure

UomAngularAcceleration provides both the unit of measure of the angular velocity and of the time, for example degrees per second, per second.

Source code in opengis/util/measure.py

class UomAngularAcceleration(UnitOfMeasure):
    """
    UomAngularAcceleration provides both the unit of measure of the angular
    velocity and of the time, for example degrees per second, per second.
    """

UomAngularSpeed

Bases: UnitOfMeasure

UomAngularSpeed provides both the unit of measure of the angle and of the time, for example degrees per second.

Source code in opengis/util/measure.py

class UomAngularSpeed(UnitOfMeasure):
    """
    UomAngularSpeed provides both the unit of measure of the angle and of the
    time, for example degrees per second.
    """

UomAngularVelocity

Bases: UnitOfMeasure

UomAngularVelocity is any of the reference quantities used to express the value of angular velocity. It must include an indication of which direction is considered positive.

Source code in opengis/util/measure.py

class UomAngularVelocity(UnitOfMeasure):
    """
    UomAngularVelocity is any of the reference quantities used to express
    the value of angular velocity. It must include an indication of which
    direction is considered positive.
    """

UomArea

Bases: UnitOfMeasure

UomArea is any of the reference quantities used to express the value of area. Common units include square length units, such as square metres and square feet. Other common unit include acres (in the US) and hectares.

Source code in opengis/util/measure.py

class UomArea(UnitOfMeasure):
    """
    UomArea is any of the reference quantities used to express the value of
    area. Common units include square length units, such as square metres and
    square feet. Other common unit include acres (in the US) and hectares.
    """

UomCurrency

Bases: UnitOfMeasure

UomCurrency indicates the specific currency, such as one listed in ISO 4217.

Source code in opengis/util/measure.py

class UomCurrency(UnitOfMeasure):
    """
    UomCurrency indicates the specific currency, such as one listed
    in ISO 4217.
    """

UomLength

Bases: UnitOfMeasure

UomLength is any of the reference quantities used to express the value of the length, distance between two entities. Examples are the English System of feet and inches or the metric system of millimetres, centimetres and metres, also the System International (SI) System of Units.

Source code in opengis/util/measure.py

class UomLength(UnitOfMeasure):
    """
    UomLength is any of the reference quantities used to express the value of
    the length, distance between two entities. Examples are the English System
    of feet and inches or the metric system of millimetres, centimetres and
    metres, also the System International (SI) System of Units.
    """

UomScale

Bases: UnitOfMeasure

UomScale is any of the reference quantities used to express the value of scale, or the ratio between quantities with the same unit. Scale factors are often unitless.

Source code in opengis/util/measure.py

class UomScale(UnitOfMeasure):
    """
    UomScale is any of the reference quantities used to express the value of
    scale, or the ratio between quantities with the same unit. Scale factors
    are often unitless.
    """

UomSpeed

Bases: UnitOfMeasure

UomSpeed provides both the unit of measure of the distance and of the time, for example kilometres per hour, or metres per second.

Source code in opengis/util/measure.py

class UomSpeed(UnitOfMeasure):
    """
    UomSpeed provides both the unit of measure of the distance and of the
    time, for example kilometres per hour, or metres per second.
    """

UomTime

Bases: UnitOfMeasure

UomTime is any of the reference quantities used to express the value of or reckoning the passage of time and/or date, (e.g. seconds, minutes, days, months).

Source code in opengis/util/measure.py

class UomTime(UnitOfMeasure):
    """
    UomTime is any of the reference quantities used to express the value of or
    reckoning the passage of time and/or date, (e.g. seconds, minutes,
    days, months).
    """

UomVelocity

Bases: UnitOfMeasure

UomVelocity is any of the reference quantities used to express the value of velocity.

Source code in opengis/util/measure.py

class UomVelocity(UnitOfMeasure):
    """
    UomVelocity is any of the reference quantities used to express the value
    of velocity.
    """

UomVolume

Bases: UnitOfMeasure

UomVolume is any of the reference quantities used to express the value of volume.

Source code in opengis/util/measure.py

class UomVolume(UnitOfMeasure):
    """
    UomVolume is any of the reference quantities used to express the value
    of volume.
    """

UomWeight

Bases: UnitOfMeasure

UomWeight is any of the reference quantities used to express force, such as newton.

Source code in opengis/util/measure.py

class UomWeight(UnitOfMeasure):
    """
    UomWeight is any of the reference quantities used to express force,
    such as newton.
    """

Velocity

Bases: DirectedMeasure

Velocity is the instantaneous rate of change of position with time. It is usually calculated using the simple formula, the change in position during a given time interval.

Source code in opengis/util/measure.py

class Velocity(DirectedMeasure):
    """
    Velocity is the instantaneous rate of change of position with time.
    It is usually calculated using the simple formula, the change in position
    during a given time interval.
    """

Volume

Bases: Measure

Volume is the measure of the physical space of any 3-D geometric object.

Source code in opengis/util/measure.py

class Volume(Measure):
    """
    Volume is the measure of the physical space of any 3-D geometric object.
    """

    @property
    @abstractmethod
    def unit_of_measure(self) -> UomVolume:
        """The units of the volume."""

unit_of_measure: UomVolume abstractmethod property

The units of the volume.

Weight

Bases: Measure

Weight is the force exerted on the mass of a body by a gravitational field.

Source code in opengis/util/measure.py

class Weight(Measure):
    """
    Weight is the force exerted on the mass of a body by a gravitational field.
    """

    @property
    @abstractmethod
    def unit_of_measure(self) -> UomWeight:
        """The units of the weight."""

unit_of_measure: UomWeight abstractmethod property

The units of the weight.