FlowEngine::OrthophotoInterface Class Reference

#include <OrthophotoInterface.h>

Public Member Functions
virtual FLE_DLL Result	getDSMData (Buffer< ColorComponent32 > outData) const =0
virtual FLE_DLL Result	getOrthophotoData (Buffer< PointColor32 > outData) const =0
virtual FLE_DLL void	getOrthophotoDimensions (int &outWidth, int &outHeight) const =0
virtual FLE_DLL Result	saveDSMToFile (ConstStringBuffer filePath, const ProjectedCoordinateSystemInterface *projection=nullptr, float dpi=96.0f) const =0
virtual FLE_DLL Result	saveDSMToFile (ConstStringBuffer filePath, ConstStringBuffer inProjCSWtk) const =0
virtual FLE_DLL Result	saveOrthophotoToFile (ConstStringBuffer filePath, const ProjectedCoordinateSystemInterface *projection=nullptr, float dpi=96.0f) const =0
virtual FLE_DLL Result	saveOrthophotoToFile (ConstStringBuffer filePath, ConstStringBuffer inProjCSWtk) const =0
virtual FLE_DLL	~OrthophotoInterface ()=default

Detailed Description

Hold an Orthophoto object.

Use FlowEngine to generate an orthophoto from a point cloud or a mesh. You can save the orthophoto to geotiff.

Constructor & Destructor Documentation

~OrthophotoInterface()

virtual FLE_DLL FlowEngine::OrthophotoInterface::~OrthophotoInterface ( )

virtualdefault

Default virtual destructor.

Member Function Documentation

getDSMData()

virtual FLE_DLL Result FlowEngine::OrthophotoInterface::getDSMData ( Buffer< ColorComponent32 >  outData ) const

pure virtual

Copy DSM data. DSM data is represented by a single floating value per image location.

Parameters

[in,out]

outData

a buffer of values big enough to store the entire orthophoto data (i.e.: width * height elements).

Returns

One of the following result codes:

• Result::Success – if the data was successfully copied in outData.
• Result::InvalidArgument – if outData is not a valid buffer.
• Result::BufferTooSmall – if outData is not big enough to receive the entire orthophoto dsm data.
• Result::FeatureNotAvailable – if this method was invoked by the free version of the SDK.

Note

This function is not available in the free version of the SDK.

getOrthophotoData()

virtual FLE_DLL Result FlowEngine::OrthophotoInterface::getOrthophotoData ( Buffer< PointColor32 >  outData ) const

pure virtual

Copies the orthophoto data.

Parameters

[in,out]

outData

a buffer of PackedColor (rgb) elements big enough to store the entire orthophoto data (i.e.: width * height elements).

Returns

One of the following result codes:

• Result::Success – if the data was successfully copied in outData.
• Result::InvalidArgument – if outData is not a valid buffer.
• Result::BufferTooSmall – if outData is not big enough to receive the entire orthophoto color data.
• Result::FeatureNotAvailable – if this method was invoked by the free version of the SDK.

Note

This function is not available in the free version of the SDK.

getOrthophotoDimensions()

virtual FLE_DLL void FlowEngine::OrthophotoInterface::getOrthophotoDimensions ( int &  outWidth, int &  outHeight  ) const

pure virtual

Returns the orthophoto dimensions.

Parameters

[out]	outWidth	the width of the orthophoto in pixels.
[out]	outHeight	the height of the orthophoto in pixels.

saveDSMToFile() [1/2]

virtual FLE_DLL Result FlowEngine::OrthophotoInterface::saveDSMToFile ( ConstStringBuffer  filePath, const ProjectedCoordinateSystemInterface *  projection = nullptr, float  dpi = 96.0f  ) const

pure virtual

Save the dsm to a geotiff file. Stores the coordinate system if set. If the specified transform or projected system is not valid, the dsm won't be saved with georeferecing information.

Parameters

[in]	filePath	an UTF-8 encoded string where to save the dsm.
[in]	projection	(optional) the projected coordinate system to use for the dsm.
[in]	dpi	(optional) the resolution of the dsm in dots per inch. Must be greater than 0.

Returns

One of the following result codes:

• Result::Success – if the data was successfully copied in outData.
• Result::InvalidArgument –
  • if filePath is not a valid string buffer.
  • if projection is specified but it's not a valid projected coordinate system.
  • if dpi is less than or equal to 0.
• Result::FeatureNotAvailable – if this method was invoked by the free version of the SDK.

Note

This function is not available in the free version of the SDK.

saveDSMToFile() [2/2]

virtual FLE_DLL Result FlowEngine::OrthophotoInterface::saveDSMToFile ( ConstStringBuffer  filePath, ConstStringBuffer  inProjCSWtk  ) const

pure virtual

Save the orthophoto to a geotiff file. Stores the coordinate system if set. If the specified transform or projected system is not valid, the orthophoto won't be saved with georeferecing information.

Parameters

[in]	filePath	an UTF-8 encoded string where to save the orthophoto.
[in]	inProjCSWtk	buffer that stores the UTF-8 encoded projected system in wtk format.

Returns

One of the following result codes:

• Result::Success – if the data was successfully copied in outData.
• Result::InvalidArgument –
  • if filePath is not a valid string buffer.
  • if inProjCSWtk is not a valid string buffer.
• Result::FeatureNotAvailable – if this method was invoked by the free version of the SDK.

Note

This function is not available in the free version of the SDK.

saveOrthophotoToFile() [1/2]

virtual FLE_DLL Result FlowEngine::OrthophotoInterface::saveOrthophotoToFile ( ConstStringBuffer  filePath, const ProjectedCoordinateSystemInterface *  projection = nullptr, float  dpi = 96.0f  ) const

pure virtual

Save the orthophoto to a geotiff file. Stores the coordinate system if set. If the specified transform or projected system is not valid, the orthophoto won't be saved with georeferecing information.

Parameters

[in]	filePath	an UTF-8 encoded string where to save the orthophoto.
[in]	projection	(optional) the projected coordinate system to use for the orthophoto.
[in]	dpi	(optional) the resolution of the orthophoto in dots per inch. Must be greater than 0.

Returns

One of the following result codes:

• Result::Success – if the orthophoto was successfully saved to filePath.
• Result::InvalidArgument –
  • if filePath is not a valid string buffer.
  • if projection is specified but it's not a valid projected coordinate system.
  • if dpi is less than or equal to 0.
• Result::FeatureNotAvailable – if this method was invoked by the free version of the SDK.

Note

This function is not available in the free version of the SDK.

saveOrthophotoToFile() [2/2]

virtual FLE_DLL Result FlowEngine::OrthophotoInterface::saveOrthophotoToFile ( ConstStringBuffer  filePath, ConstStringBuffer  inProjCSWtk  ) const

pure virtual

Save the orthophoto to a geotiff file. Stores the coordinate system if set. If the specified transform or projected system is not valid, the orthophoto won't be saved with georeferecing information.

Parameters

[in]	filePath	an UTF-8 encoded string where to save the orthophoto.
[in]	inProjCSWtk	buffer that stores the UTF-8 encoded projection system in wtk format.

Returns

One of the following result codes:

• Result::Success – if the orthophoto was successfully saved to filePath.
• Result::InvalidArgument –
  • if filePath is not a valid string buffer.
  • if inProjCSWtk is not a valid string buffer or is not a valid projection method.
• Result::FeatureNotAvailable – if this method was invoked by the free version of the SDK.

Note

This function is not available in the free version of the SDK.