fiesta.disperse.Filament#

class fiesta.disperse.Filament[source]#

Class to deal with filaments output by DisPerSE.

Variables:
  • idx (int) – Unique index for the filament in the Network.

  • cps (pair of CriticalPoint) – Critical point at the start and end of the filament.

  • nsamp (int) – Number of sampling points of the filament.

  • samps (Quantity) – Array of position \((x,y,z)\) of each sampling point of the filament. Defaults to units of u.pix.

  • scale (str) – Either pixel if the grid is not scaled to the source AREPO snapshot, else physical.

  • length (Quantity) – Length of the filament. Set only after calling calc_length.

  • radius (Quantity) – Radius of the filament. Fixed value set during characterize_filament.

  • mass (Quantity) – Mass of the filament. Set only after calling calc_mass.

  • arepo_ids (list of int’s) – List of indices of ArepoVoronoiGrid cells that are “part” of the filament. Set only after calling characterize_filament.

Filament.calc_length([verbose])

Calculates the length of the filament, either in pixels or physical units depending on scale, by finely integrating the Euclidean distance between very close points on the filament.

Filament.calc_mass(avg[, verbose])

Calculates the mass of the filament by summing the mass of all cells given by arepo_ids (corrected for double-counting).

Filament.characterize_filament(avg, ...[, ...])

Function to query all simulation cells around the filament, based on source ArepoVoronoiGrid.

Filament.correct_spine(avg, sphere_radius[, ...])

Function to correct the spine of a filament, based on source ArepoVoronoiGrid.

Filament.get_arepo_ids()

Returns arepo_ids.

Filament.get_length([unit])

Returns length.

Filament.get_mass([unit])

Returns mass.

Filament.get_points(s[, unit])

Function to sample any point on the filament spine.

Filament.get_radius([unit])

Returns radius.

Filament.plot_density_profile(avg[, ...])

Plot mass-weighted 2d histogram projection of the AREPO Voronoi grid along an axis.