WsfImage Class Reference

#include <WsfImage.hpp>

Inherits UtScriptAccessible.

Classes
class	Object
	A nested class that represents the appearance of a single object (platform) in the image. More...

Public Types
using	ObjectList = std::vector<Object>
using	ObjectListIter = std::vector<Object>::iterator

Public Member Functions
	WsfImage ()=default
	WsfImage (WsfSensor *aOriginatingSensorPtr)
virtual	~WsfImage ()=default
virtual WsfImage *	Clone () const
const char *	GetScriptClassName () const override
double	GetMessageDataTag () const
	Get/Set the message data tag used for tagging the message.
void	SetMessageDataTag (double aMessageDataTag)
	Set the 'data Id' to be used when the track is attached to a message.
int	GetMessageLength () const
void	SetMessageLength (int aMessageLength)
void	GetOriginatorLocationWCS (double aOriginatorLocationWCS[3]) const
	Get/Set the location of the sensor.
void	SetOriginatorLocationWCS (const double aOriginatorLocationWCS[3])
void	GetCenterLocationWCS (double aCenterLocationWCS[3]) const
	Get/Set the approximate location of the center of the image.
void	SetCenterLocationWCS (const double aCenterLocationWCS[3])
double	GetImageTime () const
	Get/Set the simulation when time the image was taken.
void	SetImageTime (double aImageTime)
unsigned int	GetImageNumber () const
void	SetImageNumber (unsigned int aImageNumber)
unsigned int	GetStreamNumber () const
void	SetStreamNumber (unsigned int aStreamNumber)
size_t	GetPlatformIndex () const
	Get the platform index of the platform that contains the reporting sensor.
WsfStringId	GetPlatformNameId () const
	Get the name (ID) of the platform with the sensor that produced this image.
WsfStringId	GetPlatformTypeId () const
	Get the type (ID) of the platform with the sensor that produced this image.
WsfStringId	GetSensorNameId () const
	Get the name (ID) of the sensor that produced this image.
WsfStringId	GetSensorTypeId () const
	Get the type (ID) of the sensor that produced this image.
WsfStringId	GetSensorModeId () const
	Get the name (ID) of the mode of the sensor that was active when this image was produced.
double	GetFrameTime () const
void	SetFrameTime (double aFrameTime)
double	GetWidth () const
	Get/Set the width of the image (pixels).
void	SetWidth (double aWidth)
double	GetHeight () const
	Get/Set the height of the image (pixels).
void	SetHeight (double aHeight)
double	GetWidthResolution () const
	Get/Set the width resolution of a pixel (m).
void	SetWidthResolution (double aWidthResolution)
double	GetHeightResolution () const
	Get/Set the height resolution of a pixel (m).
void	SetHeightResolution (double aHeightResolution)
double	GetNoiseLevel () const
	Get/Set the noise signal level.
void	SetNoiseLevel (double aNoiseLevel)
double	GetBackgroundLevel () const
void	SetBackgroundLevel (double aBackgroundLevel)
double	GetMinimumLevel () const
	Get/Set the signal value corresponding to a pixel intensity of 0.0.
void	SetMinimumLevel (double aMinimumLevel)
double	GetMaximumLevel () const
	Get/Set the signal value corresponding to a pixel intensity of 1.0.
void	SetMaximumLevel (double aMaximumLevel)

Static Public Member Functions
static std::unique_ptr< UtScriptClass >	CreateScriptClass (const std::string &aClassName, UtScriptTypes *aScriptTypesPtr)

Methods for storing or retrieve objects in the image.
void	AddObject (Object &aObject)
	Add an object to list of those contained in the image.
const ObjectList &	GetObjects () const
	Get the list of objects contained in the image.

Methods for sensor measurement errors
double	GetRangeError () const
	Get the standard deviation of the error in the range measurement.
void	SetRangeError (double aRangeError)
	Set the standard deviation of the error in the range measurement.
double	GetBearingError () const
	Get the standard deviation of the error in the bearing measurement.
void	SetBearingError (double aBearingError)
	Set the standard deviation of the error in the bearing measurement.
double	GetElevationError () const
	Get the standard deviation of the error in the elevation measurement.
void	SetElevationError (double aElevationError)
	Set the standard deviation of the error in the elevation measurement.
double	GetRangeRateError () const
	Get the standard deviation of the error in the range rate measurement.
void	SetRangeRateError (double aRangeRateError)
	Set the standard deviation of the error in the range rate measurement.

Methods for the 'collection factor' attribute.
The 'collection factor' is typically only used by the SAR sensor, and reflects the achieved quality (resolution) compared to what was requested. For non-SAR sensors this value will be For SAR sensors it will be the ratio of the desired azimuth resolution over the actual azimuth resolution.
double	GetCollectionFactor () const
	Get the collection factor.
void	SetCollectionFactor (double aCollectionFactor)
	Set the collection factor.

Methods for 'track quality' stored in the mode of the sensor that produced the image.
double	GetTrackQuality () const
	Get the track quality from the mode of the sensor that produced the image.
void	SetTrackQuality (double aTrackQuality)
	Set the track quality from the mode of the sensor that produced the image.

Detailed Description

An object that represents an 'image' (picture) from a sensor.

The creator/maintainer of a image should create an instance of the image using the proper constructor to identify its source source.

Member Typedef Documentation

ObjectList

using WsfImage::ObjectList = std::vector<Object>

ObjectListIter

using WsfImage::ObjectListIter = std::vector<Object>::iterator

Constructor & Destructor Documentation

WsfImage() [1/2]

WsfImage::WsfImage ( )

default

References WsfImage().

Referenced by Clone(), WsfImage(), and ~WsfImage().

WsfImage() [2/2]

WsfImage::WsfImage

(

WsfSensor *

aOriginatingSensorPtr

)

References WsfPlatformPart::GetPlatform().

~WsfImage()

virtual WsfImage::~WsfImage ( )

virtualdefault

References Clone(), and WsfImage().

Member Function Documentation

AddObject()

void WsfImage::AddObject ( Object & aObject )

inline

Add an object to list of those contained in the image.

Referenced by WsfBeamDirector::WsfBeamDirectorMode::CreateImageFromResult(), and WsfEOIR_Sensor::Update().

Clone()

WsfImage * WsfImage::Clone ( ) const

virtual

References WsfImage().

Referenced by ~WsfImage().

CreateScriptClass()

std::unique_ptr< UtScriptClass > WsfImage::CreateScriptClass ( const std::string & aClassName, UtScriptTypes * aScriptTypesPtr )

static

Create the 'class' object for the script system. This is invoked once by WsfScriptManager to create the 'class' object that defines the interface to instances of this class from the script system.

Referenced by WsfScriptManager::RegisterTypes().

GetBackgroundLevel()

double WsfImage::GetBackgroundLevel ( ) const

inline

Get/Set the background signal level. For a SAR sensor this would be the clutter (CNR * N)

GetBearingError()

double WsfImage::GetBearingError ( ) const

inline

Get the standard deviation of the error in the bearing measurement.

GetCenterLocationWCS()

void WsfImage::GetCenterLocationWCS

(

double

aCenterLocationWCS[3]

)

const

Get/Set the approximate location of the center of the image.

GetCollectionFactor()

double WsfImage::GetCollectionFactor ( ) const

inline

Get the collection factor.

GetElevationError()

double WsfImage::GetElevationError ( ) const

inline

Get the standard deviation of the error in the elevation measurement.

GetFrameTime()

double WsfImage::GetFrameTime ( ) const

inline

Get/Set the frame time for an image stream. The frame time is zero for static images.

GetHeight()

double WsfImage::GetHeight ( ) const

inline

Get/Set the height of the image (pixels).

GetHeightResolution()

double WsfImage::GetHeightResolution ( ) const

inline

Get/Set the height resolution of a pixel (m).

GetImageNumber()

unsigned int WsfImage::GetImageNumber ( ) const

inline

Get/Set the image number of image within a stream of images. For a still image (photograph, SAR image, etc) this will be 0. For a video stream, the first frame will be 1 and will be incremented for each subsequent frame.

Note

It is the zero/non-zero value that denotes if this image is a still or a frame within a video stream.

GetImageTime()

double WsfImage::GetImageTime ( ) const

inline

Get/Set the simulation when time the image was taken.

GetMaximumLevel()

double WsfImage::GetMaximumLevel ( ) const

inline

Get/Set the signal value corresponding to a pixel intensity of 1.0.

GetMessageDataTag()

double WsfImage::GetMessageDataTag ( ) const

inline

Get/Set the message data tag used for tagging the message.

GetMessageLength()

int WsfImage::GetMessageLength ( ) const

inline

Get/Set the declared message length (in bits) to be used when sending this image over the communications network.

Note

This is NOT the physical length of this object as it contains just about everything that any sensor would want to send. The length used by these methods should be the 'logical' length that a real-life communications message would have reporting a image from this sensor.

GetMinimumLevel()

double WsfImage::GetMinimumLevel ( ) const

inline

Get/Set the signal value corresponding to a pixel intensity of 0.0.

GetNoiseLevel()

double WsfImage::GetNoiseLevel ( ) const

inline

Get/Set the noise signal level.

Referenced by WsfEOIR_Sensor::Update(), and WsfImageProcessor::UpdateTrack().

GetObjects()

const ObjectList & WsfImage::GetObjects ( ) const

inline

Get the list of objects contained in the image.

GetOriginatorLocationWCS()

void WsfImage::GetOriginatorLocationWCS

(

double

aOriginatorLocationWCS[3]

)

const

Get/Set the location of the sensor.

GetPlatformIndex()

size_t WsfImage::GetPlatformIndex ( ) const

inline

Get the platform index of the platform that contains the reporting sensor.

GetPlatformNameId()

WsfStringId WsfImage::GetPlatformNameId ( ) const

inline

Get the name (ID) of the platform with the sensor that produced this image.

GetPlatformTypeId()

WsfStringId WsfImage::GetPlatformTypeId ( ) const

inline

Get the type (ID) of the platform with the sensor that produced this image.

GetRangeError()

double WsfImage::GetRangeError ( ) const

inline

Get the standard deviation of the error in the range measurement.

GetRangeRateError()

double WsfImage::GetRangeRateError ( ) const

inline

Get the standard deviation of the error in the range rate measurement.

GetScriptClassName()

const char * WsfImage::GetScriptClassName ( ) const

inlineoverride

GetSensorModeId()

WsfStringId WsfImage::GetSensorModeId ( ) const

inline

Get the name (ID) of the mode of the sensor that was active when this image was produced.

GetSensorNameId()

WsfStringId WsfImage::GetSensorNameId ( ) const

inline

Get the name (ID) of the sensor that produced this image.

GetSensorTypeId()

WsfStringId WsfImage::GetSensorTypeId ( ) const

inline

Get the type (ID) of the sensor that produced this image.

GetStreamNumber()

unsigned int WsfImage::GetStreamNumber ( ) const

inline

Get/Set the stream number of which the image is a part. This number in incremented each time the producing sensor is turned-on.

GetTrackQuality()

double WsfImage::GetTrackQuality ( ) const

inline

Get the track quality from the mode of the sensor that produced the image.

GetWidth()

double WsfImage::GetWidth ( ) const

inline

Get/Set the width of the image (pixels).

GetWidthResolution()

double WsfImage::GetWidthResolution ( ) const

inline

Get/Set the width resolution of a pixel (m).

SetBackgroundLevel()

void WsfImage::SetBackgroundLevel ( double aBackgroundLevel )

inline

SetBearingError()

void WsfImage::SetBearingError ( double aBearingError )

inline

Set the standard deviation of the error in the bearing measurement.

Referenced by WsfEOIR_Sensor::Update().

SetCenterLocationWCS()

void WsfImage::SetCenterLocationWCS

(

const double

aCenterLocationWCS[3]

)

Referenced by WsfEOIR_Sensor::Update().

SetCollectionFactor()

void WsfImage::SetCollectionFactor ( double aCollectionFactor )

inline

Set the collection factor.

SetElevationError()

void WsfImage::SetElevationError ( double aElevationError )

inline

Set the standard deviation of the error in the elevation measurement.

Referenced by WsfEOIR_Sensor::Update().

SetFrameTime()

void WsfImage::SetFrameTime ( double aFrameTime )

inline

Referenced by WsfEOIR_Sensor::Update().

SetHeight()

void WsfImage::SetHeight ( double aHeight )

inline

Referenced by WsfEOIR_Sensor::Update().

SetHeightResolution()

void WsfImage::SetHeightResolution ( double aHeightResolution )

inline

Referenced by WsfEOIR_Sensor::Update().

SetImageNumber()

void WsfImage::SetImageNumber ( unsigned int aImageNumber )

inline

Referenced by WsfBeamDirector::WsfBeamDirectorMode::CreateImageFromResult(), and WsfEOIR_Sensor::Update().

SetImageTime()

void WsfImage::SetImageTime ( double aImageTime )

inline

Referenced by WsfBeamDirector::WsfBeamDirectorMode::CreateImageFromResult(), and WsfEOIR_Sensor::Update().

SetMaximumLevel()

void WsfImage::SetMaximumLevel ( double aMaximumLevel )

inline

SetMessageDataTag()

void WsfImage::SetMessageDataTag ( double aMessageDataTag )

inline

Set the 'data Id' to be used when the track is attached to a message.

Referenced by WsfEOIR_Sensor::Update().

SetMessageLength()

void WsfImage::SetMessageLength ( int aMessageLength )

inline

Referenced by WsfEOIR_Sensor::Update().

SetMinimumLevel()

void WsfImage::SetMinimumLevel ( double aMinimumLevel )

inline

SetNoiseLevel()

void WsfImage::SetNoiseLevel ( double aNoiseLevel )

inline

Referenced by WsfEOIR_Sensor::Update().

SetOriginatorLocationWCS()

void WsfImage::SetOriginatorLocationWCS

(

const double

aOriginatorLocationWCS[3]

)

Referenced by WsfEOIR_Sensor::Update().

SetRangeError()

void WsfImage::SetRangeError ( double aRangeError )

inline

Set the standard deviation of the error in the range measurement.

Referenced by WsfEOIR_Sensor::Update().

SetRangeRateError()

void WsfImage::SetRangeRateError ( double aRangeRateError )

inline

Set the standard deviation of the error in the range rate measurement.

Referenced by WsfEOIR_Sensor::Update().

SetStreamNumber()

void WsfImage::SetStreamNumber ( unsigned int aStreamNumber )

inline

Referenced by WsfEOIR_Sensor::Update().

SetTrackQuality()

void WsfImage::SetTrackQuality ( double aTrackQuality )

inline

Set the track quality from the mode of the sensor that produced the image.

Referenced by WsfEOIR_Sensor::Update().

SetWidth()

void WsfImage::SetWidth ( double aWidth )

inline

Referenced by WsfEOIR_Sensor::Update().

SetWidthResolution()

void WsfImage::SetWidthResolution ( double aWidthResolution )

inline

Referenced by WsfEOIR_Sensor::Update().

---

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

• WsfImage.hpp
• WsfImage.cpp