ciSensor Class Reference

Classes
struct	structSensorData

Public Types
enum	SensorType { DEFAULT = 0, IR = 1, NVG = 2, RADAR = 3 }

Public Member Functions
bool	archive (std::ofstream &outf)
int	serialize (char *filepath)
bool	loadXML (clXMLNode *childNode)
bool	parseXML (clXML &xmlDocument)
bool	loadXMLNode (std::string tag, char *nodeString)
bool	loadXMLNode (std::string tag, bool *nodeBool)
bool	loadXMLNode (std::string tag, int *nodeBool)
bool	loadXMLNode (std::string tag, double *nodeBool)
void	saveXML (clXML *xmlDocument)
int	serializeCheck (char *filepath)
	Checks the saved configuration file for whether it has more than one panel saved.
virtual bool	add (ciSensor sensor)
virtual bool	insert (ciSensor sensor, int idx=-1)
virtual bool	remove (int idx)
char *	getName (int idx=0)
void	setName (const char *name, int idx=0)
int	getType (int idx=0)
SensorType	getSensorType (int idx=0)
void	setType (int type, int idx=0)
void	setSensorType (SensorType type, int idx=0)
void	setBandInfo (double lowerBandLim, double upperBandLim, int nBands, int idx=0)
void	setBandInfo (double lowerBandLim, double upperBandLim, double dx, int idx=0)
void	getBandInfo (double &lowerBandLim, double &upperBandLim, int &nBands, int idx=0)
void	getBandInfo (double &lowerBandLim, double &upperBandLim, double &dx, int idx=0)
void	setFOVDegrees (double horz, double vert, int idx=0)
void	getFOVDegrees (double &horz, double &vert, int idx=0)
void	setFOVPixels (int horz, int vert, int idx=0)
void	getFOVPixels (int &horz, int &vert, int idx=0)
double	getSampleScale (int idx=0)
void	setSampleScale (double scale, int idx=0)
void	setTemperatureLimits (double tMax, double tMin, int idx=0)
void	getTemperatureLimits (double &tMax, double &tMin, int idx=0)
void	setMaxLightLevel (double maxLightLevel, int idx=0)
double	getMaxLightLevel (int idx=0)
void	setSaturationRatio (double satRatio, int idx=0)
double	getSaturationRatio (int idx=0)
char *	getTrackfile (int idx=0)
void	setTrackfile (char *filename, int idx=0)
void	setIndex (int index)
int	getIndex ()
int	getNumSensors ()
void	setNumSensors (int nSensors)
void	setAutomaticRadiance (bool flag, int idx=0)
bool	getAutomaticRadiance (int idx=0)
void	setDopplerColoring (bool flag, int idx=0)
bool	getDopplerColoring (int idx=0)
void	setDopplerSpatialEffects (bool flag, int idx=0)
bool	getDopplerSpatialEffects (int idx=0)
void	setGain (double gain, int idx=0)
double	getGain (int idx=0)
void	setLevel (double level, int idx=0)
double	getLevel (int idx=0)
void	setPemitterW (double PemitterW, int idx=0)
double	getPemitterW (int idx=0)
void	setTransmitterGain (double AntGain, int idx=0)
double	getTransmitterGain (int idx=0)
void	setReceiverGain (double AntGain, int idx=0)
double	getReceiverGain (int idx=0)
void	setGainPattern (int pattern, int idx=0)
int	getGainPattern (int idx)
void	setFCemitterHz (double FCemitterHz, int idx=0)
double	getFCemitterHz (int idx=0)
void	setBWemitterHz (double BWemitterHz, int idx=0)
double	getBWemitterHz (int idx=0)
void	setChannelResolutionHz (double ChannelResolutionHz, int idx=0)
double	getChannelResolutionHz (int idx=0)
void	setPulseWidth (double PulseWidth, int idx=0)
double	getPulseWidth (int idx=0)
void	setPRF (double PRF, int idx=0)
double	getPRF (int idx=0)
void	setNFPRF (double PRF, int idx=0)
double	getNFPRF (int idx=0)
void	setTPolAngle (double PolAngle, int idx=0)
double	getTPolAngle (int idx=0)
void	setRPolAngle (double PolAngle, int idx=0)
double	getRPolAngle (int idx=0)
void	setSysTempK (double degK, int idx=0)
double	getSysTempK (int idx)
void	setBeamWidth (double mrad, int idx=0)
double	getBeamWidth (int idx=0)
void	setFRDAngularVelocity (double Yradpersec, double Pradpersec, double Rradpersec, int idx=0)
void	getFRDAngularVelocity (double &Yradpersec, double &Pradpersec, double &Rradpersec, int idx=0)
void	setSpotfile (char *filename, int idx=0)
char *	getSpotfile (int idx)
void	setTAprops (double ThreshDetect, double ThreshClassify, double ThreshRecognize, double ThreshIdentify, double PersistenceTime, int idx=0)
void	getTAprops (double &ThreshDetect, double &ThreshClassify, double &ThreshRecognize, double &ThreshIdentify, double &PersistenceTime, int idx=0)
void	setUseTrackfile (bool useTrackfile, int idx=0)
bool	getUseTrackfile (int idx=0)
void	setWorldPosition (double x, double y, double z, int i=0)
void	getWorldPosition (double &x, double &y, double &z, int i=0)
void	setGeodeticPosition (double latitude, double longitude, double altitude, int idx=0)
void	getGeodeticPosition (double &latitude, double &longitude, double &altitude, int idx=0)
void	setNEDOrientation (double heading, double pitch, double roll, int idx=0)
void	getNEDOrientation (double &heading, double &pitch, double &roll, int idx=0)
void	setNEDLinearVelocity (double n, double e, double d, int idx=0)
void	getNEDLinearVelocity (double &n, double &e, double &d, int idx=0)
void	SetActive (bool isActive, int idx=0)
bool	GetActive (int idx=0)
void	setRGBColor (int color, int idx=0)
int	getRGBColor (int idx=0)
void	setSarReprojection (bool flag, int idx=0)
bool	getSarReprojection (int idx=0)
void	setSarBoresightROI (double x, double y, double width, double height, int idx=0)
void	getSarBoresightROI (double &x, double &y, double &width, double &height, int idx=0)
void	setSarIntegrationPathlength (double length, int idx=0)
void	getSarIntegrationPathlength (double &length, int idx=0)
void	setSarShadowOrientationDown (bool flag, int idx=0)
bool	getSarShadowOrientationDown (int idx=0)
void	setIsarIntegrationTime (double time, int idx=0)
void	getIsarIntegrationTime (double &time, int idx=0)
void	setIntensityModulationGain (double imodGain, int idx=0)
double	getIntensityModulationGain (int idx=0)
void	setMtiRadarReturn (bool flag, int idx=0)
bool	getMtiRadarReturn (int idx=0)
double	getMinWedgeExtent (int idx=0)
void	setMinWedgeExtent (double angle, int idx=0)
double	getMaxWedgeExtent (int idx=0)
void	setMaxWedgeExtent (double angle, int idx=0)
double	getDisplayRange (int idx=0)
void	setDisplayRange (double range, int idx=0)
bool	getBacksweepState (int idx=0)
void	enableBacksweep (bool backsweep, int idx=0)
bool	getOtwViewState (int idx=0)
void	showOtwView (bool show, int idx=0)
void	setSensorOptics (ciOptics optics, int idx=0)
ciOptics &	getSensorOptics (int idx=0)
void	setSensorElectronics (ciElectronics electronics, int idx=0)
ciElectronics &	getSensorElectronics (int idx=0)
void	setSensorDetector (ciDetector detector, int idx=0)
ciDetector &	getSensorDetector (int idx=0)
void	setSensorSenSim (ciSenSim senSim, int idx=0)
ciSenSim &	getSensorSenSim (int idx=0)
ciSensor	operator= (ciSensor &obj)
ciSensor &	operator[] (int idx)
	ciSensor ()
	ciSensor (ciSensor &obj)
virtual	~ciSensor ()

Public Attributes
struct ciSensor::structSensorData *	m_sensorList
int	m_nSensors
clXML	m_xml
clXMLNode *	m_parentNode

Detailed Description

ciSensor class declaration

Member Enumeration Documentation

enum ciSensor::SensorType

Enumerator:

DEFAULT
IR
NVG
RADAR

Constructor & Destructor Documentation

ciSensor::ciSensor

(

)

Description:

Default constructor.

ciSensor::ciSensor

(

ciSensor &

obj

)

Description:

Copy constructor.

Parameters

obj	- ciSensor object that is to be copied.

virtual ciSensor::~ciSensor ( )

virtual

Description:

Default destructor.

Member Function Documentation

bool ciSensor::archive

(

std::ofstream &

outf

)

Description:

Saves the ciSensor object to file.

Parameters

filepath	- complete path to the file.
flags	- file io flags to be set.

Returns

true if sucessful.

int ciSensor::serialize

(

char *

filepath

)

Description:

Loads the panel storage object from file.

Parameters

filepath

- complete path and filename to the file

Returns

int - the style of the saved panel(s) (0 = no panels saved)(1 = one panel saved)(2 = one or more panels saved)

bool ciSensor::loadXML

(

clXMLNode *

childNode

)

bool ciSensor::parseXML

(

clXML &

xmlDocument

)

bool ciSensor::loadXMLNode	(	std::string	tag,
		char *	nodeString
	)

Parameters

std::string	tag
char	*nodeString

Returns

bool

bool ciSensor::loadXMLNode	(	std::string	tag,
		bool *	nodeBool
	)

Parameters

std::string	tag
bool	*nodeBool

Returns

bool

bool ciSensor::loadXMLNode	(	std::string	tag,
		int *	nodeBool
	)

Parameters

std::string	tag
int	*nodeBool

Returns

bool

bool ciSensor::loadXMLNode	(	std::string	tag,
		double *	nodeBool
	)

Parameters

std::string	tag
double	*nodeBool

Returns

bool

void ciSensor::saveXML

(

clXML *

xmlDocument

)

int ciSensor::serializeCheck

(

char *

filepath

)

Checks the saved configuration file for whether it has more than one panel saved.

Parameters

char	*filepath - path of the configuration file that is being checked.

Returns

int - the style of the saved panel(s) (0 = no panels saved)(1 = one panel saved)(2 = one or more panels saved)

virtual bool ciSensor::add ( ciSensor  sensor )

virtual

Description:

Adds a sensor to the tail of the sensor list.

Parameters

sensor

- ciSensor object that is will be added to the current list of sensors.

Returns

true if successfull.

See Also

insert(), remove().

virtual bool ciSensor::insert ( ciSensor  sensor, int  idx = -1  )

virtual

Description:

Inserts a sensor to prior to the indicated index.

Parameters

sensor	- ciSensor sensor object to be added.
idx	- the sensor index to insert the new sensor. 0 will place it at the head of the list, -1 will place it at the tail of the list.

Returns

true if successful.

See Also

add(), remove().

virtual bool ciSensor::remove ( int  idx )

virtual

Description:

Removes a sensor from the sensor list.

Parameters

idx	- index in the sensor list of the sensor to remove.

Returns

true if successful.

See Also

add(), insert().

char* ciSensor::getName

(

int

idx = 0

)

Description:

Returns the name of the indexed sensor.

Parameters

idx	- index in the sensor list of the sensor to remove.

Returns

Name of the sensor.

void ciSensor::setName	(	const char *	name,
		int	idx = 0
	)

Description:

Sets the name of the indexed sensor.

Parameters

name	- the new name of the sensor.
idx	- index in the sensor list of the sensor to remove.

Returns

void.

int ciSensor::getType

(

int

idx = 0

)

Description:

Returns the type of the indexed sensor.

Parameters

idx	- index in the sensor list.

Returns

Type of the sensor. 0=EO, 1=IR, 2=WAS, 3=ASCAN, 4=LRCS, 5=SAR, 6=ISAR, 7=MTI, 8=ACTIVE_SONAR, 9=PASSIVE_SONAR

SensorType ciSensor::getSensorType

(

int

idx = 0

)

void ciSensor::setType	(	int	type,
		int	idx = 0
	)

Description:

Sets the type of the indexed sensor.

Parameters

type	- the new type of the sensor. 0=EO, 1=IR, 2=WAS, 3=ASCAN, 4=LRCS, 5=SAR, 6=ISAR, 7=MTI, 8=ACTIVE_SONAR, 9=PASSIVE_SONAR
idx	- index in the sensor list.

Returns

void.

void ciSensor::setSensorType	(	SensorType	type,
		int	idx = 0
	)

void ciSensor::setBandInfo	(	double	lowerBandLim,
		double	upperBandLim,
		int	nBands,
		int	idx = 0
	)

Description:

Sets the spectral wave band information for the sensor.

Parameters

lowerBandLim	- sets the lower band limit [um].
upperBandLim	- sets the upper band limit [um].
nBands	- sets the number of sample bins (dx = (upperBandLim - lowerBandLim)/nBands).
idx	- index in the sensor list of the sensor data.

Returns

void.

void ciSensor::setBandInfo	(	double	lowerBandLim,
		double	upperBandLim,
		double	dx,
		int	idx = 0
	)

Description:

Sets the spectral wave band information for the sensor.

Parameters

lowerBandLim	- sets the lower band limit [um].
upperBandLim	- sets the upper band limit [um].
dx	- sets the band sample interval [um].
idx	- index in the sensor list of the sensor data.

Returns

void.

void ciSensor::getBandInfo	(	double &	lowerBandLim,
		double &	upperBandLim,
		int &	nBands,
		int	idx = 0
	)

Description:

Gets the spectral wave band information for the sensor.

Parameters

lowerBandLim	- returns the lower band limit [um].
upperBandLim	- returns the upper band limit [um].
nBands	- returns the number of sample bins (dx = (upperBandLim - lowerBandLim)/nBands).
idx	- index in the sensor list of the sensor data.

Returns

void

void ciSensor::getBandInfo	(	double &	lowerBandLim,
		double &	upperBandLim,
		double &	dx,
		int	idx = 0
	)

Description:

Gets the spectral wave band information for the sensor.

Parameters

lowerBandLim	- returns the lower band limit [um].
upperBandLim	- returns the upper band limit [um].
dx	- returns the band sample interval [um].
idx	- index in the sensor list of the sensor data.

Returns

void.

void ciSensor::setFOVDegrees	(	double	horz,
		double	vert,
		int	idx = 0
	)

Description:

Sets the sensor FOV in degrees.

Parameters

horz	- sets the horizontal FOV sample [deg].
vert	- sets the verticle FOV sample [deg].
idx	- index in the sensor list of the sensor data.

Returns

void.

void ciSensor::getFOVDegrees	(	double &	horz,
		double &	vert,
		int	idx = 0
	)

Description:

Gets the sensor FOV in degrees.

Parameters

horz	- returns the horizontal FOV sample [deg].
vert	- returns the verticle FOV sample [deg].
idx	- index in the sensor list of the sensor data.

Returns

void.

void ciSensor::setFOVPixels	(	int	horz,
		int	vert,
		int	idx = 0
	)

Description:

Sets the sensor FOV in pixels.

Parameters

horz	- sets the horizontal FOV sample [pixels].
vert	- sets the verticle FOV sample [pixels].
idx	- index in the sensor list of the sensor data.

Returns

void.

void ciSensor::getFOVPixels	(	int &	horz,
		int &	vert,
		int	idx = 0
	)

Description:

Gets the sensor FOV in pixels.

Parameters

horz	- returns the horizontal FOV sample [pixels].
vert	- returns the verticle FOV sample [pixels].
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getSampleScale ( int  idx = 0 )

inline

Parameters

int

idx

Returns

double

void ciSensor::setSampleScale ( double  scale, int  idx = 0  )

inline

Parameters

double	scale
int	idx

void ciSensor::setTemperatureLimits	(	double	tMax,
		double	tMin,
		int	idx = 0
	)

Description:

Sets the sensor temperature limits.

Parameters

tMax	- sets the maximum thermal sensor dynamic range [deg C].
tMin	- sets the minimum thermal sensor dynamic range [deg C].
idx	- index in the sensor list of the sensor data.

Returns

void.

void ciSensor::getTemperatureLimits	(	double &	tMax,
		double &	tMin,
		int	idx = 0
	)

Description:

Gets the sensor temperature limits.

Parameters

tMax	- returns the maximum thermal sensor dynamic range [deg C].
tMin	- returns the minimum thermal sensor dynamic range [deg C].
idx	- index in the sensor list of the sensor data

Returns

void.

void ciSensor::setMaxLightLevel	(	double	maxLightLevel,
		int	idx = 0
	)

Description:

Sets the NVG sensor maximum light level.

Parameters

maxLightLevel	- sets the maximum NVG sensor light level [uW/cm2].
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getMaxLightLevel

(

int

idx = 0

)

Description:

Gets the sensor maximum light level.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The sensor maximum NVG sensor light level [uW/cm2].

void ciSensor::setSaturationRatio	(	double	satRatio,
		int	idx = 0
	)

Description:

Sets the radar sensor saturation ratio.

Parameters

satRatio	- sets the signal-to-noise ratio [unitless] at saturation.
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getSaturationRatio

(

int

idx = 0

)

Description:

Gets the sensor S/N ratio [unitless] at saturation.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The sensor saturation ratio [unitless]

char* ciSensor::getTrackfile

(

int

idx = 0

)

Description:

Gets the track file path and filename.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The complete path and filename of the track file.

void ciSensor::setTrackfile	(	char *	filename,
		int	idx = 0
	)

Description:

Gets the track file path and filename.

Parameters

filename	- complete path and filename of the track file.
idx	- index in the sensor list of the sensor data.

Returns

void.

void ciSensor::setIndex ( int  index )

inline

Description:

Sets the index number in the sensor list

Returns

Referenced by ciSensorPanel::setIndex().

int ciSensor::getIndex ( )

inline

Description:

Gets the index number in the sensor list

Returns

Referenced by ciSensorPanel::getIndex().

int ciSensor::getNumSensors ( )

inline

Description:

Gets the number of sensors in the list.

Returns

number of sensors.

void ciSensor::setNumSensors ( int  nSensors )

inline

Parameters

int

nSensors

void ciSensor::setAutomaticRadiance	(	bool	flag,
		int	idx = 0
	)

Parameters

bool	useTrackfile
int	idx

bool ciSensor::getAutomaticRadiance

(

int

idx = 0

)

Parameters

int

idx

Returns

bool

void ciSensor::setDopplerColoring	(	bool	flag,
		int	idx = 0
	)

Parameters

bool	flag
int	idx

bool ciSensor::getDopplerColoring

(

int

idx = 0

)

Parameters

int

idx

Returns

bool

void ciSensor::setDopplerSpatialEffects	(	bool	flag,
		int	idx = 0
	)

Parameters

bool	flag
int	idx

bool ciSensor::getDopplerSpatialEffects

(

int

idx = 0

)

Parameters

int

idx

Returns

bool

void ciSensor::setGain	(	double	gain,
		int	idx = 0
	)

Description:

Sets the gain.

Parameters

gain	- sets the gain [unitless].
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getGain

(

int

idx = 0

)

Description:

Gets the gain.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The gain.

void ciSensor::setLevel	(	double	level,
		int	idx = 0
	)

Description:

Sets the level.

Parameters

level	- sets the level. [unitless].
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getLevel

(

int

idx = 0

)

Description:

Gets the level.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The level.

void ciSensor::setPemitterW	(	double	PemitterW,
		int	idx = 0
	)

Description:

Sets the Power of active sensor antenna.

Parameters

PemitterW	- sets the Power of active sensor antenna [W].
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getPemitterW

(

int

idx = 0

)

Description:

Gets the sensor Power of active sensor antenna.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The power of active sensor antenna [W].

void ciSensor::setTransmitterGain	(	double	AntGain,
		int	idx = 0
	)

Description:

Sets the directional gain of active Transmitter antenna.

Parameters

AntGain	- sets the directional gain of Transmitter antenna [unitless].
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getTransmitterGain

(

int

idx = 0

)

Description:

Gets the directional gain of active Transmitter antenna.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The directional gain of Transmitter antenna [W].

void ciSensor::setReceiverGain	(	double	AntGain,
		int	idx = 0
	)

Description:

Sets the directional gain of active Receiver antenna.

Parameters

AntGain	- sets the directional gain of Receiver antenna [unitless].
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getReceiverGain

(

int

idx = 0

)

Description:

Gets the directional gain of active Receiver antenna.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The directional gain of Receiver antenna [W].

void ciSensor::setGainPattern	(	int	pattern,
		int	idx = 0
	)

Description:

Sets the gain pattern of the antenna.

Parameters

pattern	- sets the gain pattern [0=Unity, 1=Lobe, 2=Rect].
idx	- index in the sensor list of the sensor data.

Returns

void.

int ciSensor::getGainPattern

(

int

idx

)

Description:

Gets the gain pattern type of the antenna.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The gain pattern [0=Unity, 1=Lobe, 2=Rect].

void ciSensor::setFCemitterHz	(	double	FCemitterHz,
		int	idx = 0
	)

Description:

Sets the Center frequency of emitter of active sensor antenna.

Parameters

FCemitterHz	- sets the Center frequency of emitter of active sensor antenna [Hz].
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getFCemitterHz

(

int

idx = 0

)

Description:

Gets the Center frequency of emitter of active sensor antenna.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The Center frequency of emitter of active sensor antenna [Hz].

void ciSensor::setBWemitterHz	(	double	BWemitterHz,
		int	idx = 0
	)

Description:

Sets the Bandwidth of emitter of active sensor antenna.

Parameters

BWemitterHz	- sets the Bandwidth of emitter of active sensor antenna [Hz].
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getBWemitterHz

(

int

idx = 0

)

Description:

Gets the Bandwidth of emitter of active sensor antenna.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The Bandwidth of emitter of active sensor antenna [Hz].

void ciSensor::setChannelResolutionHz	(	double	ChannelResolutionHz,
		int	idx = 0
	)

Description:

Sets the Receiver Channel resolution of active sensor antenna.

Parameters

ChannelResolutionHz	- sets the Receiver Channel resolution of active sensor antenna [Hz].
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getChannelResolutionHz

(

int

idx = 0

)

Description:

Gets the Receiver Channel resolution of active sensor antenna.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The Receiver Channel resolution of active sensor antenna [Hz].

void ciSensor::setPulseWidth	(	double	PulseWidth,
		int	idx = 0
	)

Description:

Sets the Pulse width of active sensor antenna.

Parameters

PulseWidth	- sets the Pulse width of active sensor antenna [s].
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getPulseWidth

(

int

idx = 0

)

Description:

Gets the Pulse width of active sensor antenna.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The Pulse width of active sensor antenna [s].

void ciSensor::setPRF	(	double	PRF,
		int	idx = 0
	)

Description:

Sets the (foveal) Pulse repetition frequency of active sensor antenna.

Parameters

PRF	- sets the Pulse repetition frequency of active sensor antenna [Hz].
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getPRF

(

int

idx = 0

)

Description:

Gets the (foveal) Pulse repetition frequency of active sensor antenna.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The Pulse repetition frequency of active sensor antenna [Hz].

void ciSensor::setNFPRF	(	double	PRF,
		int	idx = 0
	)

Description:

Sets the (nonfoveal) Pulse repetition frequency of active sensor antenna.

Parameters

PRF	- sets the Pulse repetition frequency of active sensor antenna [Hz].
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getNFPRF

(

int

idx = 0

)

Description:

Gets the (nonfoveal) Pulse repetition frequency of active sensor antenna.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The Pulse repetition frequency of active sensor antenna [Hz].

void ciSensor::setTPolAngle	(	double	PolAngle,
		int	idx = 0
	)

Description:

Sets the polarization angle of the transmitter.

Parameters

PolAngle	- sets the polarization angle of the transmitter [deg]. {H=0, V=90, U=45}
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getTPolAngle

(

int

idx = 0

)

Description:

Gets the polarization angle of the transmitter.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The polarization angle of the transmitter [deg]. {H=0, V=90, U=45}

void ciSensor::setRPolAngle	(	double	PolAngle,
		int	idx = 0
	)

Description:

Sets the polarization angle of the receiver.

Parameters

PolAngle	- sets the polarization angle of the receiver [deg]. {H=0, V=90, U=45}
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getRPolAngle

(

int

idx = 0

)

Description:

Gets the polarization angle of the receiver.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The polarization angle of the receiver [deg]. {H=0, V=90, U=45}

void ciSensor::setSysTempK	(	double	degK,
		int	idx = 0
	)

Description:

Sets the radar system temperature.

Parameters

degK	- sets the radar system temperature [degK].
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getSysTempK

(

int

idx

)

Description:

Gets the radar system temperature [degK].

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The radar system temperature [degK].

void ciSensor::setBeamWidth	(	double	mrad,
		int	idx = 0
	)

Description:

Sets the beam width of active sensor antenna.

Parameters

mrad	- sets the beam or spot width of active sensor antenna [mrad].
idx	- index in the sensor list of the sensor data.

Returns

void.

double ciSensor::getBeamWidth

(

int

idx = 0

)

Description:

Gets the beam width of the active sensor antenna.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The beam or spot width of active sensor antenna [mrad].

void ciSensor::setFRDAngularVelocity	(	double	Yradpersec,
		double	Pradpersec,
		double	Rradpersec,
		int	idx = 0
	)

void ciSensor::getFRDAngularVelocity	(	double &	Yradpersec,
		double &	Pradpersec,
		double &	Rradpersec,
		int	idx = 0
	)

void ciSensor::setSpotfile	(	char *	filename,
		int	idx = 0
	)

char* ciSensor::getSpotfile

(

int

idx

)

void ciSensor::setTAprops	(	double	ThreshDetect,
		double	ThreshClassify,
		double	ThreshRecognize,
		double	ThreshIdentify,
		double	PersistenceTime,
		int	idx = 0
	)

Description:

Sets the Target Acquisition threshholds and persistence time of the active sensor.

Parameters

ThreshDetect	= Detection Threshhold [unitless 0-1]
ThreshClassify	= Classification Threshhold [unitless 0-1]. Should be < Detection Threshhold.
ThreshRecognize	= Recognition Threshhold [unitless 0-1]. Should be < Classification Threshhold.
ThreshIdentify	= Identification Threshhold [unitless 0-1]. Should be < Recognition Threshhold.
PeristenceTime	= Time over which the TA status is considered valid [s]
idx	= index in the sensor list of the sensor data.

Returns

void.

void ciSensor::getTAprops	(	double &	ThreshDetect,
		double &	ThreshClassify,
		double &	ThreshRecognize,
		double &	ThreshIdentify,
		double &	PersistenceTime,
		int	idx = 0
	)

Description:

Gets the Target Acquisition threshholds and persistence time of the active sensor.

Parameters

ThreshDetect	= Detection Threshhold [unitless 0-1]
ThreshClassify	= Classification Threshhold [unitless 0-1]. Should be < Detection Threshhold.
ThreshRecognize	= Recognition Threshhold [unitless 0-1]. Should be < Classification Threshhold.
ThreshIdentify	= Identification Threshhold [unitless 0-1]. Should be < Recognition Threshhold.
PeristenceTime	= Time over which the TA status is considered valid [s]
idx	= index in the sensor list of the sensor data.

Returns

void.

void ciSensor::setUseTrackfile	(	bool	useTrackfile,
		int	idx = 0
	)

Description:

Sets the use trackfile flag.

Parameters

useTrackfile	- new value for the use trackfile flag.
idx	- index in the sensor list of the sensor data.

Returns

void.

bool ciSensor::getUseTrackfile

(

int

idx = 0

)

Description:

Gets the use trackfile flag.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

the current value for the use trackfile flag.

void ciSensor::setWorldPosition	(	double	x,
		double	y,
		double	z,
		int	i = 0
	)

Description:

Sets the world position

Parameters

x,y,z	- world position to set from
i	- index of sensor

void ciSensor::getWorldPosition	(	double &	x,
		double &	y,
		double &	z,
		int	i = 0
	)

Description:

Gets the world position

Parameters

x,y,z	- return in these
i	- index of sensor

void ciSensor::setGeodeticPosition	(	double	latitude,
		double	longitude,
		double	altitude,
		int	idx = 0
	)

Description:

Sets geodetic postion of the sensor object.

Parameters

latitude	- geodetic latitude [deg].
longitude	- geodetic longitude [deg].
altitude	- geodetic altitude [m].
idx	- index in the sensor list of the sensor data.

Returns

void.

void ciSensor::getGeodeticPosition	(	double &	latitude,
		double &	longitude,
		double &	altitude,
		int	idx = 0
	)

Description:

Gets geodetic postion of the sensor object.

Parameters

latitude	- geodetic latitude [deg].
longitude	- geodetic longitude [deg].
altitude	- geodetic altitude [m].
idx	- index in the sensor list of the sensor data.

Returns

void.

void ciSensor::setNEDOrientation	(	double	heading,
		double	pitch,
		double	roll,
		int	idx = 0
	)

Description:

Sets NED orientation of the sensor object.

Parameters

heading	- NED heading [deg].
pitch	- NED pitch [deg].
roll	- NED roll [deg].
idx	- index in the sensor list of the sensor data.

Returns

void.

void ciSensor::getNEDOrientation	(	double &	heading,
		double &	pitch,
		double &	roll,
		int	idx = 0
	)

Description:

Gets NED orientation of the sensor object.

Parameters

heading	- NED heading [deg].
pitch	- NED pitch [deg].
roll	- NED roll [deg].
idx	- index in the sensor list of the sensor data.

Returns

void.

void ciSensor::setNEDLinearVelocity	(	double	n,
		double	e,
		double	d,
		int	idx = 0
	)

Description:

Sets NED velocity of the sensor object.

Parameters

n	- North component of linear velocity [m/s].
e	- East component of linear velocity [m/s].
d	- Down component of linear velocity [m/s].
idx	- index in the sensor list of the sensor data.

Returns

void.

void ciSensor::getNEDLinearVelocity	(	double &	n,
		double &	e,
		double &	d,
		int	idx = 0
	)

Description:

Gets NED velocity of the sensor object.

Parameters

n	- North component of linear velocity [m/s].
e	- East component of linear velocity [m/s].
d	- Down component of linear velocity [m/s].
idx	- index in the sensor list of the sensor data.

Returns

void.

void ciSensor::SetActive	(	bool	isActive,
		int	idx = 0
	)

Description:

Sets the state (active or inactive) for the sensor object.

Parameters

isActive	- new state (active or inactive) for the sensor.
idx	- index in the sensor list of the sensor data.

Returns

void.

bool ciSensor::GetActive

(

int

idx = 0

)

Description:

Gets the state (active or inactive) for the sensor object.

Parameters

idx	- index in the sensor list of the sensor data.

Returns

The current state (active or inactive) of the sensor object.

void ciSensor::setRGBColor ( int  color, int  idx = 0  )

inline

Parameters

int

color

Referenced by ciSensorPanel::setRGBColor().

int ciSensor::getRGBColor ( int  idx = 0 )

inline

Returns

int

Referenced by ciSensorPanel::getRGBColor().

void ciSensor::setSarReprojection	(	bool	flag,
		int	idx = 0
	)

Parameters

bool	flag
int	idx

bool ciSensor::getSarReprojection

(

int

idx = 0

)

Parameters

int

idx

Returns

bool

void ciSensor::setSarBoresightROI	(	double	x,
		double	y,
		double	width,
		double	height,
		int	idx = 0
	)

void ciSensor::getSarBoresightROI	(	double &	x,
		double &	y,
		double &	width,
		double &	height,
		int	idx = 0
	)

void ciSensor::setSarIntegrationPathlength	(	double	length,
		int	idx = 0
	)

void ciSensor::getSarIntegrationPathlength	(	double &	length,
		int	idx = 0
	)

void ciSensor::setSarShadowOrientationDown	(	bool	flag,
		int	idx = 0
	)

bool ciSensor::getSarShadowOrientationDown

(

int

idx = 0

)

void ciSensor::setIsarIntegrationTime	(	double	time,
		int	idx = 0
	)

void ciSensor::getIsarIntegrationTime	(	double &	time,
		int	idx = 0
	)

void ciSensor::setIntensityModulationGain	(	double	imodGain,
		int	idx = 0
	)

double ciSensor::getIntensityModulationGain

(

int

idx = 0

)

void ciSensor::setMtiRadarReturn	(	bool	flag,
		int	idx = 0
	)

Parameters

bool	flag
int	idx

bool ciSensor::getMtiRadarReturn

(

int

idx = 0

)

Parameters

int

idx

Returns

bool

double ciSensor::getMinWedgeExtent ( int  idx = 0 )

inline

gets the minimum circular hud wedge extent angle

Returns

min wedge extent angle

void ciSensor::setMinWedgeExtent ( double  angle, int  idx = 0  )

inline

sets the minimum wedge extent

Parameters

angle

- the minimum wedge extent angle.

Returns

void.

double ciSensor::getMaxWedgeExtent ( int  idx = 0 )

inline

gets the maximum circular hud wedge extent angle

Returns

max wedge extent angle

void ciSensor::setMaxWedgeExtent ( double  angle, int  idx = 0  )

inline

sets the max wedge extent

Parameters

angle

- the maximum wedge extent angle.

Returns

void.

double ciSensor::getDisplayRange ( int  idx = 0 )

inline

gets the display range

Returns

range - the display range

void ciSensor::setDisplayRange ( double  range, int  idx = 0  )

inline

sets the display range

Parameters

range

- the display range

Returns

void.

bool ciSensor::getBacksweepState ( int  idx = 0 )

inline

void ciSensor::enableBacksweep ( bool  backsweep, int  idx = 0  )

inline

bool ciSensor::getOtwViewState ( int  idx = 0 )

inline

void ciSensor::showOtwView ( bool  show, int  idx = 0  )

inline

void ciSensor::setSensorOptics	(	ciOptics	optics,
		int	idx = 0
	)

Parameters

ciOptics	optics
int	idx

ciOptics& ciSensor::getSensorOptics

(

int

idx = 0

)

Parameters

int

idx

Returns

ciOptics

void ciSensor::setSensorElectronics	(	ciElectronics	electronics,
		int	idx = 0
	)

Parameters

ciElectronics	electronics
int	idx

ciElectronics& ciSensor::getSensorElectronics

(

int

idx = 0

)

Parameters

int

idx

Returns

ciElectronics

void ciSensor::setSensorDetector	(	ciDetector	detector,
		int	idx = 0
	)

Parameters

ciDetector	detector
int	idx

ciDetector& ciSensor::getSensorDetector

(

int

idx = 0

)

Parameters

int

idx

Returns

ciDetector

void ciSensor::setSensorSenSim	(	ciSenSim	senSim,
		int	idx = 0
	)

Parameters

ciSenSim	senSim
int	idx

ciSenSim& ciSensor::getSensorSenSim

(

int

idx = 0

)

Parameters

int

idx

Returns

ciSenSim

ciSensor ciSensor::operator=

(

ciSensor &

obj

)

Description:

Assignment operator.

Parameters

obj	- ciSensor object that is to be assigned.

See Also

ciSensor(ciSensor &obj)

ciSensor& ciSensor::operator[]

(

int

idx

)

Description:

Get operator.

Parameters

idx	- ciSensor object that is to be returned.

Member Data Documentation

struct ciSensor::structSensorData * ciSensor::m_sensorList

list of available sensors

int ciSensor::m_nSensors

clXML ciSensor::m_xml

clXMLNode* ciSensor::m_parentNode

---

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

• ciSensor.h