Brian M. Ames
and 1 contributors

NAME

Rinchi::CIGIPP::SensorResponse - Perl extension for the Common Image Generator Interface - Sensor Response data packet. data packet. =head1 SYNOPSIS

  use Rinchi::CIGIPP::SensorResponse;
  my $sensor_resp = Rinchi::CIGIPP::SensorResponse->new();

  $packet_type = $sensor_resp->packet_type();
  $packet_size = $sensor_resp->packet_size();
  $view_ident = $sensor_resp->view_ident(7825);
  $sensor_ident = $sensor_resp->sensor_ident(71);
  $sensor_status = $sensor_resp->sensor_status(Rinchi::CIGIPP->Tracking);
  $gate_xsize = $sensor_resp->gate_xsize(21687);
  $gate_ysize = $sensor_resp->gate_ysize(11524);
  $gate_xposition = $sensor_resp->gate_xposition(53.246);
  $gate_yposition = $sensor_resp->gate_yposition(75.892);
  $host_frame_number = $sensor_resp->host_frame_number(19728);

DESCRIPTION

The Sensor Response packet is used to report the gate size and position on a sensor display to the Host. The sensor gate size and position are defined with respect to the 2D view coordinate system. The +X axis is to the right of the screen and the +Y axis is up. The origin is at the intersection of the viewing vector with the view plane. The gate position is measured in degrees along each axis from the origin to the center of the gate.

The Gate X Position and Gate Y Position angles correspond to the horizontal and vertical angles formed between the sensor's viewing vector and a vector from the sensor eyepoint to the track point. Scaling of the sensor view can be performed with a View Definition packet.

The Host Frame Number attribute contains value of the Host Frame Number attribute of the IG Control packet last received by the IG before the gate and line-of-sight intersection data are calculated. The Host may correlate this value to an eyepoint position or may use the value to determine sensor sampling rate latency.

Either this packet or the Sensor Extended Response packet must be sent to the Host during each frame that the specified sensor is active.

EXPORT

None by default.

#==============================================================================

new $sensor_resp = Rinchi::CIGIPP::SensorResponse->new()

Constructor for Rinchi::SensorResponse.

sub packet_type()
 $value = $sensor_resp->packet_type();

Data Packet Identifier.

This attribute identifies this data packet as the Sensor Response packet. The value of this attribute must be 106.

sub packet_size()
 $value = $sensor_resp->packet_size();

Data Packet Size.

This attribute indicates the number of bytes in this data packet. The value of this attribute must be 24.

sub view_ident([$newValue])
 $value = $sensor_resp->view_ident($newValue);

View ID.

This attribute specifies the view that represents the sensor display.

sub sensor_ident([$newValue])
 $value = $sensor_resp->sensor_ident($newValue);

Sensor ID.

This attribute specifies the sensor to which the data in this packet apply.

sub sensor_status([$newValue])
 $value = $sensor_resp->sensor_status($newValue);

Sensor Status.

This attribute indicates the current tracking state of the sensor.

    Searching            0
    Tracking             1
    ImpendingBreaklock   2
    Breaklock            3
sub gate_xsize([$newValue])
 $value = $sensor_resp->gate_xsize($newValue);

Gate X Size.

This attribute specifies the gate symbol size along the view's X axis.

Note: This size is specified in either pixels or raster lines depending upon the orientation of the display.

sub gate_ysize([$newValue])
 $value = $sensor_resp->gate_ysize($newValue);

Gate Y Size.

This attribute specifies the gate symbol size along the view's Y axis.

Note: This size is specified in either pixels or raster lines depending upon the orientation of the display.

sub gate_xposition([$newValue])
 $value = $sensor_resp->gate_xposition($newValue);

Gate X Position.

This attribute specifies the gate symbol's position along the view's X axis. This position is given as the horizontal angle formed at the sensor eyepoint between the sensor's viewing vector and the center of the track point.

sub gate_yposition([$newValue])
 $value = $sensor_resp->gate_yposition($newValue);

Gate Y Position.

This attribute specifies the gate symbol's position along the view's Y axis. This position is given as the vertical angle formed at the sensor eyepoint between the sensor's viewing vector and the center of the track point.

sub host_frame_number([$newValue])
 $value = $sensor_resp->host_frame_number($newValue);

Host Frame Number.

This attribute indicates the Host frame number at the time that the IG calculates the gate and line-of-sight intersection data.

sub pack()
 $value = $sensor_resp->pack();

Returns the packed data packet.

sub unpack()
 $value = $sensor_resp->unpack();

Unpacks the packed data packet.

sub byte_swap()
 $obj_name->byte_swap();

Byte swaps the packed data packet.

SEE ALSO

Refer the the Common Image Generator Interface ICD which may be had at this URL: http://cigi.sourceforge.net/specification.php

AUTHOR

Brian M. Ames, <bmames@apk.net>

COPYRIGHT AND LICENSE

Copyright (C) 2009 by Brian M. Ames

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.6 or, at your option, any later version of Perl 5 you may have available.

2 POD Errors

The following errors were encountered while parsing the POD:

Around line 89:

'=item' outside of any '=over'

Around line 443:

You forgot a '=back' before '=head1'