File: legacy_api.rst

package info (click to toggle)
python-momepy 0.8.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 51,428 kB
  • sloc: python: 11,098; makefile: 35; sh: 11
file content (137 lines) | stat: -rw-r--r-- 2,011 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
.. _legacy_api_ref:

.. currentmodule:: momepy


Legacy API reference
====================

.. warning::
    The functionality listed below is part of the legacy API and has been deprecated.
    Each class emits ``FutureWarning`` with a deprecation note. If you'd like to
    silence all of these warnigns, set an environment variable ``ALLOW_LEGACY_MOMEPY``
    to ``"True"``::

      import os

      os.environ["ALLOW_LEGACY_MOMEPY"] = "True"

elements
--------

.. autosummary::
   :toctree: generated/

   Blocks
   get_network_id
   get_node_id
   Tessellation

dimension
---------

.. autosummary::
   :toctree: generated/

   Area
   AverageCharacter
   CourtyardArea
   CoveredArea
   FloorArea
   LongestAxisLength
   Perimeter
   PerimeterWall
   SegmentsLength
   StreetProfile
   Volume
   WeightedCharacter

shape
-----

.. autosummary::
  :toctree: generated/

  CentroidCorners
  CircularCompactness
  CompactnessWeightedAxis
  Convexity
  Corners
  CourtyardIndex
  Elongation
  EquivalentRectangularIndex
  FormFactor
  FractalDimension
  Linearity
  Rectangularity
  ShapeIndex
  SquareCompactness
  Squareness
  VolumeFacadeRatio

spatial distribution
--------------------
.. autosummary::
  :toctree: generated/

  Alignment
  BuildingAdjacency
  CellAlignment
  MeanInterbuildingDistance
  NeighborDistance
  NeighboringStreetOrientationDeviation
  Neighbors
  Orientation
  SharedWalls
  SharedWallsRatio
  StreetAlignment

intensity
---------
.. autosummary::
   :toctree: generated/

   AreaRatio
   BlocksCount
   Count
   Courtyards
   Density
   NodeDensity
   Reached

diversity
---------
.. autosummary::
   :toctree: generated/

   Gini
   Percentiles
   Range
   Shannon
   Simpson
   Theil
   Unique

spatial weights
---------------
.. autosummary::
   :toctree: generated/

   DistanceBand
   sw_high

preprocessing
-------------
.. autosummary::
   :toctree: generated/

   preprocess


utilities
---------
.. autosummary::
   :toctree: generated/

   limit_range
   unique_id