Public Member Functions
	TransportModeNetworkFilter (final Network fullNetwork)

void	filter (final Network subNetwork, final Set< String > extractModes)

Private Attributes
final Network	fullNetwork

Detailed Description

This class extracts a subnetwork from a given network containing only those links where at least one of the given transport modes are allowed. The resulting network will not contain any links where none of the specified transport modes are allowed. In addition, all links in the resulting network will have at most those modes specified for the extraction, additional modes are removed from the allowed set for each link.
This class makes no guarantee that the resulting network is strongly connected, not even when the input network was strongly connected.

Author: mrieser

Definition at line 50 of file TransportModeNetworkFilter.java.

Constructor & Destructor Documentation

◆ TransportModeNetworkFilter()

org.matsim.core.network.algorithms.TransportModeNetworkFilter.TransportModeNetworkFilter ( final Network fullNetwork )

Definition at line 54 of file TransportModeNetworkFilter.java.

References org.matsim.core.network.algorithms.TransportModeNetworkFilter.fullNetwork.

                                                                  {
         this.fullNetwork = fullNetwork;
     }

Member Function Documentation

◆ filter()

void org.matsim.core.network.algorithms.TransportModeNetworkFilter.filter	(	final Network	subNetwork,
		final Set< String >	extractModes
	)

Extracts a subnetwork containing only links with the specified modes.

I had to extend this method in order to keep the nodes in the same order as in the input network. Otherwise, some router tests failed since for some from-to-pairs, multiple routes with the same costs were found. In that case, the outcome depends on the order of the nodes and links in the network. This problem might occur also in other places, therefore, I fixed it here. cdobler, sep'17

Time-varying networks did not copy time-dependent information. This functionality is included now. sebhoerl, aug'24

Parameters

subNetwork	the network object where to store the extracted subnetwork
extractModes	set of modes that should be contained in the subnetwork

Definition at line 74 of file TransportModeNetworkFilter.java.

Referenced by org.matsim.core.router.SingleModeNetworksCache.filterNetwork(), org.matsim.core.router.LinkToLinkRouting.get(), org.matsim.core.population.algorithms.PersonPrepareForSim.PersonPrepareForSim(), org.matsim.core.controler.PrepareForMobsimImpl.run(), and org.matsim.core.controler.PrepareForSimImpl.run().

                                                                                  {  
         NetworkFactory factory = subNetwork.getFactory();
 
         // first, clone all nodes to ensure their order is not changed
         for (Node node : this.fullNetwork.getNodes().values()) {
             Node newNode = factory.createNode(node.getId(), node.getCoord());
             AttributesUtils.copyAttributesFromTo(node, newNode);
             subNetwork.addNode(newNode);
         }
 
         // second, create clones of the links allowing the extracted modes
         IdSet<Node> nodesToInclude = new IdSet<>(Node.class);
         for (Link link : this.fullNetwork.getLinks().values()) {
             Set<String> intersection = new HashSet<>(extractModes);
             intersection.retainAll(link.getAllowedModes());
             if (intersection.size() > 0) {
                 Id<Node> fromId = link.getFromNode().getId();
                 Id<Node> toId = link.getToNode().getId();
                 Node fromNode2 = subNetwork.getNodes().get(fromId);
                 Node toNode2 = subNetwork.getNodes().get(toId);
                 nodesToInclude.add(fromId);
                 nodesToInclude.add(toId);
 
                 Link link2 = factory.createLink(link.getId(), fromNode2, toNode2);
                 link2.setAllowedModes(intersection);
                 link2.setCapacity(link.getCapacity());
                 link2.setFreespeed(link.getFreespeed());
                 link2.setLength(link.getLength());
                 link2.setNumberOfLanes(link.getNumberOfLanes());
                 NetworkUtils.setType(link2, NetworkUtils.getType(link));
                 AttributesUtils.copyAttributesFromTo(link, link2);
                 subNetwork.addLink(link2);
 
                 DisallowedNextLinks disallowedNextLinks = NetworkUtils.getDisallowedNextLinks(link);
                 if (disallowedNextLinks != null) {
                     NetworkUtils.setDisallowedNextLinks(link2, disallowedNextLinks.copyOnlyModes(extractModes));
                 }
             }
         }
         
         // third, remove all nodes that are not used by the valid links
         IdSet<Node> nodesToRemove = new IdSet<>(Node.class);
         for (Node node : this.fullNetwork.getNodes().values()) {
             if (!nodesToInclude.contains(node.getId())) nodesToRemove.add(node.getId());
         }
         for (Id<Node> nodeId : nodesToRemove) subNetwork.removeNode(nodeId);
         
         // fourth, recover the network change events
         if (fullNetwork instanceof TimeDependentNetwork) {
             TimeDependentNetwork fullTimeDependentNetwork = (TimeDependentNetwork) fullNetwork;
             
             if (fullTimeDependentNetwork.getNetworkChangeEvents().size() > 0) {
                 if (!(subNetwork instanceof TimeDependentNetwork)) {
                     throw new RuntimeException("Filtering time-dependent network with change events into a static network. Information on change events would be lost!");
                 } else {
                     TimeDependentNetwork timeDependentSubNetwork = (TimeDependentNetwork) subNetwork;
                     
                     for (NetworkChangeEvent event : fullTimeDependentNetwork.getNetworkChangeEvents()) {
                         NetworkChangeEvent subNetworkEvent = new NetworkChangeEvent(event.getStartTime());
                         
                         for (Link link : event.getLinks()) {
                             Link subNetworkLink = subNetwork.getLinks().get(link.getId());
                             
                             if (subNetworkLink != null) {
                                 subNetworkEvent.addLink(subNetworkLink);
                             }
                         }
                         
                         subNetworkEvent.setFlowCapacityChange(event.getFlowCapacityChange());
                         subNetworkEvent.setFreespeedChange(event.getFreespeedChange());
                         subNetworkEvent.setLanesChange(event.getLanesChange());
                         
                         if (subNetwork.getLinks().size() > 0) {
                             timeDependentSubNetwork.addNetworkChangeEvent(subNetworkEvent);
                         }
                     }
                 }
             }
         }
     }