add_ring_annotations
- tulips.tulips.add_ring_annotations(ax, rmax, fraction_list=None, show_fraction=True, show_fraction_labels=True, use_actual_mass_fraction=True, percentage_list=None, show_percentage=False, show_percentage_labels=False, startangle=90, counterclock=True, loc=1.25, **kwargs)[source]
Add concentric circles.
Add concentric circles on an axis that indicate the fraction of the maximum radius given. Optionally, indications of percentages can also be given.
- Parameters
- axmatplotlib axis object
- rmaxfloat
Value of the maximum radius of the circle to compare to as a reference
- fraction_list: list
Default None, list of floats giving the fractions of the total mass.
- show_fractionboolean
Default True, whether or not to plot circles that have radii of a fraction of the reference circle radius.
- show_fraction_labels: boolean
Default True, whether or not to add labels indication the fractions.
- use_actual_mass_fraction: boolean
Default True, whether or not to locate the fraction circles at the location where a circle contains this mass or at a fraction of rmax.
- percentage_listlist
Default None, list of floats giving the percentages to add.
- show_percentageboolean
Default False, whether to plot radial lines indicating a certain percentage.
- show_percentage_labelsboolean
Default False, whether or not to add labels indicating percentages.
- startanglefloat
Value of the angle to start with for the percentages.
- counterclock: bool, optional
Default: True, specify percentage direction, clockwise or counterclockwise.
- loc: float
Default 1.25, location of percentage labels in units of fraction of rmax.
- Returns
- List of matplotlib artists created