finesse.solutions.beamtrace.PropagationSolution.position

PropagationSolution.position(point, ptype='geometric')

Gets the position of the specified point relative to the start node.

Parameters

pointOpticalNode or Port or Connector or str

The location in the path from which to obtain the relative position. This can be an optical node, a port, a connector or the name of a connector.

ptypestr

Type of distance, can be either ‘geometric’ or ‘optical’. In the former case the value returned is the distance from the start node to point as a sum of each space length. In the latter case the value returned will be the optical path length from the start node to point, i.e. a sum of each space length multiplied by its refractive index.

Returns

zfloat or symbol

The relative distance from the start node to the measured point.