File tree 1 file changed +21
-6
lines changed
lib/matplotlib/projections
1 file changed +21
-6
lines changed Original file line number Diff line number Diff line change @@ -115,15 +115,30 @@ def inverted(self):
115
115
116
116
117
117
class PolarAffine (mtransforms .Affine2DBase ):
118
- """
119
- The affine part of the polar projection. Scales the output so
120
- that maximum radius rests on the edge of the axes circle.
118
+ r"""
119
+ The affine part of the polar projection.
120
+
121
+ Scales the output so that maximum radius rests on the edge of the axes
122
+ circle and the origin is mapped to (0.5, 0.5). The transform applied is
123
+ the same to x and y components and given by:
124
+
125
+ .. math::
126
+
127
+ x_{1} = 0.5 \left [ \frac{x_{0}}{(r_{\max} - r_{\min})} + 1 \right ]
128
+
129
+ :math:`r_{\min}, r_{\max}` are the minimum and maximum radial limits after
130
+ any scaling (e.g. log scaling) has been removed.
121
131
"""
122
132
def __init__ (self , scale_transform , limits ):
123
133
"""
124
- *limits* is the view limit of the data. The only part of
125
- its bounds that is used is the y limits (for the radius limits).
126
- The theta range is handled by the non-affine transform.
134
+ Parameters
135
+ ----------
136
+ scale_transform : `~matplotlib.transforms.Transform`
137
+ Scaling transform for the data. This is used to remove any scaling
138
+ from the radial view limits.
139
+ limits : `~matplotlib.transforms.BboxBase`
140
+ View limits of the data. The only part of its bounds that is used
141
+ is the y limits (for the radius limits).
127
142
"""
128
143
super ().__init__ ()
129
144
self ._scale_transform = scale_transform
You can’t perform that action at this time.
0 commit comments