:py:mod:`radar.utils.typing.enums` ================================== .. py:module:: radar.utils.typing.enums .. autodoc2-docstring:: radar.utils.typing.enums :allowtitles: Module Contents --------------- Classes ~~~~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`FigureType ` - * - :py:obj:`DirectionDomain ` - * - :py:obj:`AmplitudeDomain ` - * - :py:obj:`AngleDirection ` - * - :py:obj:`PhaseUnit ` - * - :py:obj:`AmplitudeUnit ` - * - :py:obj:`DistanceUnit ` - * - :py:obj:`FrequencyUnit ` - * - :py:obj:`RotationDirection ` - Data ~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`ArrayOrientation ` - .. autodoc2-docstring:: radar.utils.typing.enums.ArrayOrientation :summary: * - :py:obj:`RotationUnit ` - .. autodoc2-docstring:: radar.utils.typing.enums.RotationUnit :summary: API ~~~ .. py:class:: FigureType(*args, **kwds) :canonical: radar.utils.typing.enums.FigureType Bases: :py:obj:`enum.Enum` .. py:attribute:: SURFACE :canonical: radar.utils.typing.enums.FigureType.SURFACE :value: 'surface' .. autodoc2-docstring:: radar.utils.typing.enums.FigureType.SURFACE .. py:attribute:: IMAGE :canonical: radar.utils.typing.enums.FigureType.IMAGE :value: 'image' .. autodoc2-docstring:: radar.utils.typing.enums.FigureType.IMAGE .. py:attribute:: SLICE :canonical: radar.utils.typing.enums.FigureType.SLICE :value: 'slice' .. autodoc2-docstring:: radar.utils.typing.enums.FigureType.SLICE .. py:method:: __signature__() :canonical: radar.utils.typing.enums.FigureType.__signature__ :classmethod: .. py:method:: __new__(value) :canonical: radar.utils.typing.enums.FigureType.__new__ .. py:method:: _add_alias_(name) :canonical: radar.utils.typing.enums.FigureType._add_alias_ .. py:method:: _add_value_alias_(value) :canonical: radar.utils.typing.enums.FigureType._add_value_alias_ .. py:method:: _generate_next_value_(name, start, count, last_values) :canonical: radar.utils.typing.enums.FigureType._generate_next_value_ :staticmethod: .. py:method:: _missing_(value) :canonical: radar.utils.typing.enums.FigureType._missing_ :classmethod: .. py:method:: __repr__() :canonical: radar.utils.typing.enums.FigureType.__repr__ .. py:method:: __str__() :canonical: radar.utils.typing.enums.FigureType.__str__ .. py:method:: __dir__() :canonical: radar.utils.typing.enums.FigureType.__dir__ .. py:method:: __format__(format_spec) :canonical: radar.utils.typing.enums.FigureType.__format__ .. py:method:: __hash__() :canonical: radar.utils.typing.enums.FigureType.__hash__ .. py:method:: __reduce_ex__(proto) :canonical: radar.utils.typing.enums.FigureType.__reduce_ex__ .. py:method:: __deepcopy__(memo) :canonical: radar.utils.typing.enums.FigureType.__deepcopy__ .. py:method:: __copy__() :canonical: radar.utils.typing.enums.FigureType.__copy__ .. py:method:: name() :canonical: radar.utils.typing.enums.FigureType.name .. py:method:: value() :canonical: radar.utils.typing.enums.FigureType.value .. py:class:: DirectionDomain(*args, **kwds) :canonical: radar.utils.typing.enums.DirectionDomain Bases: :py:obj:`enum.Enum` .. py:attribute:: UV :canonical: radar.utils.typing.enums.DirectionDomain.UV :value: 'uv' .. autodoc2-docstring:: radar.utils.typing.enums.DirectionDomain.UV .. py:attribute:: ANGLE :canonical: radar.utils.typing.enums.DirectionDomain.ANGLE :value: 'angle' .. autodoc2-docstring:: radar.utils.typing.enums.DirectionDomain.ANGLE .. py:method:: __signature__() :canonical: radar.utils.typing.enums.DirectionDomain.__signature__ :classmethod: .. py:method:: __new__(value) :canonical: radar.utils.typing.enums.DirectionDomain.__new__ .. py:method:: _add_alias_(name) :canonical: radar.utils.typing.enums.DirectionDomain._add_alias_ .. py:method:: _add_value_alias_(value) :canonical: radar.utils.typing.enums.DirectionDomain._add_value_alias_ .. py:method:: _generate_next_value_(name, start, count, last_values) :canonical: radar.utils.typing.enums.DirectionDomain._generate_next_value_ :staticmethod: .. py:method:: _missing_(value) :canonical: radar.utils.typing.enums.DirectionDomain._missing_ :classmethod: .. py:method:: __repr__() :canonical: radar.utils.typing.enums.DirectionDomain.__repr__ .. py:method:: __str__() :canonical: radar.utils.typing.enums.DirectionDomain.__str__ .. py:method:: __dir__() :canonical: radar.utils.typing.enums.DirectionDomain.__dir__ .. py:method:: __format__(format_spec) :canonical: radar.utils.typing.enums.DirectionDomain.__format__ .. py:method:: __hash__() :canonical: radar.utils.typing.enums.DirectionDomain.__hash__ .. py:method:: __reduce_ex__(proto) :canonical: radar.utils.typing.enums.DirectionDomain.__reduce_ex__ .. py:method:: __deepcopy__(memo) :canonical: radar.utils.typing.enums.DirectionDomain.__deepcopy__ .. py:method:: __copy__() :canonical: radar.utils.typing.enums.DirectionDomain.__copy__ .. py:method:: name() :canonical: radar.utils.typing.enums.DirectionDomain.name .. py:method:: value() :canonical: radar.utils.typing.enums.DirectionDomain.value .. py:class:: AmplitudeDomain(*args, **kwds) :canonical: radar.utils.typing.enums.AmplitudeDomain Bases: :py:obj:`enum.Enum` .. py:attribute:: AntennaFactor :canonical: radar.utils.typing.enums.AmplitudeDomain.AntennaFactor :value: 'af' .. autodoc2-docstring:: radar.utils.typing.enums.AmplitudeDomain.AntennaFactor .. py:attribute:: Gain :canonical: radar.utils.typing.enums.AmplitudeDomain.Gain :value: 'gain' .. autodoc2-docstring:: radar.utils.typing.enums.AmplitudeDomain.Gain .. py:method:: __signature__() :canonical: radar.utils.typing.enums.AmplitudeDomain.__signature__ :classmethod: .. py:method:: __new__(value) :canonical: radar.utils.typing.enums.AmplitudeDomain.__new__ .. py:method:: _add_alias_(name) :canonical: radar.utils.typing.enums.AmplitudeDomain._add_alias_ .. py:method:: _add_value_alias_(value) :canonical: radar.utils.typing.enums.AmplitudeDomain._add_value_alias_ .. py:method:: _generate_next_value_(name, start, count, last_values) :canonical: radar.utils.typing.enums.AmplitudeDomain._generate_next_value_ :staticmethod: .. py:method:: _missing_(value) :canonical: radar.utils.typing.enums.AmplitudeDomain._missing_ :classmethod: .. py:method:: __repr__() :canonical: radar.utils.typing.enums.AmplitudeDomain.__repr__ .. py:method:: __str__() :canonical: radar.utils.typing.enums.AmplitudeDomain.__str__ .. py:method:: __dir__() :canonical: radar.utils.typing.enums.AmplitudeDomain.__dir__ .. py:method:: __format__(format_spec) :canonical: radar.utils.typing.enums.AmplitudeDomain.__format__ .. py:method:: __hash__() :canonical: radar.utils.typing.enums.AmplitudeDomain.__hash__ .. py:method:: __reduce_ex__(proto) :canonical: radar.utils.typing.enums.AmplitudeDomain.__reduce_ex__ .. py:method:: __deepcopy__(memo) :canonical: radar.utils.typing.enums.AmplitudeDomain.__deepcopy__ .. py:method:: __copy__() :canonical: radar.utils.typing.enums.AmplitudeDomain.__copy__ .. py:method:: name() :canonical: radar.utils.typing.enums.AmplitudeDomain.name .. py:method:: value() :canonical: radar.utils.typing.enums.AmplitudeDomain.value .. py:class:: AngleDirection(*args, **kwds) :canonical: radar.utils.typing.enums.AngleDirection Bases: :py:obj:`enum.Enum` .. py:attribute:: AZIMUTH :canonical: radar.utils.typing.enums.AngleDirection.AZIMUTH :value: 'Azimuth' .. autodoc2-docstring:: radar.utils.typing.enums.AngleDirection.AZIMUTH .. py:attribute:: ELEVATION :canonical: radar.utils.typing.enums.AngleDirection.ELEVATION :value: 'Elevation' .. autodoc2-docstring:: radar.utils.typing.enums.AngleDirection.ELEVATION .. py:method:: __signature__() :canonical: radar.utils.typing.enums.AngleDirection.__signature__ :classmethod: .. py:method:: __new__(value) :canonical: radar.utils.typing.enums.AngleDirection.__new__ .. py:method:: _add_alias_(name) :canonical: radar.utils.typing.enums.AngleDirection._add_alias_ .. py:method:: _add_value_alias_(value) :canonical: radar.utils.typing.enums.AngleDirection._add_value_alias_ .. py:method:: _generate_next_value_(name, start, count, last_values) :canonical: radar.utils.typing.enums.AngleDirection._generate_next_value_ :staticmethod: .. py:method:: _missing_(value) :canonical: radar.utils.typing.enums.AngleDirection._missing_ :classmethod: .. py:method:: __repr__() :canonical: radar.utils.typing.enums.AngleDirection.__repr__ .. py:method:: __str__() :canonical: radar.utils.typing.enums.AngleDirection.__str__ .. py:method:: __dir__() :canonical: radar.utils.typing.enums.AngleDirection.__dir__ .. py:method:: __format__(format_spec) :canonical: radar.utils.typing.enums.AngleDirection.__format__ .. py:method:: __hash__() :canonical: radar.utils.typing.enums.AngleDirection.__hash__ .. py:method:: __reduce_ex__(proto) :canonical: radar.utils.typing.enums.AngleDirection.__reduce_ex__ .. py:method:: __deepcopy__(memo) :canonical: radar.utils.typing.enums.AngleDirection.__deepcopy__ .. py:method:: __copy__() :canonical: radar.utils.typing.enums.AngleDirection.__copy__ .. py:method:: name() :canonical: radar.utils.typing.enums.AngleDirection.name .. py:method:: value() :canonical: radar.utils.typing.enums.AngleDirection.value .. py:data:: ArrayOrientation :canonical: radar.utils.typing.enums.ArrayOrientation :value: None .. autodoc2-docstring:: radar.utils.typing.enums.ArrayOrientation .. py:class:: PhaseUnit(*args, **kwds) :canonical: radar.utils.typing.enums.PhaseUnit Bases: :py:obj:`enum.Enum` .. py:attribute:: DEGREE :canonical: radar.utils.typing.enums.PhaseUnit.DEGREE :value: 'Degree' .. autodoc2-docstring:: radar.utils.typing.enums.PhaseUnit.DEGREE .. py:attribute:: RADIAN :canonical: radar.utils.typing.enums.PhaseUnit.RADIAN :value: 'Radian' .. autodoc2-docstring:: radar.utils.typing.enums.PhaseUnit.RADIAN .. py:method:: __signature__() :canonical: radar.utils.typing.enums.PhaseUnit.__signature__ :classmethod: .. py:method:: __new__(value) :canonical: radar.utils.typing.enums.PhaseUnit.__new__ .. py:method:: _add_alias_(name) :canonical: radar.utils.typing.enums.PhaseUnit._add_alias_ .. py:method:: _add_value_alias_(value) :canonical: radar.utils.typing.enums.PhaseUnit._add_value_alias_ .. py:method:: _generate_next_value_(name, start, count, last_values) :canonical: radar.utils.typing.enums.PhaseUnit._generate_next_value_ :staticmethod: .. py:method:: _missing_(value) :canonical: radar.utils.typing.enums.PhaseUnit._missing_ :classmethod: .. py:method:: __repr__() :canonical: radar.utils.typing.enums.PhaseUnit.__repr__ .. py:method:: __str__() :canonical: radar.utils.typing.enums.PhaseUnit.__str__ .. py:method:: __dir__() :canonical: radar.utils.typing.enums.PhaseUnit.__dir__ .. py:method:: __format__(format_spec) :canonical: radar.utils.typing.enums.PhaseUnit.__format__ .. py:method:: __hash__() :canonical: radar.utils.typing.enums.PhaseUnit.__hash__ .. py:method:: __reduce_ex__(proto) :canonical: radar.utils.typing.enums.PhaseUnit.__reduce_ex__ .. py:method:: __deepcopy__(memo) :canonical: radar.utils.typing.enums.PhaseUnit.__deepcopy__ .. py:method:: __copy__() :canonical: radar.utils.typing.enums.PhaseUnit.__copy__ .. py:method:: name() :canonical: radar.utils.typing.enums.PhaseUnit.name .. py:method:: value() :canonical: radar.utils.typing.enums.PhaseUnit.value .. py:class:: AmplitudeUnit(*args, **kwds) :canonical: radar.utils.typing.enums.AmplitudeUnit Bases: :py:obj:`enum.Enum` .. py:attribute:: LINEAR :canonical: radar.utils.typing.enums.AmplitudeUnit.LINEAR :value: 'Linear' .. autodoc2-docstring:: radar.utils.typing.enums.AmplitudeUnit.LINEAR .. py:attribute:: DECIBEL :canonical: radar.utils.typing.enums.AmplitudeUnit.DECIBEL :value: 'Decibel' .. autodoc2-docstring:: radar.utils.typing.enums.AmplitudeUnit.DECIBEL .. py:method:: __signature__() :canonical: radar.utils.typing.enums.AmplitudeUnit.__signature__ :classmethod: .. py:method:: __new__(value) :canonical: radar.utils.typing.enums.AmplitudeUnit.__new__ .. py:method:: _add_alias_(name) :canonical: radar.utils.typing.enums.AmplitudeUnit._add_alias_ .. py:method:: _add_value_alias_(value) :canonical: radar.utils.typing.enums.AmplitudeUnit._add_value_alias_ .. py:method:: _generate_next_value_(name, start, count, last_values) :canonical: radar.utils.typing.enums.AmplitudeUnit._generate_next_value_ :staticmethod: .. py:method:: _missing_(value) :canonical: radar.utils.typing.enums.AmplitudeUnit._missing_ :classmethod: .. py:method:: __repr__() :canonical: radar.utils.typing.enums.AmplitudeUnit.__repr__ .. py:method:: __str__() :canonical: radar.utils.typing.enums.AmplitudeUnit.__str__ .. py:method:: __dir__() :canonical: radar.utils.typing.enums.AmplitudeUnit.__dir__ .. py:method:: __format__(format_spec) :canonical: radar.utils.typing.enums.AmplitudeUnit.__format__ .. py:method:: __hash__() :canonical: radar.utils.typing.enums.AmplitudeUnit.__hash__ .. py:method:: __reduce_ex__(proto) :canonical: radar.utils.typing.enums.AmplitudeUnit.__reduce_ex__ .. py:method:: __deepcopy__(memo) :canonical: radar.utils.typing.enums.AmplitudeUnit.__deepcopy__ .. py:method:: __copy__() :canonical: radar.utils.typing.enums.AmplitudeUnit.__copy__ .. py:method:: name() :canonical: radar.utils.typing.enums.AmplitudeUnit.name .. py:method:: value() :canonical: radar.utils.typing.enums.AmplitudeUnit.value .. py:class:: DistanceUnit(*args, **kwds) :canonical: radar.utils.typing.enums.DistanceUnit Bases: :py:obj:`enum.Enum` .. py:attribute:: CENTIMETER :canonical: radar.utils.typing.enums.DistanceUnit.CENTIMETER :value: 0.01 .. autodoc2-docstring:: radar.utils.typing.enums.DistanceUnit.CENTIMETER .. py:attribute:: METER :canonical: radar.utils.typing.enums.DistanceUnit.METER :value: 1 .. autodoc2-docstring:: radar.utils.typing.enums.DistanceUnit.METER .. py:attribute:: KILOMETER :canonical: radar.utils.typing.enums.DistanceUnit.KILOMETER :value: 1000.0 .. autodoc2-docstring:: radar.utils.typing.enums.DistanceUnit.KILOMETER .. py:method:: __signature__() :canonical: radar.utils.typing.enums.DistanceUnit.__signature__ :classmethod: .. py:method:: __new__(value) :canonical: radar.utils.typing.enums.DistanceUnit.__new__ .. py:method:: _add_alias_(name) :canonical: radar.utils.typing.enums.DistanceUnit._add_alias_ .. py:method:: _add_value_alias_(value) :canonical: radar.utils.typing.enums.DistanceUnit._add_value_alias_ .. py:method:: _generate_next_value_(name, start, count, last_values) :canonical: radar.utils.typing.enums.DistanceUnit._generate_next_value_ :staticmethod: .. py:method:: _missing_(value) :canonical: radar.utils.typing.enums.DistanceUnit._missing_ :classmethod: .. py:method:: __repr__() :canonical: radar.utils.typing.enums.DistanceUnit.__repr__ .. py:method:: __str__() :canonical: radar.utils.typing.enums.DistanceUnit.__str__ .. py:method:: __dir__() :canonical: radar.utils.typing.enums.DistanceUnit.__dir__ .. py:method:: __format__(format_spec) :canonical: radar.utils.typing.enums.DistanceUnit.__format__ .. py:method:: __hash__() :canonical: radar.utils.typing.enums.DistanceUnit.__hash__ .. py:method:: __reduce_ex__(proto) :canonical: radar.utils.typing.enums.DistanceUnit.__reduce_ex__ .. py:method:: __deepcopy__(memo) :canonical: radar.utils.typing.enums.DistanceUnit.__deepcopy__ .. py:method:: __copy__() :canonical: radar.utils.typing.enums.DistanceUnit.__copy__ .. py:method:: name() :canonical: radar.utils.typing.enums.DistanceUnit.name .. py:method:: value() :canonical: radar.utils.typing.enums.DistanceUnit.value .. py:class:: FrequencyUnit(*args, **kwds) :canonical: radar.utils.typing.enums.FrequencyUnit Bases: :py:obj:`enum.Enum` .. py:attribute:: HERTZ :canonical: radar.utils.typing.enums.FrequencyUnit.HERTZ :value: 1 .. autodoc2-docstring:: radar.utils.typing.enums.FrequencyUnit.HERTZ .. py:attribute:: KILOHERTZ :canonical: radar.utils.typing.enums.FrequencyUnit.KILOHERTZ :value: 1000.0 .. autodoc2-docstring:: radar.utils.typing.enums.FrequencyUnit.KILOHERTZ .. py:attribute:: MEGAHERTZ :canonical: radar.utils.typing.enums.FrequencyUnit.MEGAHERTZ :value: 1000000.0 .. autodoc2-docstring:: radar.utils.typing.enums.FrequencyUnit.MEGAHERTZ .. py:attribute:: GIGAHERTZ :canonical: radar.utils.typing.enums.FrequencyUnit.GIGAHERTZ :value: 1000000000.0 .. autodoc2-docstring:: radar.utils.typing.enums.FrequencyUnit.GIGAHERTZ .. py:method:: __signature__() :canonical: radar.utils.typing.enums.FrequencyUnit.__signature__ :classmethod: .. py:method:: __new__(value) :canonical: radar.utils.typing.enums.FrequencyUnit.__new__ .. py:method:: _add_alias_(name) :canonical: radar.utils.typing.enums.FrequencyUnit._add_alias_ .. py:method:: _add_value_alias_(value) :canonical: radar.utils.typing.enums.FrequencyUnit._add_value_alias_ .. py:method:: _generate_next_value_(name, start, count, last_values) :canonical: radar.utils.typing.enums.FrequencyUnit._generate_next_value_ :staticmethod: .. py:method:: _missing_(value) :canonical: radar.utils.typing.enums.FrequencyUnit._missing_ :classmethod: .. py:method:: __repr__() :canonical: radar.utils.typing.enums.FrequencyUnit.__repr__ .. py:method:: __str__() :canonical: radar.utils.typing.enums.FrequencyUnit.__str__ .. py:method:: __dir__() :canonical: radar.utils.typing.enums.FrequencyUnit.__dir__ .. py:method:: __format__(format_spec) :canonical: radar.utils.typing.enums.FrequencyUnit.__format__ .. py:method:: __hash__() :canonical: radar.utils.typing.enums.FrequencyUnit.__hash__ .. py:method:: __reduce_ex__(proto) :canonical: radar.utils.typing.enums.FrequencyUnit.__reduce_ex__ .. py:method:: __deepcopy__(memo) :canonical: radar.utils.typing.enums.FrequencyUnit.__deepcopy__ .. py:method:: __copy__() :canonical: radar.utils.typing.enums.FrequencyUnit.__copy__ .. py:method:: name() :canonical: radar.utils.typing.enums.FrequencyUnit.name .. py:method:: value() :canonical: radar.utils.typing.enums.FrequencyUnit.value .. py:class:: RotationDirection(*args, **kwds) :canonical: radar.utils.typing.enums.RotationDirection Bases: :py:obj:`enum.Enum` .. py:attribute:: CW :canonical: radar.utils.typing.enums.RotationDirection.CW :value: 'clockwise' .. autodoc2-docstring:: radar.utils.typing.enums.RotationDirection.CW .. py:attribute:: CCW :canonical: radar.utils.typing.enums.RotationDirection.CCW :value: 'counterclockwise' .. autodoc2-docstring:: radar.utils.typing.enums.RotationDirection.CCW .. py:method:: __signature__() :canonical: radar.utils.typing.enums.RotationDirection.__signature__ :classmethod: .. py:method:: __new__(value) :canonical: radar.utils.typing.enums.RotationDirection.__new__ .. py:method:: _add_alias_(name) :canonical: radar.utils.typing.enums.RotationDirection._add_alias_ .. py:method:: _add_value_alias_(value) :canonical: radar.utils.typing.enums.RotationDirection._add_value_alias_ .. py:method:: _generate_next_value_(name, start, count, last_values) :canonical: radar.utils.typing.enums.RotationDirection._generate_next_value_ :staticmethod: .. py:method:: _missing_(value) :canonical: radar.utils.typing.enums.RotationDirection._missing_ :classmethod: .. py:method:: __repr__() :canonical: radar.utils.typing.enums.RotationDirection.__repr__ .. py:method:: __str__() :canonical: radar.utils.typing.enums.RotationDirection.__str__ .. py:method:: __dir__() :canonical: radar.utils.typing.enums.RotationDirection.__dir__ .. py:method:: __format__(format_spec) :canonical: radar.utils.typing.enums.RotationDirection.__format__ .. py:method:: __hash__() :canonical: radar.utils.typing.enums.RotationDirection.__hash__ .. py:method:: __reduce_ex__(proto) :canonical: radar.utils.typing.enums.RotationDirection.__reduce_ex__ .. py:method:: __deepcopy__(memo) :canonical: radar.utils.typing.enums.RotationDirection.__deepcopy__ .. py:method:: __copy__() :canonical: radar.utils.typing.enums.RotationDirection.__copy__ .. py:method:: name() :canonical: radar.utils.typing.enums.RotationDirection.name .. py:method:: value() :canonical: radar.utils.typing.enums.RotationDirection.value .. py:data:: RotationUnit :canonical: radar.utils.typing.enums.RotationUnit :value: None .. autodoc2-docstring:: radar.utils.typing.enums.RotationUnit