finesse.knm.maps.Map.remove_piston

Map.remove_piston(self, float spot_size: float = None)

Removes any piston term from the optical path difference data. This corresponds to removing a constant term averaged over the spotsize.

Note this will only operate on data stored in the .opd attribute. If the OPD data is determined using a custom function then this method will not work. Instead, you can specify the map to auto-remove any tilts which ensures this method is called after any update to the map is made during the simulation.

Parameters

spot_sizefloat, optional

spot size to use for weighting. If None then a full area average is done.

Returns

pistonfloat

Removed piston term