vega.uplink.pointing.PtrParameters.Offset

Class OffsetRaster

java.lang.Object

CompositeDataset

vega.uplink.pointing.PointingElement

vega.uplink.pointing.PtrParameters.Offset.OffsetAngles

vega.uplink.pointing.PtrParameters.Offset.OffsetRaster

Direct Known Subclasses:

ObservationOffsetRaster

public class OffsetRaster
extends OffsetAngles

A raster is defined if the element offsetAngles contains the attribute ref=raster. The rotation angles before the raster start-time and after the dwell-time of the last rasterpoint correspond to the angles of the first and last raster point respectively.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DWELLTIME_DEFAULT_UNIT min
static java.lang.String	DWELLTIME_FIELD dwelTime
static java.lang.String	KEEPLINEDIR_FIELD keepLineDir
static java.lang.String	LINEAXIS_FIELD lineAxis
static java.lang.String	LINESLEWTIME_DEFAULT_UNIT min
static java.lang.String	LINESLEWTIME_FIELD lineSlewTime
static java.lang.String	POINTSLEWTIME_DEFAULT_UNIT min
static java.lang.String	POINTSLEWTIME_FIELD pointSlewTime
static java.lang.String	STARTTIME_FIELD startTime
static java.lang.String	XDELTA_DEFAULT_UNIT deg
static java.lang.String	XDELTA_FIELD xDelta
static java.lang.String	XPOINTS_FIELD xPoints
static java.lang.String	XSTART_DEFAULT_UNIT deg
static java.lang.String	XSTART_FIELD xStart
static java.lang.String	YDELTA_DEFAULT_UNIT deg
static java.lang.String	YDELTA_FIELD yDelta
static java.lang.String	YPOINTS_FIELD yPoints
static java.lang.String	YSTART_DEFAULT_UNIT deg
static java.lang.String	YSTART_FIELD yStart

Fields inherited from class vega.uplink.pointing.PtrParameters.Offset.OffsetAngles

OFFSETANGLES_TAG, OFFSETANGLES_TYPE_CUSTOM, OFFSETANGLES_TYPE_FIXED, OFFSETANGLES_TYPE_RASTER, OFFSETANGLES_TYPE_SCAN, REF_TAG

Constructor Summary

Constructors

Constructor and Description
OffsetRaster(java.util.Date startTime, int xPoints, int yPoints, float xStart, float yStart, float xDelta, float yDelta, float pointSlewTime, float lineSlewTime, float dwellTime, java.lang.String lineAxis, boolean keepLineDir) A raster is defined if the element offsetAngles contains the attribute ref=raster.
OffsetRaster(java.util.Date startTime, int xPoints, int yPoints, java.lang.String xStartUnit, float xStart, java.lang.String yStartUnit, float yStart, java.lang.String xDeltaUnit, float xDelta, java.lang.String yDeltaUnit, float yDelta, java.lang.String pointSlewTimeUnit, float pointSlewTime, java.lang.String lineSlewTimeUnit, float lineSlewTime, java.lang.String dwellTimeUnit, float dwellTime, java.lang.String lineAxis, boolean keepLineDir) A raster is defined if the element offsetAngles contains the attribute ref=raster.
OffsetRaster(PointingElement org)
OffsetRaster(java.lang.String startTime) Creates a raster with xPoints set to 1 yPoints set to 1 xStart set to 0.0 deg.
OffsetRaster(java.lang.String startTime, java.lang.String xPoints, java.lang.String yPoints, java.lang.String xStart, java.lang.String yStart, java.lang.String xDelta, java.lang.String yDelta, java.lang.String pointSlewTime, java.lang.String lineSlewTime, java.lang.String dwellTime, java.lang.String lineAxis, java.lang.String keepLineDir) A raster is defined if the element offsetAngles contains the attribute ref=raster.

Method Summary

Methods

Modifier and Type	Method and Description
OffsetRaster	copy()
long	getDurationMilliSecs() Get the duration in milliseconds of this offset rotation
float	getDwellTime() Get time spent at one raster point
float	getDwellTime(java.lang.String unit)
java.lang.String	getDwellTimeUnit()
java.util.Date	getEndDate()
java.lang.String	getLineAxis() Get Name of offset-axis along which the raster-points are connected in a line.
float	getLineSlewTime() Get slew time between two raster-points in different lines.
float	getLineSlewTime(java.lang.String unit)
java.lang.String	getLineSlewTimeUnit()
float	getPointSlewTime() Get slew time between two raster-points in the same line.
float	getPointSlewTime(java.lang.String unit)
java.lang.String	getPointSlewTimeUnit()
java.util.Date	getStartDate()
int	getXPoints()
float	getXStart() Get the rotation angle of first raster-point towards the offset x-axis
float	getXStart(java.lang.String unit) Get the rotation angle of first raster-point towards the offset x-axis expressed in a specific unit
java.lang.String	getXStartUnit() Get the unit in which the rotation angle of first raster-point towards the offset x-axis is expressed
int	getYPoints()
float	getYStart() Get the rotation angle of first raster-point towards the offset y-axis
float	getYStart(java.lang.String unit) Get the rotation angle of first raster-point towards the offset y-axis expressed in a specific unit
java.lang.String	getYStartUnit() Get the unit in which the rotation angle of first raster-point towards the offset y-axis is expressed
boolean	isRaster() True if this offset rotation is of the type raster.
void	setDwellTime(java.lang.String unit, float value)
void	setLineAxis(java.lang.String lineAxis) Set Name of offset-axis along which the raster-points are connected in a line.
void	setLineSlewTime(java.lang.String unit, float value) Set slew time between two raster-points in different lines.
void	setStartDate(java.util.Date date)
void	setXPoints(int xPoints)
void	setXStart(java.lang.String unit, float value) Set the rotation angle of first raster-point towards the offset x-axis expressed in a specific unit
void	setYPoints(int yPoints)
void	setYStart(java.lang.String unit, float value) Set the rotation angle of first raster-point towards the offset y-axis expressed in a specific unit

Methods inherited from class vega.uplink.pointing.PtrParameters.Offset.OffsetAngles

getStartTime, getUnit, isCustom, isFixed, isScan, setBooleanField, setFloatArrayField, setFloatField, setIntegerField, setStartTime, setStartTime, setStringField, setUnit, stringToFloatArray

Methods inherited from class vega.uplink.pointing.PointingElement

addAttribute, addChild, asDataset, copyFrom, equals, getAttribute, getAttributes, getChild, getChildren, getDescription, getFirstLevelTextContent, getName, getValue, hasAttributtes, hasChildren, readFrom, regenerate, removeAttribute, removeAttribute, setDescription, setValue, toString, toStringParameter, toXml, validate

Methods inherited from class java.lang.Object

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

Field Detail

STARTTIME_FIELD

public static java.lang.String STARTTIME_FIELD

startTime

XPOINTS_FIELD

public static java.lang.String XPOINTS_FIELD

xPoints

YPOINTS_FIELD

public static java.lang.String YPOINTS_FIELD

yPoints

XSTART_FIELD

public static java.lang.String XSTART_FIELD

xStart

XSTART_DEFAULT_UNIT

public static java.lang.String XSTART_DEFAULT_UNIT

deg

YSTART_FIELD

public static java.lang.String YSTART_FIELD

yStart

YSTART_DEFAULT_UNIT

public static java.lang.String YSTART_DEFAULT_UNIT

deg

XDELTA_FIELD

public static java.lang.String XDELTA_FIELD

xDelta

XDELTA_DEFAULT_UNIT

public static java.lang.String XDELTA_DEFAULT_UNIT

deg

YDELTA_FIELD

public static java.lang.String YDELTA_FIELD

yDelta

YDELTA_DEFAULT_UNIT

public static java.lang.String YDELTA_DEFAULT_UNIT

deg

POINTSLEWTIME_FIELD

public static java.lang.String POINTSLEWTIME_FIELD

pointSlewTime

POINTSLEWTIME_DEFAULT_UNIT

public static java.lang.String POINTSLEWTIME_DEFAULT_UNIT

min

LINESLEWTIME_FIELD

public static java.lang.String LINESLEWTIME_FIELD

lineSlewTime

LINESLEWTIME_DEFAULT_UNIT

public static java.lang.String LINESLEWTIME_DEFAULT_UNIT

min

DWELLTIME_FIELD

public static java.lang.String DWELLTIME_FIELD

dwelTime

DWELLTIME_DEFAULT_UNIT

public static java.lang.String DWELLTIME_DEFAULT_UNIT

min

LINEAXIS_FIELD

public static java.lang.String LINEAXIS_FIELD

lineAxis

KEEPLINEDIR_FIELD

public static java.lang.String KEEPLINEDIR_FIELD

keepLineDir

Constructor Detail

OffsetRaster

public OffsetRaster(PointingElement org)

OffsetRaster

public OffsetRaster(java.util.Date startTime,
            int xPoints,
            int yPoints,
            java.lang.String xStartUnit,
            float xStart,
            java.lang.String yStartUnit,
            float yStart,
            java.lang.String xDeltaUnit,
            float xDelta,
            java.lang.String yDeltaUnit,
            float yDelta,
            java.lang.String pointSlewTimeUnit,
            float pointSlewTime,
            java.lang.String lineSlewTimeUnit,
            float lineSlewTime,
            java.lang.String dwellTimeUnit,
            float dwellTime,
            java.lang.String lineAxis,
            boolean keepLineDir)

A raster is defined if the element offsetAngles contains the attribute ref=raster. The rotation angles before the raster start-time and after the dwell-time of the last raster point correspond to the angles of the first and last raster point respectively.

Parameters:

startTime - Raster start time

xPoints - Number of Points in offset-x-direction

yPoints - Number of Points in offset-y-direction

xStartUnit - Unit for xStart. For example deg.

xStart - rotation angle of first raster-point towards the offset x-axis

yStartUnit - Unit for yStart. For example deg.

yStart - rotation angle of first raster-point towards the offset-y-axis

xDeltaUnit - Unit for xDelta. For example deg.

xDelta - Delta angle towards offset x axis between two raster points

yDeltaUnit - Unit for yDelta. For example deg.

yDelta - Delta angle towards offset-y-axis between two raster points

pointSlewTimeUnit - Units used for pointSlewTime. For example min.

pointSlewTime - Slew time between two raster-points in the same line.

lineSlewTimeUnit - Units used for lineSlewTime. For example min.

lineSlewTime - Slew time between two raster-points in different lines.

dwellTimeUnit - Units used for dwellTime. For example min.

dwellTime - Time spent at one raster point

lineAxis - Name of offset-axis along which the raster-points are connected in a line.

keepLineDir - Flag indicating whether the direction of the first raster-row is kept (=true) or alternated (=false)

OffsetRaster

public OffsetRaster(java.util.Date startTime,
            int xPoints,
            int yPoints,
            float xStart,
            float yStart,
            float xDelta,
            float yDelta,
            float pointSlewTime,
            float lineSlewTime,
            float dwellTime,
            java.lang.String lineAxis,
            boolean keepLineDir)

A raster is defined if the element offsetAngles contains the attribute ref=raster. Times are expressed in min and angles in deg. The rotation angles before the raster start-time and after the dwell-time of the last raster point correspond to the angles of the first and last raster point respectively.

Parameters:

startTime - Raster start time

xPoints - Number of Points in offset-x-direction

yPoints - Number of Points in offset-y-direction

xStart - rotation angle of first raster-point towards the offset x-axis

yStart - rotation angle of first raster-point towards the offset-y-axis

xDelta - Delta angle towards offset x axis between two raster points

yDelta - Delta angle towards offset-y-axis between two raster points

pointSlewTime - Slew time between two raster-points in the same line.

lineSlewTime - Slew time between two raster-points in different lines.

dwellTime - Time spent at one raster point

lineAxis - Name of offset-axis along which the raster-points are connected in a line.

keepLineDir - Flag indicating whether the direction of the first raster-row is kept (=true) or alternated (=false)

OffsetRaster

public OffsetRaster(java.lang.String startTime,
            java.lang.String xPoints,
            java.lang.String yPoints,
            java.lang.String xStart,
            java.lang.String yStart,
            java.lang.String xDelta,
            java.lang.String yDelta,
            java.lang.String pointSlewTime,
            java.lang.String lineSlewTime,
            java.lang.String dwellTime,
            java.lang.String lineAxis,
            java.lang.String keepLineDir)
             throws java.text.ParseException

A raster is defined if the element offsetAngles contains the attribute ref=raster. Times are expressed in min and angles in deg. The rotation angles before the raster start-time and after the dwell-time of the last raster point correspond to the angles of the first and last raster point respectively.

Parameters:

startTime - Raster start time

xPoints - Number of Points in offset-x-direction

yPoints - Number of Points in offset-y-direction

xStart - rotation angle of first raster-point towards the offset x-axis

yStart - rotation angle of first raster-point towards the offset-y-axis

xDelta - Delta angle towards offset x axis between two raster points

yDelta - Delta angle towards offset-y-axis between two raster points

pointSlewTime - Slew time between two raster-points in the same line.

lineSlewTime - Slew time between two raster-points in different lines.

dwellTime - Time spent at one raster point

lineAxis - Name of offset-axis along which the raster-points are connected in a line.

keepLineDir - Flag indicating whether the direction of the first raster-row is kept (=true) or alternated (=false)

Throws:

java.text.ParseException

OffsetRaster

public OffsetRaster(java.lang.String startTime)
             throws java.text.ParseException

Creates a raster with xPoints set to 1 yPoints set to 1 xStart set to 0.0 deg. yStart set to 0.0 deg. xDelta set to 0.0 deg. yDelta set to 0.0 deg. pointSlewTime set to 1 min. lineSlewTime set to 1 min. dwellTime set to 1 min. lineAxis set to y keepLineDir is set to false

Parameters:

startTime - start Time of Raster

Throws:

java.text.ParseException

Method Detail

getPointSlewTime

public float getPointSlewTime()

Get slew time between two raster-points in the same line.

Returns:

getPointSlewTimeUnit

public java.lang.String getPointSlewTimeUnit()

getPointSlewTime

public float getPointSlewTime(java.lang.String unit)

getDwellTime

public float getDwellTime()

Get time spent at one raster point

Returns:

setDwellTime

public void setDwellTime(java.lang.String unit,
                float value)

getDwellTimeUnit

public java.lang.String getDwellTimeUnit()

getDwellTime

public float getDwellTime(java.lang.String unit)

getLineAxis

public java.lang.String getLineAxis()

Get Name of offset-axis along which the raster-points are connected in a line.

Returns:

setLineAxis

public void setLineAxis(java.lang.String lineAxis)

Set Name of offset-axis along which the raster-points are connected in a line.

Parameters:

lineAxis - The new lineAxis

getXStart

public float getXStart()

Get the rotation angle of first raster-point towards the offset x-axis

Returns:

getXStartUnit

public java.lang.String getXStartUnit()

Get the unit in which the rotation angle of first raster-point towards the offset x-axis is expressed

Returns:

getXStart

public float getXStart(java.lang.String unit)

Get the rotation angle of first raster-point towards the offset x-axis expressed in a specific unit

Parameters:

unit - the unit in which the value will be expressed

Returns:

setXStart

public void setXStart(java.lang.String unit,
             float value)

Set the rotation angle of first raster-point towards the offset x-axis expressed in a specific unit

Parameters:

unit - the unit in which the value is expressed

value -

getYStart

public float getYStart()

Get the rotation angle of first raster-point towards the offset y-axis

Returns:

getYStartUnit

public java.lang.String getYStartUnit()

Get the unit in which the rotation angle of first raster-point towards the offset y-axis is expressed

Returns:

getYStart

public float getYStart(java.lang.String unit)

Get the rotation angle of first raster-point towards the offset y-axis expressed in a specific unit

Parameters:

unit - the unit in which the value will be expressed

Returns:

setYStart

public void setYStart(java.lang.String unit,
             float value)

Set the rotation angle of first raster-point towards the offset y-axis expressed in a specific unit

Parameters:

unit - the unit in which the value is expressed

value -

getLineSlewTime

public float getLineSlewTime()

Get slew time between two raster-points in different lines.

Returns:

getLineSlewTimeUnit

public java.lang.String getLineSlewTimeUnit()

getLineSlewTime

public float getLineSlewTime(java.lang.String unit)

setLineSlewTime

public void setLineSlewTime(java.lang.String unit,
                   float value)

Set slew time between two raster-points in different lines.

Parameters:

unit - The unit in which the new value is expressed

value - The new value for the slew time

getDurationMilliSecs

public long getDurationMilliSecs()

Description copied from class: OffsetAngles

Get the duration in milliseconds of this offset rotation

Specified by:

getDurationMilliSecs in class OffsetAngles

Returns:

setStartDate

public void setStartDate(java.util.Date date)

getStartDate

public java.util.Date getStartDate()

setXPoints

public void setXPoints(int xPoints)

getXPoints

public int getXPoints()

setYPoints

public void setYPoints(int yPoints)

getYPoints

public int getYPoints()

isRaster

public boolean isRaster()

Description copied from class: OffsetAngles

True if this offset rotation is of the type raster. False otherwise

Overrides:

isRaster in class OffsetAngles

Returns:

getEndDate

public java.util.Date getEndDate()

copy

public OffsetRaster copy()

Specified by:

copy in class OffsetAngles