stilt.particles.add_release_heights#

stilt.particles.add_release_heights(particles, receptor)[source]#

Return particles with each particle’s release_height, for a column or multipoint receptor.

The release row (age = 0) says where each particle started. For a multipoint receptor that is one of its points, and release_height is that point’s altitude. For a column receptor it is inside one of the numpar slabs the column is split into, and release_height is that slab’s center: the slab is what the particle stands for, not the random height inside it. A model that writes no release row, such as the bundled HYSPLIT, falls back to matching: a column’s particles are released bottom to top in particle order, and a multipoint receptor’s are matched to the nearest point from their first row.

A point receptor’s particles are returned as they are.

Return type:

DataFrame

Parameters:
  • particles (DataFrame)

  • receptor (stilt.receptor.Receptor)