FireSTARR
Loading...
Searching...
No Matches
fs::sim::TestEnvironment Class Reference

An Environment with no elevation and the same value in every Cell. More...

Inheritance diagram for fs::sim::TestEnvironment:
Collaboration diagram for fs::sim::TestEnvironment:

Public Member Functions

 TestEnvironment (const string dir_out, topo::CellGrid *cells) noexcept
 Environment with the same data in every cell.
 
- Public Member Functions inherited from fs::topo::Environment
unique_ptr< Coordinates > findCoordinates (const Point &point, bool flipped) const
 Determine Coordinates in the grid for the Point.
 
 Environment (Environment &&rhs) noexcept=default
 Move constructor.
 
 Environment (const Environment &rhs) noexcept=default
 Copy constructor.
 
Environmentoperator= (Environment &&rhs) noexcept=default
 Move assignment.
 
Environmentoperator= (const Environment &rhs) noexcept=default
 Copy assignment.
 
constexpr const string & proj4 () const
 UTM projection that this uses.
 
constexpr Idx rows () const
 Number of rows in grid.
 
constexpr Idx columns () const
 Number of columns in grid.
 
constexpr MathSize cellSize () const
 Cell width and height (m)
 
constexpr ElevationSize elevation () const
 Elevation of the origin Point.
 
Cell cell (const Idx row, const Idx column) const
 Cell at given row and column.
 
template<class P >
constexpr Cell cell (const Position< P > &position) const
 Cell at given Location.
 
Cell offset (const sim::Event &event, const Idx row, const Idx column) const
 Cell at Location with given hash.
 
sim::ProbabilityMapmakeProbabilityMap (DurationSize time, DurationSize start_time, int min_value, int low_max, int med_max, int max_value) const
 Make a ProbabilityMap that covers this Environment.
 
template<class Other >
unique_ptr< data::GridMap< Other > > makeMap (const Other nodata) const
 Create a GridMap<Other> covering this Environment.
 
unique_ptr< sim::BurnedData > makeBurnedData () const
 Create BurnedData and set burned bits based on Perimeter.
 
void resetBurnedData (sim::BurnedData *data) const noexcept
 Reset with known non-fuel cells.
 

Additional Inherited Members

- Static Public Member Functions inherited from fs::topo::Environment
static Environment loadEnvironment (const string dir_out, const string &path, const Point &point, const string &perimeter, int year)
 Load from rasters in folder that have same projection as Perimeter.
 
static Environment load (const string dir_out, const Point &point, const string &in_fuel, const string &in_elevation)
 Load from rasters.
 
- Protected Member Functions inherited from fs::topo::Environment
shared_ptr< sim::BurnedData > initializeNotBurnable (const CellGrid &cells) const
 Creates a map of areas that are not burnable either because of fuel or the initial perimeter.
 
 Environment (const string dir_out, CellGrid *cells, const ElevationSize elevation) noexcept
 Construct from cells and elevation.
 
 Environment (const string dir_out, const FuelGrid &fuel, const ElevationGrid &elevation, const Point &point)
 Load from rasters.
 
- Static Protected Member Functions inherited from fs::topo::Environment
static CellGridmakeCells (const FuelGrid &fuel, const ElevationGrid &elevation)
 Combine rasters into ConstantGrid<Cell, Topo>
 

Detailed Description

An Environment with no elevation and the same value in every Cell.

Constructor & Destructor Documentation

◆ TestEnvironment()

fs::sim::TestEnvironment::TestEnvironment ( const string dir_out,
topo::CellGrid * cells )
inlineexplicitnoexcept

Environment with the same data in every cell.

Parameters
dir_outFolder to save outputs to
cellsConstant cells

The documentation for this class was generated from the following file: