rfxImageMessage.h

Go to the documentation of this file.

// ******************************************************************************
// ** Copyright (c) 2025 MAK Technologies
// ** All rights reserved.
// ******************************************************************************
 
//! \file rfxImageMessage.h
//! \brief Defines common base classes and types for all radar image messages
//! \ingroup vreRadarFxShared
//!
//! This file contains common enumerations, structures, and base classes used by
//! all radar image request and response messages such as SAR, ISAR, and MMW.
 
#pragma once
 
#include "export.h"
#include "rfxMessage.h"
 
#include <matrix/vlVector.h>
#include <matrix/vlTaitBryan.h>
 
#include <string>
 
namespace makRadarFx
{
//! \brief Image format enumeration for radar images
//!
//! Defines the supported output formats for radar images generated by the server
enum DtImageFormat
{
   RAW,    //!< Raw uncompressed image data
   BMP,    //!< Windows Bitmap format
   JPG,    //!< JPEG compressed format
   PNG,    //!< PNG compressed format
   NITF,   //!< National Imagery Transmission Format
   RAW_RG, //!< Raw Range/Doppler image data
   GTIF    //!< GeoTIFF format
};
 
//! \brief Image orientation enumeration
//!
//! Defines how the radar image should be oriented
enum DtImageRotation
{
   NORTH_UP, //!< Image is oriented with north at the top
   TRACK_UP  //!< Image is oriented with the platform track direction at the top
};
 
//! \brief Image delivery method enumeration
//!
//! Defines how the image data should be returned to the client
enum DtImageReturnMethod
{
   STREAM = 0x1,    //!< Return image data directly in the response message
   FILESYSTEM = 0x2 //!< Save image to a file and return the file path
};
 
//! \brief Image data type enumeration
//!
//! Defines the pixel data type used in raw image formats
enum DtImageDataType
{
   BYTE,  //!< 8-bit unsigned integer
   SHORT, //!< 16-bit signed integer
   FLOAT  //!< 32-bit floating point
};
 
//! \brief Image dimensions structure
//!
//! Defines the width and height of a radar image in pixels
struct RFX_DLL_SHARED DtImageSize
{
   //! \brief Default constructor
   //!
   //! Initializes with default size of 512x512 pixels
   DtImageSize()
   {
      x = 512;
      y = 512;
   }
 
   //! \brief Constructor with specific dimensions
   //! \param imgX Image width in pixels
   //! \param imgY Image height in pixels
   DtImageSize(int imgX, int imgY)
   {
      x = imgX;
      y = imgY;
   }
 
   //! \brief Image width in pixels
   int x;
 
   //! \brief Image height in pixels
   int y;
};
 
//! \brief Base class for all radar image requests
//!
//! This abstract base class defines the common interface for all radar image
//! request messages. Specific radar image types (SAR, ISAR, MMW) derive from
//! this class and add their specific parameters.
class RFX_DLL_SHARED DtImageRequest : public DtBaseMessage
{
public:
   //! \brief Default constructor
   //!
   //! Initializes a new base image request message
   DtImageRequest();
 
   //! \brief Virtual destructor
   virtual ~DtImageRequest();
};
 
 
//! \brief Error codes for radar image responses
//!
//! Defines the possible error conditions that can occur when generating radar images
enum DtImageError
{
   IMAGE_NO_ERROR,       //!< No error, image was generated successfully
   FAILED_RENDER,        //!< Failed to render the image
   FAILED_FILESAVE,      //!< Failed to save the image to file (when using FILESYSTEM return method)
   FAILED_ENTITY_LOOKUP, //!< Failed to find the specified entity
   FAILED_OTHER          //!< Other unspecified error
};
 
//! \brief Warning codes for radar image responses
//!
//! Defines the possible warning conditions that can occur when generating radar images
enum DtImageWarning
{
   NO_WARNING,             //!< No warnings
   WARNING_TERRAIN_TIMEOUT //!< Terrain data loading timed out, partial data used
};
 
//! \brief Base class for all radar image responses
//!
//! This abstract base class defines the common interface for all radar image
//! response messages. Specific radar image types (SAR, ISAR, MMW) derive from
//! this class and add their specific data.
//!
//! Image responses typically contain the image data, file path (if saved to disk),
//! error and warning codes, and metadata about the image.
class RFX_DLL_SHARED DtImageResponse : public DtBaseMessage
{
public:
   //! \brief Default constructor
   //!
   //! Initializes a new base image response message
   DtImageResponse();
 
   //! \brief Virtual destructor
   virtual ~DtImageResponse();
};
} // namespace makRadarFx