Firebench
1. Datasets and fire experiments
2. Models used in FireBench
3. Benchmarks information
4. Standard FireBench file format
5. Metrics and Scores information
6. Benchmarks list
7. Tutorials
8. Standard Namespace
9. Content of the package
10. Contributing to FireBench
11. Developer’s Guide
12. Changelog
13. Dependencies
14. Licence
15. API Reference
Firebench
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Y
|
Z
A
add_anderson_dead_fuel_ratio() (in module firebench.tools.fuel_models_utils)
add_file_handler() (in module firebench.tools.logging_config)
add_scott_and_burgan_dead_fuel_ratio() (in module firebench.tools.fuel_models_utils)
add_scott_and_burgan_total_fuel_load() (in module firebench.tools.fuel_models_utils)
add_scott_and_burgan_total_savr() (in module firebench.tools.fuel_models_utils)
AIR_DENSITY (firebench.tools.namespace.StandardVariableNames attribute)
AIR_TEMPERATURE (firebench.tools.namespace.StandardVariableNames attribute)
ALPHA (firebench.tools.namespace.StandardVariableNames attribute)
anderson_2015_stats() (in module firebench.stats.internal.fuel_models)
apply_wind_reduction_factor() (in module firebench.wind_interpolation.wind_reduction_factor)
array_to_geopolygons() (in module firebench.tools.raster_to_perimeters)
auto_bins() (in module firebench.stats.utils.hist)
B
balbi_2022_fixed() (firebench.ros_models.surface_for_vegetation.Balbi_2022_fixed_SFIRE static method)
Balbi_2022_fixed_SFIRE (class in firebench.ros_models.surface_for_vegetation)
Baughman_20ft_wind_reduction_factor_unsheltered() (in module firebench.wind_interpolation.wind_reduction_factor)
Baughman_generalized_wind_reduction_factor_unsheltered() (in module firebench.wind_interpolation.wind_reduction_factor)
BETA (firebench.tools.namespace.StandardVariableNames attribute)
binary_accuracy() (in module firebench.metrics.confusion_matrix.binary_performance)
binary_cm() (in module firebench.metrics.confusion_matrix.utils)
binary_f_score() (in module firebench.metrics.confusion_matrix.binary_performance)
binary_false_positive_rate() (in module firebench.metrics.confusion_matrix.binary_performance)
binary_negative_predicted_value() (in module firebench.metrics.confusion_matrix.binary_performance)
binary_precision() (in module firebench.metrics.confusion_matrix.binary_performance)
binary_recall_rate() (in module firebench.metrics.confusion_matrix.binary_performance)
binary_specificity() (in module firebench.metrics.confusion_matrix.binary_performance)
BUILDING_LENGTH_SEPARATION (firebench.tools.namespace.StandardVariableNames attribute)
BUILDING_LENGTH_SIDE (firebench.tools.namespace.StandardVariableNames attribute)
BUILDING_RATIO_FIRE_RESISTANT (firebench.tools.namespace.StandardVariableNames attribute)
BUILDING_RATIO_STRUCTURE_WOOD_BARE (firebench.tools.namespace.StandardVariableNames attribute)
BUILDING_RATIO_STRUCTURE_WOOD_MORTAR (firebench.tools.namespace.StandardVariableNames attribute)
C
calculate_sha256() (in module firebench.tools.utils)
CANOPY_DENSITY_BULK (firebench.tools.namespace.StandardVariableNames attribute)
CANOPY_HEIGHT (firebench.tools.namespace.StandardVariableNames attribute)
CANOPY_HEIGHT_BOTTOM (firebench.tools.namespace.StandardVariableNames attribute)
CANOPY_HEIGHT_TOP (firebench.tools.namespace.StandardVariableNames attribute)
check_data_quality_ros_model() (in module firebench.tools.check_data_quality)
check_input_completeness() (in module firebench.tools.check_data_quality)
check_validity_range() (in module firebench.tools.check_data_quality)
compute_ros() (firebench.ros_models.surface_for_urban.Hamada_1 static method)
(firebench.ros_models.surface_for_urban.Hamada_2 static method)
(firebench.ros_models.surface_for_vegetation.Balbi_2022_fixed_SFIRE static method)
(firebench.ros_models.surface_for_vegetation.Rothermel_SFIRE static method)
(firebench.ros_models.surface_for_vegetation.Santoni_2011 static method)
compute_ros_with_units() (firebench.ros_models.surface_for_urban.Hamada_1 static method)
(firebench.ros_models.surface_for_urban.Hamada_2 static method)
(firebench.ros_models.surface_for_vegetation.Balbi_2022_fixed_SFIRE static method)
(firebench.ros_models.surface_for_vegetation.Rothermel_SFIRE static method)
(firebench.ros_models.surface_for_vegetation.Santoni_2011 static method)
configure_logging() (in module firebench.tools.logging_config)
convert_input_data_units() (in module firebench.tools.check_data_quality)
copy_file_to_workflow_record() (in module firebench.tools.local_db_management)
create_file_handler() (in module firebench.tools.logging_config)
create_record_directory() (in module firebench.tools.local_db_management)
D
DIRECTION (firebench.tools.namespace.StandardVariableNames attribute)
E
extract_magnitudes() (in module firebench.tools.check_data_quality)
F
find_closest_fuel_class_by_properties() (in module firebench.tools.fuel_models_utils)
FIRE_ARRIVAL_TIME (firebench.tools.namespace.StandardVariableNames attribute)
FIRE_BURN_SEVERITY (firebench.tools.namespace.StandardVariableNames attribute)
firebench.metrics.confusion_matrix.binary_performance
module
firebench.metrics.confusion_matrix.utils
module
firebench.metrics.perimeter.shape_index
module
firebench.ros_models.surface_for_urban
module
firebench.ros_models.surface_for_vegetation
module
firebench.stats.internal.fuel_models
module
firebench.stats.utils.hist
module
firebench.tools.check_data_quality
module
firebench.tools.fuel_models_utils
module
firebench.tools.input_info
module
firebench.tools.local_db_management
module
firebench.tools.logging_config
module
firebench.tools.namespace
module
firebench.tools.raster_to_perimeters
module
firebench.tools.read_data
module
firebench.tools.sensitivity_doe
module
firebench.tools.units
module
firebench.tools.utils
module
firebench.wind_interpolation.vertical_urban
module
firebench.wind_interpolation.wind_reduction_factor
module
FUEL_CHAPARRAL_FLAG (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_CLASS (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_COVER (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_DENSITY (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_DENSITY_BULK (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_DENSITY_DEAD (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_DENSITY_LIVE (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_FRACTION_CONSUMED_FLAME_ZONE (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_HEAT_CONTENT (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_HEIGHT (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_LOAD_DEAD_RATIO (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_LOAD_DRY_1000H (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_LOAD_DRY_100H (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_LOAD_DRY_10H (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_LOAD_DRY_1H (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_LOAD_DRY_LIVE (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_LOAD_DRY_LIVE_HERB (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_LOAD_DRY_LIVE_WOODY (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_LOAD_DRY_TOTAL (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_LOAD_FINE (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_LOAD_FINE_DEAD (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_LOAD_FINE_LIVE (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_MINERAL_CONTENT_EFFECTIVE (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_MINERAL_CONTENT_TOTAL (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_MOISTURE_CONTENT (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_MOISTURE_CONTENT_1000H (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_MOISTURE_CONTENT_100H (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_MOISTURE_CONTENT_10H (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_MOISTURE_CONTENT_1H (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_MOISTURE_CONTENT_DEAD (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_MOISTURE_CONTENT_ELEVATED_DEAD (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_MOISTURE_CONTENT_FINE_DEAD (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_MOISTURE_CONTENT_LIVE (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_MOISTURE_EXTINCTION (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_ROUGHNESS_HEIGHT (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_SFIREBURNUP_CONSUMPTION_CST (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_SURFACE_AREA_VOLUME_RATIO (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_SURFACE_AREA_VOLUME_RATIO_DEAD (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_SURFACE_AREA_VOLUME_RATIO_DEAD_1H (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_SURFACE_AREA_VOLUME_RATIO_LIVE (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_SURFACE_AREA_VOLUME_RATIO_LIVE_HERB (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_SURFACE_AREA_VOLUME_RATIO_LIVE_WOODY (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_TEMPERATURE_IGNITION (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_THERMAL_CONDUCTIVITY (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_TREE_CLASS (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_WIND_HEIGHT (firebench.tools.namespace.StandardVariableNames attribute)
FUEL_WIND_REDUCTION_FACTOR (firebench.tools.namespace.StandardVariableNames attribute)
G
generate_file_path_in_record() (in module firebench.tools.local_db_management)
get_file_path_in_record() (in module firebench.tools.local_db_management)
get_firebench_data_directory() (in module firebench.tools.read_data)
get_local_db_path() (in module firebench.tools.local_db_management)
get_logger() (in module firebench.tools.logging_config)
get_value_by_category() (in module firebench.tools.utils)
H
Hamada_1 (class in firebench.ros_models.surface_for_urban)
hamada_1() (firebench.ros_models.surface_for_urban.Hamada_1 static method)
Hamada_2 (class in firebench.ros_models.surface_for_urban)
hamada_2() (firebench.ros_models.surface_for_urban.Hamada_2 static method)
I
IGNITION_LENGTH (firebench.tools.namespace.StandardVariableNames attribute)
import_anderson_13_fuel_model() (in module firebench.tools.fuel_models_utils)
import_scott_burgan_40_fuel_model() (in module firebench.tools.fuel_models_utils)
import_wudapt_fuel_model() (in module firebench.tools.fuel_models_utils)
input (firebench.tools.input_info.ParameterType attribute)
is_scalar_quantity() (in module firebench.tools.utils)
J
jaccard_binary() (in module firebench.metrics.perimeter.shape_index)
jaccard_polygon() (in module firebench.metrics.perimeter.shape_index)
L
LATITUDE (firebench.tools.namespace.StandardVariableNames attribute)
LENGTH (firebench.tools.namespace.StandardVariableNames attribute)
LONGITUDE (firebench.tools.namespace.StandardVariableNames attribute)
M
MAGNITUDE (firebench.tools.namespace.StandardVariableNames attribute)
Masson_canyon() (in module firebench.wind_interpolation.vertical_urban)
merge_dictionaries() (in module firebench.tools.sensitivity_doe)
metadata (firebench.ros_models.surface_for_urban.Hamada_1 attribute)
(firebench.ros_models.surface_for_urban.Hamada_2 attribute)
(firebench.ros_models.surface_for_vegetation.Balbi_2022_fixed_SFIRE attribute)
(firebench.ros_models.surface_for_vegetation.Rothermel_SFIRE attribute)
(firebench.ros_models.surface_for_vegetation.Santoni_2011 attribute)
module
firebench.metrics.confusion_matrix.binary_performance
firebench.metrics.confusion_matrix.utils
firebench.metrics.perimeter.shape_index
firebench.ros_models.surface_for_urban
firebench.ros_models.surface_for_vegetation
firebench.stats.internal.fuel_models
firebench.stats.utils.hist
firebench.tools.check_data_quality
firebench.tools.fuel_models_utils
firebench.tools.input_info
firebench.tools.local_db_management
firebench.tools.logging_config
firebench.tools.namespace
firebench.tools.raster_to_perimeters
firebench.tools.read_data
firebench.tools.sensitivity_doe
firebench.tools.units
firebench.tools.utils
firebench.wind_interpolation.vertical_urban
firebench.wind_interpolation.wind_reduction_factor
N
NORMAL_SPREAD_DIR_X (firebench.tools.namespace.StandardVariableNames attribute)
NORMAL_SPREAD_DIR_Y (firebench.tools.namespace.StandardVariableNames attribute)
O
optional (firebench.tools.input_info.ParameterType attribute)
output (firebench.tools.input_info.ParameterType attribute)
P
ParameterType (class in firebench.tools.input_info)
R
RATE_OF_SPREAD (firebench.tools.namespace.StandardVariableNames attribute)
RAVG_CANOPY_COVER_LOSS (firebench.tools.namespace.StandardVariableNames attribute)
RAVG_COMPOSITE_BURN_INDEX_SEVERITY (firebench.tools.namespace.StandardVariableNames attribute)
RAVG_LIVE_BASAL_AREA_LOSS (firebench.tools.namespace.StandardVariableNames attribute)
read_data_file() (in module firebench.tools.read_data)
read_fuel_data_file() (in module firebench.tools.read_data)
RELATIVE_HUMIDITY (firebench.tools.namespace.StandardVariableNames attribute)
rothermel() (firebench.ros_models.surface_for_vegetation.Rothermel_SFIRE static method)
Rothermel_SFIRE (class in firebench.ros_models.surface_for_vegetation)
S
Santoni_2011 (class in firebench.ros_models.surface_for_vegetation)
santoni_2011() (firebench.ros_models.surface_for_vegetation.Santoni_2011 static method)
set_logging_level() (in module firebench.tools.logging_config)
SLOPE_ANGLE (firebench.tools.namespace.StandardVariableNames attribute)
sobol_seq() (in module firebench.tools.sensitivity_doe)
SOLAR_RADIATION (firebench.tools.namespace.StandardVariableNames attribute)
sorensen_dice_binary() (in module firebench.metrics.perimeter.shape_index)
sorensen_dice_polygon() (in module firebench.metrics.perimeter.shape_index)
StandardVariableNames (class in firebench.tools.namespace)
T
TEMPERATURE (firebench.tools.namespace.StandardVariableNames attribute)
TIME (firebench.tools.namespace.StandardVariableNames attribute)
U
update_date_in_markdown() (in module firebench.tools.local_db_management)
update_markdown_with_hashes() (in module firebench.tools.local_db_management)
V
verbosity_to_level() (in module firebench.tools.logging_config)
W
WIND_DIRECTION (firebench.tools.namespace.StandardVariableNames attribute)
WIND_GUST (firebench.tools.namespace.StandardVariableNames attribute)
WIND_SPEED (firebench.tools.namespace.StandardVariableNames attribute)
WIND_SPEED_U (firebench.tools.namespace.StandardVariableNames attribute)
WIND_SPEED_V (firebench.tools.namespace.StandardVariableNames attribute)
WIND_SPEED_W (firebench.tools.namespace.StandardVariableNames attribute)
X
X (firebench.tools.namespace.StandardVariableNames attribute)
Y
Y (firebench.tools.namespace.StandardVariableNames attribute)
Z
Z (firebench.tools.namespace.StandardVariableNames attribute)