driptorch.Pattern#

class driptorch.Pattern(heat: list[int], igniter: list[int], leg: list[int], times: list[list[float]], geometry: list[shapely.geometry.linestring.LineString], epsg: int)#

Patterns are objects that store the spatial and temporal components of a firing technique.

Parameters
heatlist[int]

Heat of the path

igniterlist[int]

Igniter id assigned to the path

leglist[int])

Leg for the path

timeslist[list[float]]

Coordinate arrival times for the path

geometrylist[LineString]

Path geometry

epsgint

EPSG code for path geometry

__init__(heat: list[int], igniter: list[int], leg: list[int], times: list[list[float]], geometry: list[shapely.geometry.linestring.LineString], epsg: int)#

Methods

__init__(heat, igniter, leg, times, ...)

empty_path_dict()

Helper method for initializing a path parameter dictionary

from_dict(paths_dict, epsg)

Alternative constructor for initializing a Pattern object with a dictionary of path parameters

merge(pattern[, time_offset, inplace])

Merge an input pattern with self

to_dict()

Returns the Pattern path parameters as a dictionary

to_json()

Write the Pattern to a GeoJSON dictionary

to_quicfire(burn_unit[, filename, ...])

Write paths dictionary to QUIC-fire ignition file format.

translate(x_off, y_off)

Translate pattern geometry along the x and y axis by the supplied x and y offset amounts.