Skip to content

measures

Sam Vente edited this page Aug 6, 2024 · 1 revision

measures

``

Functions

Name Description
calculate_polygon_area
calculate_volume
copy_measure
create_measure Create a measure from a dictionary of attributes and a type string.
delete_measure
edit_measure
get_green_infra_table
get_measure
get_measures
save_measure

calculate_polygon_area

calculate_polygon_area(gdf, site)

calculate_volume

calculate_volume(area, height=0.0, percent_area=100.0)

copy_measure

copy_measure(old_name, new_name, new_description)

create_measure

create_measure(attrs, type=None)

Create a measure from a dictionary of attributes and a type string.

Parameters

Name Type Description Default
attrs dict[str, Any] Dictionary of attributes for the measure. required
type str Type of measure to create. None
database IDatabase Database to use for creating the measure, by default None required

Returns

Type Description
IMeasure Measure object.

delete_measure

delete_measure(name)

edit_measure

edit_measure(measure)

get_green_infra_table

get_green_infra_table(measure_type)

get_measure

get_measure(name)

get_measures

get_measures()

save_measure

save_measure(measure)

Clone this wiki locally