org.jmisb.api.klv.st1206

Class ImagePlane

java.lang.Object

org.jmisb.api.klv.st1206.SARMIEnumeration

org.jmisb.api.klv.st1206.ImagePlane

All Implemented Interfaces:

IKlvValue, ISARMIMetadataValue

public class ImagePlane
extends SARMIEnumeration

Image Plane (ST 1206 Item 4).

SAR images are typically formed either on the slant plane - the plane containing the ground- track vector and the line-of-sight vector to the SRP, or onto the ground plane - the plane tangential to the ellipsoid at the SRP.

The selection of the imaging plane may impact the accuracy of distance measurements. SAR images formed in the slant plane experience a foreshortening in the range dimension, whereby objects projected onto the slant plane will appear shorter than when projected onto the ground plane. As such, the plane in which the SARMI data is formed is defined as 0 for Slant Plane, 1 for Ground Plane, and 2 for Other (self-defined plane).

See ST 1206 6.2.4 for more information.

Field Summary

Fields inherited from class org.jmisb.api.klv.st1206.SARMIEnumeration

value

Constructor Summary

Constructors

Constructor and Description
ImagePlane(byte status) Create from value.
ImagePlane(byte[] bytes) Create from encoded bytes.

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Get the human-readable name for the value.
byte	getImagePlane() Get the image plane.

Methods inherited from class org.jmisb.api.klv.st1206.SARMIEnumeration

getBytes, getDisplayableValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImagePlane

public ImagePlane(byte status)

Create from value.

Parameters:

status - The value of the image plane enumeration.

ImagePlane

public ImagePlane(byte[] bytes)

Create from encoded bytes.

Parameters:

bytes - The byte array of length 1

Method Detail

getImagePlane

public byte getImagePlane()

Get the image plane.

Returns:

The value as an enumeration value (0 for slant, 1 for ground, 2 for other).

getDisplayName

public String getDisplayName()

Description copied from interface: IKlvValue

Get the human-readable name for the value.

Returns:

The name of the type