driptorch.Pattern.to_quicfire

Pattern.to_quicfire(burn_unit: driptorch.unit.BurnUnit, filename: Optional[str] = None, time_offset=0, resolution: int = 1, dst_epsg: Optional[int] = None) → None | str

Write paths dictionary to QUIC-fire ignition file format.

Parameters

burn_unitBurnUnit

Burn unit that defines the extent of the QF simulation

filenamestr, optional

If provided, write the ignition file to the filename. Defaults to None.

time_offsetfloat, optional

Time offset to add to the ignition times. Defaults to 0.

resolutionint, optional

Horizontal resolution of QUIC-fire domain (meters). Defaults to 1.

dst_epsgint, optional

EPSG code for the destination projection. Defaults to None.

Returns

None | str

None if filename provided, string containing the ignition file if not.