@@ -302,10 +302,14 @@ def is_transform_set(self):
302
302
303
303
def set_transform (self , t ):
304
304
"""
305
- Set the :class:`~matplotlib.transforms.Transform` instance
306
- used by this artist.
305
+ Set the artist transform.
307
306
308
- ACCEPTS: :class:`~matplotlib.transforms.Transform` instance
307
+ Parameters
308
+ ----------
309
+ t : `~.Transform`
310
+
311
+ ..
312
+ ACCEPTS: `~.Transform`
309
313
"""
310
314
self ._transform = t
311
315
self ._transformSet = True
@@ -523,6 +527,9 @@ def set_snap(self, snap):
523
527
segments, round to the nearest pixel center
524
528
525
529
Only supported by the Agg and MacOSX backends.
530
+
531
+ ..
532
+ ACCEPTS: Optional[bool]
526
533
"""
527
534
self ._snap = snap
528
535
self .stale = True
@@ -553,6 +560,9 @@ def set_sketch_params(self, scale=None, length=None, randomness=None):
553
560
"""
554
561
Sets the sketch parameters.
555
562
563
+ ..
564
+ ACCEPTS: (scale: float, length: float, randomness: float)
565
+
556
566
Parameters
557
567
----------
558
568
@@ -576,9 +586,14 @@ def set_sketch_params(self, scale=None, length=None, randomness=None):
576
586
self .stale = True
577
587
578
588
def set_path_effects (self , path_effects ):
579
- """
580
- set path_effects, which should be a list of instances of
581
- matplotlib.patheffect._Base class or its derivatives.
589
+ """Set the path effects.
590
+
591
+ ..
592
+ ACCEPTS: `~.AbstractPathEffect`
593
+
594
+ Parameters
595
+ ----------
596
+ path_effects : `~.AbstractPathEffect`
582
597
"""
583
598
self ._path_effects = path_effects
584
599
self .stale = True
@@ -762,13 +777,21 @@ def set_rasterized(self, rasterized):
762
777
self ._rasterized = rasterized
763
778
764
779
def get_agg_filter (self ):
765
- "return filter function to be used for agg filter"
780
+ """Return filter function to be used for agg filter."" "
766
781
return self ._agg_filter
767
782
768
783
def set_agg_filter (self , filter_func ):
769
- """
770
- set agg_filter function.
784
+ """Set the agg filter.
771
785
786
+ ..
787
+ ACCEPTS: a filter function, which takes a (m, n, 3) float array and
788
+ a dpi value, and returns a (m, n, 3) array
789
+
790
+ Parameters
791
+ ----------
792
+ filter_func : callable
793
+ A filter function, which takes a (m, n, 3) float array and a dpi
794
+ value, and returns a (m, n, 3) array.
772
795
"""
773
796
self ._agg_filter = filter_func
774
797
self .stale = True
0 commit comments