List Of Methods

This page describes the methods that should be used to access the data stored in the *.OPTTimeOfFlight file generated as an output of a LiDAR simulation.

As the *.OPTTimeOfFlight is a binary file, you must use specific methods to access its content and retrieve its data. Make sure to use the 3.10 version of IronPython or Python language to write your scripts.

Tip: Use script examples as a starting point. The provided scripts are directly compatible with Speos and contain all the methods described below.

Basic Functions

Name Description Syntax
OpenFile Opens the OPTTimeOfFlight file and loads its content

object.OpenFile(BSTR bstrFileName) as Boolean

  • Object: Raw Time Of Flight File Editor

  • bstrFileName: path and filename

    Should end by .OPTTimeOfFlight
GetNumberOfChannels Returns the number of channels (i.e. the sensor resolution)

object.GetNumberOfChannels() as Short

Object: Raw Time Of Flight File Editor

Axis system

Name Description Syntax
GetSourceOrigin Returns the (x, y, z) coordinate corresponding to the origin of the source

object.GetSourceOrigin() as Variant

Object: Raw Time Of Flight File Editor
GetSourceXDirection Returns the (x, y, z) vector corresponding to the X direction of the source

object.GetSourceXDirection() as Variant

Object: Raw Time Of Flight File Editor
GetSourceYDirection Returns the (x, y, z) vector corresponding to the Y direction of the source

object.GetSourceYDirection() as Variant

Object: Raw Time Of Flight File Editor
GetSensorOrigin Returns the (x, y, z) coordinate corresponding to the origin of the sensor

object.GetSensorOrigin() as Variant

Object: Raw Time Of Flight File Editor
GetSensorXDirection Returns the (x, y, z) vector corresponding to the X direction of the sensor

object.GetSensorXDirection() as Variant

Object: Raw Time Of Flight File Editor
GetSensorYDirection Returns the (x, y, z) vector corresponding to the Y direction of the sensor

object.GetSensorYDirection() as Variant

Object: Raw Time Of Flight File Editor
GetSystemOrigin Returns the (x, y, z) coordinate corresponding to the origin of the system

object.GetSystemOrigin() as Variant

Object: Raw Time Of Flight File Editor
GetSystemXDirection Returns the (x, y, z) vector corresponding to the X direction of the system

object.GetSystemXDirection() as Variant

Object: Raw Time Of Flight File Editor
GetSystemYDirection Returns the (x, y, z) vector corresponding to the Y direction of the system

object.GetSystemYDirection() as Variant

Object: Raw Time Of Flight File Editor

Operating range

Name Description Syntax
GetSensorMinRange Returns the minimum range of the sensor

object.GetSensorMinRange() as Double

Object: Raw Time Of Flight File Editor
GetSensorMaxRange Returns the maximum range of the sensor

object.GetSensorMaxRange() as Double

Object: Raw Time Of Flight File Editor
GetSensorAccuracy Returns the distance step between two energy measurements

object.GetSensorAccuracy() as Double

Object: Raw Time Of Flight File Editor

Sensor

Name Description Syntax
GetSensorFocal Returns the sensor's focal length (in mm)

object.GetSensorFocal() as Double

Object: Raw Time Of Flight File Editor
GetSensorPixelHorizontalSize Returns the horizontal size of pixel

object.GetSensorPixelHorizontalSize() as Double

Object: Raw Time Of Flight File Editor
GetSensorPixelVerticalSize Returns the vertical size of pixel

object.GetSensorPixelVerticalSize() as Double

Object: Raw Time Of Flight File Editor
GetSensorHorizontalPixels Returns the number of horizontal pixels

object.GetSensorHorizontalPixels() as Double

Object: Raw Time Of Flight File Editor
GetSensorVerticalPixels Returns the number of vertical pixels

object.GetSensorVerticalPixels() as Double

Object: Raw Time Of Flight File Editor
GetSensorPupilDiameter Returns the pupil diameter of the sensor

object.GetSensorPupilDiameter() as Double

Object: Raw Time Of Flight File Editor
GetDistortionObjectAngles Returns the object angle values from the distortion file

object.GetDistortionObjectAngles() as Double

object: Raw Time Of Flight File Editor object
GetDistortionImageAngles Returns the image angle from the distortion file

object.GetDistortionImageAngles() as Double

object: Raw Time Of Flight File Editor object

Raw Time Of Flight Data

Name Description Syntax
GetChannelPulseEnergy Returns the value of the pulse energy in Joules (J) object.GetChannelPulseEnergy(int iChannel) as Double
  • object: Raw Time Of Flight File Editor object
  • iChannel: index of the channel
GetChannelAzimuthAngle Returns the global azimuth angle of a channel in degrees (°) object.GetChannelAzimuthAngle(int iChannel) as Double
  • object: Raw Time Of Flight File Editor object
  • iChannel: index of the channel
GetChannelElevationAngle Returns the global elevation angle of a channel in degrees (°) object.GetChannelElevationAngle(int iChannel) as Double
  • object: Raw Time Of Flight File Editor object
  • iChannel: index of the channel
GetChannelLineOfSightDirection Returns the (x, y, z) vector corresponding to the line of sight direction of a channel object.GetChannelLineOfSightDirection(int iChannel) as Variant
  • object: Raw Time Of Flight File Editor object
  • iChannel: index of the channel
GetChannelTimeStamp Returns the time stamp of a channel object.GetChannelTimeStamp(int iChannel) as Double
  • object: Raw Time Of Flight File Editor object
  • iChannel: index of the channel
GetChannelTimeOfFlight Returns a table corresponding to the received energy during the time of flight for a channel in Watt (W) object.GetChannelTimeOfFlight(int iChannel, iPixel) as Variant
  • object: Raw Time Of Flight File Editor object
  • iChannel: index of the channel
  • iPixel: index of the pixel
GetChannelSensorOrigin Returns the (x, y, z) coordinates corresponding to the origin of the sensor at a channel timestamp object.GetChannelSensorOrigin(int iChannel) as Variant
  • object: Raw Time Of Flight File Editor object
  • iChannel: index of the channel
GetChannelSensorXDirection Returns the (x, y, z) vector corresponding to the X direction of the sensor at a channel timestamp object.GetChannelSensorXDirection (int iChannel) as Variant
  • object: Raw Time Of Flight File Editor object
  • iChannel: index of the channel
GetChannelSensorYDirection Returns the (x, y, z) vector corresponding to the Y direction of the sensor at a channel timestamp object.GetChannelSensorYDirection (int iChannel) as Variant
  • object: Raw Time Of Flight File Editor object
  • iChannel: index of the channel
GetChannelSourceOrigin Returns the (x, y, z) coordinates corresponding to the origin of the source at a channel timestamp object.GetChannelSourceOrigin (int iChannel) as Variant
  • object: Raw Time Of Flight File Editor object
  • iChannel: index of the channel
GetChannelSourceXDirection Returns the (x, y, z) vector corresponding to the X direction of the source at a channel timestamp object.GetChannelSourceXDirection (int iChannel) as Variant
  • object: Raw Time Of Flight File Editor object
  • iChannel: index of the channel
GetChannelSourceYDirection Returns the (x, y, z) vector corresponding to the Y direction of the source at a channel timestamp object.GetChannelSourceYDirection (int iChannel) as Variant
  • object: Raw Time Of Flight File Editor object
  • iChannel: index of the channel
GetChannelSystemOrigin Returns the (x, y, z) coordinates corresponding to the origin of the system at a channel timestamp object.GetChannelSystemOrigin (int iChannel) as Variant
  • object: Raw Time Of Flight File Editor object
  • iChannel: index of the channel
GetChannelSystemXDirection Returns the (x, y, z) vector corresponding to the X direction of the system at a channel timestamp object.GetChannelSystemXDirection (int iChannel) as Variant
  • object: Raw Time Of Flight File Editor object
  • iChannel: index of the channel
GetChannelSystemYDirection Returns the (x, y, z) vector corresponding to the Y direction of the system at a channel timestamp object.GetChannelSystemYDirection (int iChannel) as Variant
  • object: Raw Time Of Flight File Editor object
  • iChannel: index of the channel