NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
IRadarConversion Class Referenceabstract

Radar conversion component for bitmap generation from radar data. More...

#include <radar_conversion_interface.h>

Inherits ISDKProperties.

Public Member Functions

virtual SDKResult SDK_CALLTYPE SetRadarScanData (const RADAR_SCAN_DATA &radar_scan_data)=0 throw ()
 Set the radar scan data. More...
 
virtual SDKResult SDK_CALLTYPE SetRadarPosition (double lat, double lon)=0 throw ()
 Set the radar position. More...
 
virtual SDKResult SDK_CALLTYPE SetRadarParameters (double range, double dead_range=0, double antenna_azimuth=0, double range1=0, double antenna_azimuth2=IEEE754_2008::dbl_NaN())=0 throw ()
 Set the radar parameters. More...
 
SDKResult SetRadarScanDataAndPosition (const RADAR_SCAN_DATA &radar_scan_data, double lat, double lon, double range, double dead_range=0, double antenna_azimuth=0, double range1=0, double antenna_azimuth2=IEEE754_2008::dbl_NaN()) throw ()
 Set all the radar parameters. More...
 
SDKResult GenerateRadarImage (SDKUInt32 width, SDKUInt32 height, ::sdk::crs::IProjection *projection=NULL, const SDKMatrix3X2 &transformation_matrix=CMatrix3X2()) throw ()
 Generates the raster image corresponded to the RADAR_SCAN_DATA. More...
 
virtual SDKResult SDK_CALLTYPE GetRadarImage (IMAGE_PARAMETERS &image_params, SDKInt32 *radar_pos_x, SDKInt32 *radar_pos_y, SDKGeoPointRect *frame, SDKInt32 image_offset_x=0, SDKInt32 image_offset_y=0)=0 throw ()
 Returns the raster generated by GenerateRadarImage. More...
 

Detailed Description

Radar conversion component for bitmap generation from radar data.

Member Function Documentation

◆ SetRadarScanData()

virtual SDKResult SDK_CALLTYPE SetRadarScanData ( const RADAR_SCAN_DATA &  radar_scan_data)
throw (
)
pure virtual

Set the radar scan data.

Parameters
[in]radar_scan_dataThe radar scan data.

◆ SetRadarPosition()

virtual SDKResult SDK_CALLTYPE SetRadarPosition ( double  lat,
double  lon 
)
throw (
)
pure virtual

Set the radar position.

Parameters
[in]latThe radar position latitude, degrees
[in]lonThe radar position longitude, degrees

◆ SetRadarParameters()

virtual SDKResult SDK_CALLTYPE SetRadarParameters ( double  range,
double  dead_range = 0,
double  antenna_azimuth = 0,
double  range1 = 0,
double  antenna_azimuth2 = IEEE754_2008::dbl_NaN() 
)
throw (
)
pure virtual

Set the radar parameters.

Parameters
[in]rangeThe distance to the last radar pixel, nautical miles
[in]dead_rangeThe distance to the first visible radar pixel, nautical miles
[in]antenna_azimuthThe radar antenna (first sweep) azimuth, degrees
[in]range1The distance to the first radar pixel in a sweep; the radar scan represents an annulus, not a whole circle, nautical miles
[in]antenna_azimuth2The last sweep azimuth; if set the radar scan represents a sector, not a whole circle, degrees

◆ SetRadarScanDataAndPosition()

SDKResult SetRadarScanDataAndPosition ( const RADAR_SCAN_DATA &  radar_scan_data,
double  lat,
double  lon,
double  range,
double  dead_range = 0,
double  antenna_azimuth = 0,
double  range1 = 0,
double  antenna_azimuth2 = IEEE754_2008::dbl_NaN() 
)
throw (
)
inline

Set all the radar parameters.

Parameters
[in]radar_scan_dataThe radar scan data.
[in]latThe radar position latitude, degrees
[in]lonThe radar position longitude, degrees
[in]rangeThe distance to the last radar pixel, nautical miles
[in]dead_rangeThe distance to the first visible radar pixel, nautical miles
[in]antenna_azimuthThe radar antenna (first sweep) azimuth, degrees
[in]range1The distance to the first radar pixel in a sweep; the radar scan represents an annulus, not a whole circle, nautical miles
[in]antenna_azimuth2The last sweep azimuth; if set the radar scan represents a sector, not a whole circle, degrees

◆ GenerateRadarImage()

SDKResult GenerateRadarImage ( SDKUInt32  width,
SDKUInt32  height,
::sdk::crs::IProjection *  projection = NULL,
const SDKMatrix3X2 &  transformation_matrix = CMatrix3X2() 
)
throw (
)
inline

Generates the raster image corresponded to the RADAR_SCAN_DATA.

Parameters
[in]widthBitmap width
[in]heightBitmap height
[in]projectionThe projection.
[in]transformation_matrixThe matrix.

◆ GetRadarImage()

virtual SDKResult SDK_CALLTYPE GetRadarImage ( IMAGE_PARAMETERS &  image_params,
SDKInt32 *  radar_pos_x,
SDKInt32 *  radar_pos_y,
SDKGeoPointRect *  frame,
SDKInt32  image_offset_x = 0,
SDKInt32  image_offset_y = 0 
)
throw (
)
pure virtual

Returns the raster generated by GenerateRadarImage.

Parameters
[in,out]image_paramsThe address of a variable that receives the image parameters.
[out]radar_pos_xThe address of a variable that receives the x coordinate of a radar image center.
[out]radar_pos_yThe address of a variable that receives the y coordinate of a radar image center.
[out]frameThe address of a variable that receives the geographic coordinates of the minimal and maximal corners of the bitmap.
[in]image_offset_xThe image minimal corner X coordinate.
[in]image_offset_yThe image minimal corner Y coordinate. To get a rectangular part of the generated image the image_params.m_width and image_params.m_height fields have to are set to the appropriate values: {image_offset_x, image_offset_y, image_offset_x + image_params.m_width, image_offset_y + image_params.m_height}. If the image_params.m_data field is set to NULL on the method call on the bitmap size is calculated and returned in the image_params.m_data_size field. The image_params, image_offset_x and image_offset_y values should not to be changed before the next call on the method with the image_params.m_data field initialized by the pointer to a data buffer.

The documentation for this class was generated from the following file: