f4enix.output.rssa.rssa_plotting.PlottingFunctions#

class f4enix.output.rssa.rssa_plotting.PlottingFunctions#

Bases: ABC

Methods

`__init__`()
`calculate_perimeter_positions`()	It adds a new column to the tracks DataFrame called 'perimeter_pos' that takes the X and Y coordinates and calculates the position as a perimeter coordinate.
`get_plot`()
`save_figure`(out_path)	Save the figure to the specified path.
`set_particle`(particle_type)	Set the particle type to filter the tracks.
`set_perimeter_limits`(vmin, vmax)	Set the limits for the perimeter positions.
`set_surface_ids`(surface_ids)	Set the surface IDs to filter the tracks.
`set_z_limits`(vmin, vmax)	Set the z limits for the plot.
`show`()	Show the plot.

Attributes

`tracks`
`rssa_parameters`

calculate_perimeter_positions() → None#

It adds a new column to the tracks DataFrame called ‘perimeter_pos’ that takes the X and Y coordinates and calculates the position as a perimeter coordinate. The perimeter position is calculated as theta * r, where theta is the angle in radians and r is the radius of each track.

The theta is calculated using the arctan2 function, which gives the angle between the positive X-axis and the point (x, y). In that calculation, the X coordinate is multiplied by -1 to “flip” the plot, this way it looks as a cylinder observed from the inside.

save_figure(out_path: Path | str)#: Save the figure to the specified path.

set_particle(particle_type: Literal['n', 'p'])#: Set the particle type to filter the tracks.

set_perimeter_limits(vmin: float, vmax: float)#: Set the limits for the perimeter positions.

set_surface_ids(surface_ids: list[int])#: Set the surface IDs to filter the tracks.

set_z_limits(vmin: float, vmax: float)#: Set the z limits for the plot.

show()#: Show the plot.