use std::cell::{Ref, RefCell}; use std::collections::HashMap; use std::rc::Rc; use crate::analyzer::AnalyzerType; use crate::error::OpossumError; use crate::light::Light; use crate::lightdata::LightData; use crate::nodes::NodeGroup; use crate::optic_node::{LightResult, OpticComponent, OpticNode}; use petgraph::algo::*; use petgraph::prelude::{DiGraph, EdgeIndex, NodeIndex}; use petgraph::visit::EdgeRef; use petgraph::Direction::Incoming; type Result<T> = std::result::Result<T, OpossumError>; /// Overall optical model and additional metatdata. /// /// All optical elements ([`OpticNode`]s) have to be added to this structure in order /// to be considered for an analysis. #[derive(Default, Debug, Clone)] pub struct OpticScenery { g: DiGraph<Rc<RefCell<OpticNode>>, Light>, description: String, } impl OpticScenery { /// Creates a new (empty) [`OpticScenery`]. pub fn new() -> Self { Self::default() } /// Add a given [`OpticNode`] to the graph of this [`OpticScenery`]. /// /// This command just adds an [`OpticNode`] to the graph. It does not connect /// it to existing nodes in the graph. The given optical element is consumed (owned) by the [`OpticScenery`]. pub fn add_node(&mut self, node: OpticNode) -> NodeIndex { self.g.add_node(Rc::new(RefCell::new(node))) } /// Add a given optical element to the graph of this [`OpticScenery`]. /// /// This command just adds an optical element (a struct implementing the [`Optical`](crate::optic_node::Optical) trait such as [`crate::nodes::Dummy`] ) to the graph. It does not connect /// it to existing nodes in the graph. The given optical element is consumed (owned) by the [`OpticScenery`]. Internally the corresponding [`OpticNode`] is /// automatically generated. It serves as a short-cut to the `add_node` function. pub fn add_element<T: OpticComponent + 'static>(&mut self, name: &str, t: T) -> NodeIndex { self.g .add_node(Rc::new(RefCell::new(OpticNode::new(name, t)))) } /// Connect (already existing) nodes denoted by the respective `NodeIndex`. /// /// Both node indices must exist. Otherwise an [`OpossumError::OpticScenery`] is returned. In addition, connections are /// rejected and an [`OpossumError::OpticScenery`] is returned, if the graph would form a cycle (loop in the graph). pub fn connect_nodes( &mut self, src_node: NodeIndex, src_port: &str, target_node: NodeIndex, target_port: &str, ) -> Result<EdgeIndex> { if let Some(source) = self.g.node_weight(src_node) { if !source.borrow().ports().outputs().contains(&src_port.into()) { return Err(OpossumError::OpticScenery(format!( "source node {} does not have a port {}", source.borrow().name(), src_port ))); } } else { return Err(OpossumError::OpticScenery( "source node with given index does not exist".into(), )); } if let Some(target) = self.g.node_weight(target_node) { if !target .borrow() .ports() .inputs() .contains(&target_port.into()) { return Err(OpossumError::OpticScenery(format!( "target node {} does not have a port {}", target.borrow().name(), target_port ))); } } else { return Err(OpossumError::OpticScenery( "target node with given index does not exist".into(), )); } if self.src_node_port_exists(src_node, src_port) { return Err(OpossumError::OpticScenery(format!( "src node with given port {} is already connected", src_port ))); } if self.target_node_port_exists(src_node, src_port) { return Err(OpossumError::OpticScenery(format!( "target node with given port {} is already connected", target_port ))); } let edge_index = self .g .add_edge(src_node, target_node, Light::new(src_port, target_port)); if is_cyclic_directed(&self.g) { self.g.remove_edge(edge_index); return Err(OpossumError::OpticScenery( "connecting the given nodes would form a loop".into(), )); } Ok(edge_index) } fn src_node_port_exists(&self, src_node: NodeIndex, src_port: &str) -> bool { self.g .edges_directed(src_node, petgraph::Direction::Outgoing) .any(|e| e.weight().src_port() == src_port) } fn target_node_port_exists(&self, target_node: NodeIndex, target_port: &str) -> bool { self.g .edges_directed(target_node, petgraph::Direction::Incoming) .any(|e| e.weight().target_port() == target_port) } /// Return a reference to the [`OpticNode`] specified by its node index. /// /// This function is mainly useful for setting up a reference node. /// /// # Errors /// /// This function will return [`OpossumError::OpticScenery`]if the node does not exist. pub fn node(&self, node: NodeIndex) -> Result<Rc<RefCell<OpticNode>>> { if let Some(node) = self.g.node_weight(node) { Ok(node.to_owned()) } else { Err(OpossumError::OpticScenery( "node index does not exist".into(), )) } } /// Returns the dot-file header of this [`OpticScenery`] graph. fn add_dot_header(&self) -> String { let mut dot_string = "digraph {\n\tfontsize = 8\n".to_owned(); dot_string.push_str("\tcompound = true;\n"); dot_string.push_str(&format!("\tlabel=\"{}\"\n", self.description)); dot_string.push_str("\tfontname=\"Helvetica,Arial,sans-serif\"\n"); dot_string.push_str("\tnode [fontname=\"Helvetica,Arial,sans-serif\" fontsize = 10]\n"); dot_string.push_str("\tedge [fontname=\"Helvetica,Arial,sans-serif\"]\n\n"); dot_string } fn cast_node_to_group<'a>(&self, ref_node: &'a Ref<'_, OpticNode>) -> Result<&'a NodeGroup> { let node_boxed = (&*ref_node).node(); let downcasted_node = node_boxed.downcast_ref::<NodeGroup>(); match downcasted_node { Some(i) => Ok(i), _ => Err(OpossumError::OpticScenery( "can not cast OpticNode to specific type of NodeGroup!".into(), )), } } fn check_if_group(&self, node_ref: &OpticNode) -> bool { if node_ref.node_type() == "group" { true } else { false } } fn create_node_edge_str( &self, end_node: NodeIndex, light_port: &str, mut parent_identifier: String, ) -> Result<String> { let node = self.g.node_weight(end_node).unwrap().borrow(); parent_identifier = if parent_identifier == "" { format!("i{}", end_node.index()) } else { format!("{}_i{}", &parent_identifier, end_node.index()) }; if self.check_if_group(&node) { let group_node: &NodeGroup = self.cast_node_to_group(&node)?; Ok(group_node.get_mapped_port_str(light_port, parent_identifier)?) } else { Ok(format!("i{}:{}", end_node.index(), light_port)) } } /// Export the optic graph, including ports, into the `dot` format to be used in combination with the [`graphviz`](https://graphviz.org/) software. pub fn to_dot(&self) -> Result<String> { let mut dot_string = self.add_dot_header(); for node_idx in self.g.node_indices() { let node = self.g.node_weight(node_idx).unwrap(); dot_string += &node .borrow() .to_dot(&format!("{}", node_idx.index()), "".to_owned())?; } for edge in self.g.edge_indices() { let light: &Light = self.g.edge_weight(edge).unwrap(); let end_nodes = self.g.edge_endpoints(edge).unwrap(); let src_edge_str = self.create_node_edge_str(end_nodes.0, light.src_port(), "".to_owned())?; let target_edge_str = self.create_node_edge_str(end_nodes.1, light.target_port(), "".to_owned())?; dot_string.push_str(&format!(" {} -> {} \n", src_edge_str, target_edge_str)); // for src in src_edge_str.iter(){ // println!("{}", src); // for target in target_edge_str.iter(){ // println!("{}", target); // dot_string.push_str(&format!(" {} -> {} \n", src, target)); // }; // }; } dot_string += "}"; Ok(dot_string) } /// Analyze this [`OpticScenery`] based on a given [`AnalyzerType`]. pub fn analyze(&mut self, analyzer_type: &AnalyzerType) -> Result<()> { let sorted = toposort(&self.g, None); if let Ok(sorted) = sorted { for idx in sorted { let node = self.g.node_weight(idx).unwrap(); let incoming_edges = self.incoming_edges(idx); let outgoing_edges = node.borrow_mut().analyze(incoming_edges, analyzer_type)?; for outgoing_edge in outgoing_edges { self.set_outgoing_edge_data(idx, outgoing_edge.0, outgoing_edge.1) } } Ok(()) } else { Err(OpossumError::OpticScenery( "Analyis: topological sort failed".into(), )) } } /// Sets the description of this [`OpticScenery`]. pub fn set_description(&mut self, description: &str) { self.description = description.into(); } /// Returns a reference to the description of this [`OpticScenery`]. pub fn description(&self) -> &str { self.description.as_ref() } /// Returns the nodes unordered of this [`OpticScenery`]. pub fn nodes_unordered(&self) -> Vec<NodeIndex> { self.g.node_indices().collect::<Vec<NodeIndex>>() } pub fn incoming_edges(&self, idx: NodeIndex) -> LightResult { let edges = self.g.edges_directed(idx, petgraph::Direction::Incoming); edges .into_iter() .map(|e| { ( e.weight().target_port().to_owned(), e.weight().data().cloned(), ) }) .collect::<HashMap<String, Option<LightData>>>() } fn set_outgoing_edge_data(&mut self, idx: NodeIndex, port: String, data: Option<LightData>) { let edges = self.g.edges_directed(idx, petgraph::Direction::Outgoing); let edge_ref = edges .into_iter() .filter(|idx| idx.weight().src_port() == port) .last(); if let Some(edge_ref) = edge_ref { let edge_idx = edge_ref.id(); let light = self.g.edge_weight_mut(edge_idx); if let Some(light) = light { light.set_data(data); } } // else outgoing edge not connected } pub fn report(&self) { let src_nodes = &self.g.externals(Incoming); let detector_nodes = self .g .node_weights() .filter(|node| node.borrow().is_detector()); println!("Sources:"); for idx in src_nodes.clone() { let node = self.node(idx).unwrap(); println!("{:?}", node.borrow()); node.borrow().export_data(); } println!("Detectors:"); for node in detector_nodes { println!("{:?}", node.borrow()); node.borrow().export_data(); } } } #[cfg(test)] mod test { use super::super::nodes::Dummy; use super::*; #[test] fn new() { let scenery = OpticScenery::new(); assert_eq!(scenery.description, "".to_owned()); assert_eq!(scenery.g.edge_count(), 0); assert_eq!(scenery.g.node_count(), 0); } #[test] fn add_node() { let mut scenery = OpticScenery::new(); scenery.add_node(OpticNode::new("Test", Dummy)); assert_eq!(scenery.g.node_count(), 1); } #[test] fn add_element() { let mut scenery = OpticScenery::new(); scenery.add_element("Test", Dummy); assert_eq!(scenery.g.node_count(), 1); } #[test] fn connect_nodes_ok() { let mut scenery = OpticScenery::new(); let n1 = scenery.add_element("Test", Dummy); let n2 = scenery.add_element("Test", Dummy); assert!(scenery.connect_nodes(n1, "rear", n2, "front").is_ok()); assert_eq!(scenery.g.edge_count(), 1); } #[test] fn connect_nodes_failure() { let mut scenery = OpticScenery::new(); let n1 = scenery.add_element("Test", Dummy); let n2 = scenery.add_element("Test", Dummy); assert!(scenery .connect_nodes(n1, "rear", NodeIndex::new(5), "front") .is_err()); assert!(scenery .connect_nodes(NodeIndex::new(5), "rear", n2, "front") .is_err()); } #[test] fn connect_nodes_loop_error() { let mut scenery = OpticScenery::new(); let n1 = scenery.add_element("Test", Dummy); let n2 = scenery.add_element("Test", Dummy); assert!(scenery.connect_nodes(n1, "rear", n2, "front").is_ok()); assert!(scenery.connect_nodes(n2, "rear", n1, "front").is_err()); assert_eq!(scenery.g.edge_count(), 1); } #[test] #[ignore] fn to_dot_empty() { let mut scenery = OpticScenery::new(); scenery.set_description("Test".into()); assert_eq!(scenery.to_dot().unwrap(), "digraph {\n label=\"Test\"\n fontname=\"Helvetica,Arial,sans-serif\"\n node [fontname=\"Helvetica,Arial,sans-serif\"]\n edge [fontname=\"Helvetica,Arial,sans-serif\"]\n}"); } #[test] #[ignore] fn to_dot_with_node() { let mut scenery = OpticScenery::new(); scenery.set_description("SceneryTest".into()); scenery.add_element("Test", Dummy); assert_eq!( scenery.to_dot().unwrap(), "digraph {\n label=\"SceneryTest\"\n fontname=\"Helvetica,Arial,sans-serif\"\n node [fontname=\"Helvetica,Arial,sans-serif\"]\n edge [fontname=\"Helvetica,Arial,sans-serif\"]\n i0 [label=\"Test\"]\n}" ); } #[test] #[ignore] fn to_dot_with_edge() { let mut scenery = OpticScenery::new(); scenery.set_description("SceneryTest".into()); let n1 = scenery.add_element("Test1", Dummy); let n2 = scenery.add_element("Test2", Dummy); if let Ok(_) = scenery.connect_nodes(n1, "rear", n2, "front") { assert_eq!( scenery.to_dot().unwrap(), "digraph {\n label=\"SceneryTest\"\n fontname=\"Helvetica,Arial,sans-serif\"\n node [fontname=\"Helvetica,Arial,sans-serif\"]\n edge [fontname=\"Helvetica,Arial,sans-serif\"]\n i0 [label=\"Test1\"]\n i1 [label=\"Test2\"]\n i0 -> i1 [label=\"rear->front\"]\n}" ); } else { assert!(false); } } #[test] fn set_description() { let mut scenery = OpticScenery::new(); scenery.set_description("Test".into()); assert_eq!(scenery.description, "Test") } #[test] fn description() { let mut scenery = OpticScenery::new(); scenery.set_description("Test".into()); assert_eq!(scenery.description(), "Test") } }