reVX.setbacks.regulations.SetbackRegulations
- class SetbackRegulations(base_setback_dist, regulations_fpath=None, multiplier=None)[source]
Bases:
AbstractBaseRegulations
Setback regulation values.
- Parameters:
base_setback_dist (float | int) – Base setback distance (m). This value will be used to calculate the setback distance when a multiplier is provided either via the
regulations_fpath
csv or themultiplier
input. In these cases, the setbacks will be calculated usingbase_setback_dist * multiplier
.regulations_fpath (str | None, optional) – Path to regulations
.csv
or.gpkg
file. At a minimum, this file must contain the following columns:Feature Type
, which contains labels for the type of setback that each row represents,Feature Subtype
, which contains labels for feature subtypes,Value Type
, which specifies wether the value is a multiplier or static height,Value
, which specifies the numeric value of the setback or multiplier, andFIPS
, which specifies a unique 5-digit code for each county (this can be an integer - no leading zeros required). Valid options for theValue Type
are (case-insensitive; dashes, underscores, and spaces are interchangeable):“Structure Height Multiplier”
“Meters”
If this input is
None
, a generic setback ofbase_setback_dist * multiplier
is used. By defaultNone
.multiplier (int | float | str | None, optional) – A setback multiplier to use if regulations are not supplied. This multiplier will be applied to the
base_setback_dist
to calculate the setback. If supplied along withregulations_fpath
, this input will be used to apply a setback to all counties not listed in the regulations file. By defaultNone
.
Methods
Attributes
REQUIRED_COLUMNS
The base setback distance, in meters.
Regulations table.
Regulation value used for global regulations.
Flag indicating wether generic regulations exist.
Flag indicating wether local regulations exist.
Generic setback multiplier.
- property df
Regulations table.
- Type:
geopandas.GeoDataFrame | None