mrmeshpy.FlowAggregator Class Reference

Classes
class	Flows

Public Member Functions
None	__init__ (self, Mesh mesh, VertScalars heights)
None	__init__ (self, FlowAggregator arg0)
UndirectedEdgeBitSet	computeCatchmentDelineation (self)
VertScalars	computeFlow (self, std_vector_FlowOrigin starts, OutputFlows out='{}')
VertScalars	computeFlow (self, std_vector_MeshTriPoint starts, OutputFlows out='{}')
VertScalars	computeFlow (self, int numStarts, func_MeshTriPoint_from_unsigned_long_long startById, func_float_from_unsigned_long_long amountById, func_TaggedBitSet_FaceTag_const_from_unsigned_long_long regionById, OutputFlows out='{}')
phmap_flat_hash_map_Id_VertTag_FlowAggregator_Flows	computeFlowsPerBasin (self, std_vector_FlowOrigin starts)
phmap_flat_hash_map_Id_VertTag_FlowAggregator_Flows	computeFlowsPerBasin (self, std_vector_MeshTriPoint starts)
phmap_flat_hash_map_Id_VertTag_FlowAggregator_Flows	computeFlowsPerBasin (self, int numStarts, func_MeshTriPoint_from_unsigned_long_long startById, func_float_from_unsigned_long_long amountById)

Static Protected Member Functions
	_pybind11_conduit_v1_ (*args, **kwargs)

Detailed Description

Generated from:  MR::FlowAggregator

this class can track multiple flows and find in each mesh vertex the amount of water reached it

Constructor & Destructor Documentation

__init__() [1/2]

None mrmeshpy.FlowAggregator.__init__	(		self,
		Mesh	mesh,
		VertScalars	heights )

prepares the processing of given mesh with given height in each vertex

__init__() [2/2]

None mrmeshpy.FlowAggregator.__init__	(		self,
		FlowAggregator	arg0 )

Implicit copy constructor.

Member Function Documentation

_pybind11_conduit_v1_()

mrmeshpy.FlowAggregator._pybind11_conduit_v1_ ( * args, ** kwargs )

staticprotected

computeCatchmentDelineation()

UndirectedEdgeBitSet mrmeshpy.FlowAggregator.computeCatchmentDelineation

(

self

)

finds the edges on the mesh that divides catchment basin
(every triangle is attributed to the final destination point based on the path originated from its centroid)

computeFlow() [1/3]

VertScalars mrmeshpy.FlowAggregator.computeFlow	(		self,
		int	numStarts,
		func_MeshTriPoint_from_unsigned_long_long	startById,
		func_float_from_unsigned_long_long	amountById,
		func_TaggedBitSet_FaceTag_const_from_unsigned_long_long	regionById,
		OutputFlows	out = '{}' )

general version that supplies starts in a functional way

computeFlow() [2/3]

VertScalars mrmeshpy.FlowAggregator.computeFlow	(		self,
		std_vector_FlowOrigin	starts,
		OutputFlows	out = '{}' )

tracks multiple flows
\\param starts the origin of each flow (should be uniformly sampled over the terrain)
\\return the flow reached each mesh vertex

computeFlow() [3/3]

VertScalars mrmeshpy.FlowAggregator.computeFlow	(		self,
		std_vector_MeshTriPoint	starts,
		OutputFlows	out = '{}' )

same with all amounts equal to 1

computeFlowsPerBasin() [1/3]

phmap_flat_hash_map_Id_VertTag_FlowAggregator_Flows mrmeshpy.FlowAggregator.computeFlowsPerBasin	(		self,
		int	numStarts,
		func_MeshTriPoint_from_unsigned_long_long	startById,
		func_float_from_unsigned_long_long	amountById )

general version that supplies starts in a functional way

computeFlowsPerBasin() [2/3]

phmap_flat_hash_map_Id_VertTag_FlowAggregator_Flows mrmeshpy.FlowAggregator.computeFlowsPerBasin	(		self,
		std_vector_FlowOrigin	starts )

tracks multiple flows
\\param starts the origin of each flow (should be uniformly sampled over the terrain)
\\return the flows grouped by the final destination vertex

computeFlowsPerBasin() [3/3]

phmap_flat_hash_map_Id_VertTag_FlowAggregator_Flows mrmeshpy.FlowAggregator.computeFlowsPerBasin	(		self,
		std_vector_MeshTriPoint	starts )

same with all amounts equal to 1

---

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

• mrmeshpy.pyi