vega.uplink.pointing.PtrParameters.Offset

Class OffsetScan

java.lang.Object

CompositeDataset

vega.uplink.pointing.PointingElement

vega.uplink.pointing.PtrParameters.Offset.OffsetAngles

vega.uplink.pointing.PtrParameters.Offset.OffsetScan

Direct Known Subclasses:

ObservationOffsetScan

public class OffsetScan
extends OffsetAngles

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BORDERSLEWTIME_DEFAULT_UNIT min
static java.lang.String	BORDERSLEWTIME_FIELD borderSlewTime
static java.lang.String	KEEPLINEDIR_FIELD keepLineDir
static java.lang.String	KEEPSCANDIR_FIELD keepScanDir
static java.lang.String	LINEAXIS_FIELD lineAxis
static java.lang.String	LINEDELTA_DEFAULT_UNIT deg
static java.lang.String	LINEDELTA_FIELD lineDelta
static java.lang.String	LINESLEWTIME_DEFAULT_UNIT min
static java.lang.String	LINESLEWTIME_FIELD lineSlewTime
static java.lang.String	NUMBEROFLINES_FIELD numberOfLines
static java.lang.String	NUMBEROFSCANSPERLINE_FIELD numberOfScansPerLine
static java.lang.String	SCANDELTA_DEFAULT_UNIT deg
static java.lang.String	SCANDELTA_FIELD scanDelta
static java.lang.String	SCANSLEWTIME_DEFAULT_UNIT min
static java.lang.String	SCANSLEWTIME_FIELD scanSlewTime
static java.lang.String	SCANSPEED_DEFAULT_UNIT deg/min
static java.lang.String	SCANSPEED_FIELD scanSpeed
static java.lang.String	SCANTIME_DEFAULT_UNIT min
static java.lang.String	SCANTIME_FIELD scanTime
static java.lang.String	STARTTIME_FIELD startTime
static java.lang.String	XSTART_DEFAULT_UNIT deg
static java.lang.String	XSTART_FIELD xStart
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
OffsetScan(java.util.Date startTime, int numberOfLines, int numberOfScansPerLine, float xStart, float yStart, float scanDelta, float lineDelta, java.lang.Float scanTime, java.lang.Float scanSpeed, float scanSlewTime, float lineSlewTime, float borderSlewTime, java.lang.String lineAxis, boolean keepLineDir, boolean keepScanDir) A scan is defined if the element offsetAngles contains the attribute ref=scan.
OffsetScan(java.util.Date startTime, int numberOfLines, int numberOfScansPerLine, java.lang.String xStartUnit, float xStart, java.lang.String yStartUnit, float yStart, java.lang.String scanDeltaUnit, float scanDelta, java.lang.String lineDeltaUnit, float lineDelta, java.lang.String scanTimeUnit, java.lang.Float scanTime, java.lang.String scanSpeedUnit, java.lang.Float scanSpeed, java.lang.String scanSlewTimeUnit, float scanSlewTime, java.lang.String lineSlewTimeUnit, float lineSlewTime, java.lang.String borderSlewTimeUnit, float borderSlewTime, java.lang.String lineAxis, boolean keepLineDir, boolean keepScanDir) A scan is defined if the element offsetAngles contains the attribute ref=scan.
OffsetScan(PointingElement org)
OffsetScan(java.lang.String startTime) Scan crated with numberOfLines set to numberOfScansPerLine set to 1 xStart set to 0.0 deg yStart set to 0.0 deg scanDelta set to 0.0 deg lineDelta set to 0.0 deg scanTime set to 1 min.
OffsetScan(java.lang.String startTime, java.lang.String numberOfLines, java.lang.String numberOfScansPerLine, java.lang.String xStart, java.lang.String yStart, java.lang.String scanDelta, java.lang.String lineDelta, java.lang.String scanTime, java.lang.String scanSpeed, java.lang.String scanSlewTime, java.lang.String lineSlewTime, java.lang.String borderSlewTime, java.lang.String lineAxis, java.lang.String keepLineDir, java.lang.String keepScanDir) A scan is defined if the element offsetAngles contains the attribute ref=scan.

Method Summary

Methods

Modifier and Type	Method and Description
OffsetScan	copy()
float	getBorderSlewTime()
float	getBorderSlewTime(java.lang.String unit)
java.lang.String	getBorderSlewTimeUnit()
long	getDurationMilliSecs() Get the duration in milliseconds of this offset rotation
java.util.Date	getEndDate()
float	getLineSlewTime()
float	getLineSlewTime(java.lang.String unit)
java.lang.String	getLineSlewTimeUnit()
int	getNumberOfLines()
int	getNumberOfScansPerLine()
float	getScanDelta()
float	getScanDelta(java.lang.String unit)
java.lang.String	getScanDeltaUnit()
float	getScanSlewTime()
float	getScanSlewTime(java.lang.String unit)
java.lang.String	getScanSlewTimeUnit()
float	getScanSpeed()
float	getScanSpeed(java.lang.String unit)
java.lang.String	getScanSpeedUnit()
float	getScanTime()
float	getScanTime(java.lang.String unit)
java.lang.String	getScanTimeUnit()
java.util.Date	getStartDate()
boolean	isScan() True if this offset rotation is of the type scan.
void	setStartDate(java.util.Date date)

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

getStartTime, getUnit, isCustom, isFixed, isRaster, 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

NUMBEROFLINES_FIELD

public static java.lang.String NUMBEROFLINES_FIELD

numberOfLines

NUMBEROFSCANSPERLINE_FIELD

public static java.lang.String NUMBEROFSCANSPERLINE_FIELD

numberOfScansPerLine

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

SCANDELTA_FIELD

public static java.lang.String SCANDELTA_FIELD

scanDelta

SCANDELTA_DEFAULT_UNIT

public static java.lang.String SCANDELTA_DEFAULT_UNIT

deg

LINEDELTA_FIELD

public static java.lang.String LINEDELTA_FIELD

lineDelta

LINEDELTA_DEFAULT_UNIT

public static java.lang.String LINEDELTA_DEFAULT_UNIT

deg

SCANTIME_FIELD

public static java.lang.String SCANTIME_FIELD

scanTime

SCANTIME_DEFAULT_UNIT

public static java.lang.String SCANTIME_DEFAULT_UNIT

min

SCANSPEED_FIELD

public static java.lang.String SCANSPEED_FIELD

scanSpeed

SCANSPEED_DEFAULT_UNIT

public static java.lang.String SCANSPEED_DEFAULT_UNIT

deg/min

SCANSLEWTIME_FIELD

public static java.lang.String SCANSLEWTIME_FIELD

scanSlewTime

SCANSLEWTIME_DEFAULT_UNIT

public static java.lang.String SCANSLEWTIME_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

BORDERSLEWTIME_FIELD

public static java.lang.String BORDERSLEWTIME_FIELD

borderSlewTime

BORDERSLEWTIME_DEFAULT_UNIT

public static java.lang.String BORDERSLEWTIME_DEFAULT_UNIT

min

LINEAXIS_FIELD

public static java.lang.String LINEAXIS_FIELD

lineAxis

KEEPLINEDIR_FIELD

public static java.lang.String KEEPLINEDIR_FIELD

keepLineDir

KEEPSCANDIR_FIELD

public static java.lang.String KEEPSCANDIR_FIELD

keepScanDir

Constructor Detail

OffsetScan

public OffsetScan(PointingElement org)

OffsetScan

public OffsetScan(java.util.Date startTime,
          int numberOfLines,
          int numberOfScansPerLine,
          java.lang.String xStartUnit,
          float xStart,
          java.lang.String yStartUnit,
          float yStart,
          java.lang.String scanDeltaUnit,
          float scanDelta,
          java.lang.String lineDeltaUnit,
          float lineDelta,
          java.lang.String scanTimeUnit,
          java.lang.Float scanTime,
          java.lang.String scanSpeedUnit,
          java.lang.Float scanSpeed,
          java.lang.String scanSlewTimeUnit,
          float scanSlewTime,
          java.lang.String lineSlewTimeUnit,
          float lineSlewTime,
          java.lang.String borderSlewTimeUnit,
          float borderSlewTime,
          java.lang.String lineAxis,
          boolean keepLineDir,
          boolean keepScanDir)

A scan is defined if the element offsetAngles contains the attribute ref=scan. Before the scan start-time and after the last scan a slew is performed with duration borderSlewTime. Before the initial slew and after the final slew the offset angles are fixed to the angles at start of the first and the end of the last scan respectively.

Parameters:

startTime - Scan start time

numberOfLines - Number of lines along which a scan is performed

numberOfScansPerLine - Number of scans that are performed per line

xStartUnit - Unit used to express xStart. For example deg.

xStart - rotation angle of start point of first line towards offset-x-axis

yStartUnit - Unit used to express yStart. For example deg.

yStart - rotation angle of start point of first line towards offset-y-axis

scanDeltaUnit - Unit used to express scanDelta. For example deg.

scanDelta - Delta angle of one scan

lineDeltaUnit - Unit used to express lineDelta. For example deg.

lineDelta - Angular offset between two lines of the scan.

scanTimeUnit - Unit used to express scanTime. For example min.

scanTime - Duration of one scan. If this parameter is not null the parameter scanSpeed must be null.

scanSpeedUnit - Unit used to express scanSpeed. For example deg/min.

scanSpeed - Angular Speed of a scan.If this parameter is not null the parameter scanTime must be null.

scanSlewTimeUnit - Unit used to express scanSlewTime. For example min.

scanSlewTime - Slew time between two scans in the same line.

lineSlewTimeUnit - Unit used to express lineSlewTime. For example min.

lineSlewTime - Slew time between two scans in different lines.

borderSlewTimeUnit - Unit used to express borderSlewTime. For example min.

borderSlewTime - Slew time before first and after last scan to reach start angles of fisrts scan and final angles of last scan

lineAxis - Name of offset-axis along which the scans are performed

keepLineDir - Flag indicating whether the direction of the first scan line is kept for other lines (=true) or alternated (=false)

keepScanDir - Flag indicating whether the direction of the scan performed in one line is kept (=true) or alternated (=false)

OffsetScan

public OffsetScan(java.util.Date startTime,
          int numberOfLines,
          int numberOfScansPerLine,
          float xStart,
          float yStart,
          float scanDelta,
          float lineDelta,
          java.lang.Float scanTime,
          java.lang.Float scanSpeed,
          float scanSlewTime,
          float lineSlewTime,
          float borderSlewTime,
          java.lang.String lineAxis,
          boolean keepLineDir,
          boolean keepScanDir)

A scan is defined if the element offsetAngles contains the attribute ref=scan. Before the scan start-time and after the last scan a slew is performed with duration borderSlewTime. Before the initial slew and after the final slew the offset angles are fixed to the angles at start of the first and the end of the last scan respectively. Times are expressed in min, angles in deg and angular speed in deg/min.

Parameters:

startTime - Scan start time

numberOfLines - Number of lines along which a scan is performed

numberOfScansPerLine - Number of scans that are performed per line

xStart - rotation angle of start point of first line towards offset-x-axis

yStart - rotation angle of start point of first line towards offset-y-axis

scanDelta - Delta angle of one scan

lineDelta - Angular offset between two lines of the scan.

scanTime - Duration of one scan. If this parameter is not null the parameter scanSpeed must be null.

scanSpeed - Angular Speed of a scan.If this parameter is not null the parameter scanTime must be null.

scanSlewTime - Slew time between two scans in the same line.

lineSlewTime - Slew time between two scans in different lines.

borderSlewTime - Slew time before first and after last scan to reach start angles of fisrts scan and final angles of last scan

lineAxis - Name of offset-axis along which the scans are performed

keepLineDir - Flag indicating whether the direction of the first scan line is kept for other lines (=true) or alternated (=false)

keepScanDir - Flag indicating whether the direction of the scan performed in one line is kept (=true) or alternated (=false)

OffsetScan

public OffsetScan(java.lang.String startTime,
          java.lang.String numberOfLines,
          java.lang.String numberOfScansPerLine,
          java.lang.String xStart,
          java.lang.String yStart,
          java.lang.String scanDelta,
          java.lang.String lineDelta,
          java.lang.String scanTime,
          java.lang.String scanSpeed,
          java.lang.String scanSlewTime,
          java.lang.String lineSlewTime,
          java.lang.String borderSlewTime,
          java.lang.String lineAxis,
          java.lang.String keepLineDir,
          java.lang.String keepScanDir)
           throws java.text.ParseException

A scan is defined if the element offsetAngles contains the attribute ref=scan. Before the scan start-time and after the last scan a slew is performed with duration borderSlewTime. Before the initial slew and after the final slew the offset angles are fixed to the angles at start of the first and the end of the last scan respectively. Times are expressed in min, angles in deg and angular speed in deg/min.

Parameters:

startTime - Scan start time

numberOfLines - Number of lines along which a scan is performed

numberOfScansPerLine - Number of scans that are performed per line

xStart - rotation angle of start point of first line towards offset-x-axis

yStart - rotation angle of start point of first line towards offset-y-axis

scanDelta - Delta angle of one scan

lineDelta - Angular offset between two lines of the scan.

scanTime - Duration of one scan. If this parameter is not null the parameter scanSpeed must be null.

scanSpeed - Angular Speed of a scan.If this parameter is not null the parameter scanTime must be null.

scanSlewTime - Slew time between two scans in the same line.

lineSlewTime - Slew time between two scans in different lines.

borderSlewTime - Slew time before first and after last scan to reach start angles of fisrts scan and final angles of last scan

lineAxis - Name of offset-axis along which the scans are performed

keepLineDir - Flag indicating whether the direction of the first scan line is kept for other lines (=true) or alternated (=false)

keepScanDir - Flag indicating whether the direction of the scan performed in one line is kept (=true) or alternated (=false)

Throws:

java.text.ParseException

OffsetScan

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

Scan crated with numberOfLines set to numberOfScansPerLine set to 1 xStart set to 0.0 deg yStart set to 0.0 deg scanDelta set to 0.0 deg lineDelta set to 0.0 deg scanTime set to 1 min. scanSpeed set to null scanSlewTime set to 1 min. lineSlewTime set to 1.0 min. borderSlewTime set to 1.0 min. lineAxis set to y keepLIneDir set to false keepScanDir set to false

Parameters:

startTime -

Throws:

java.text.ParseException

Method Detail

getNumberOfLines

public int getNumberOfLines()

getNumberOfScansPerLine

public int getNumberOfScansPerLine()

getScanDelta

public float getScanDelta()

getScanDeltaUnit

public java.lang.String getScanDeltaUnit()

getScanDelta

public float getScanDelta(java.lang.String unit)

getBorderSlewTime

public float getBorderSlewTime()

getBorderSlewTimeUnit

public java.lang.String getBorderSlewTimeUnit()

getBorderSlewTime

public float getBorderSlewTime(java.lang.String unit)

getScanSpeed

public float getScanSpeed()

getScanSpeedUnit

public java.lang.String getScanSpeedUnit()

getScanSpeed

public float getScanSpeed(java.lang.String unit)

getScanTime

public float getScanTime()

getScanTimeUnit

public java.lang.String getScanTimeUnit()

getScanTime

public float getScanTime(java.lang.String unit)

getScanSlewTime

public float getScanSlewTime()

getScanSlewTimeUnit

public java.lang.String getScanSlewTimeUnit()

getScanSlewTime

public float getScanSlewTime(java.lang.String unit)

getLineSlewTime

public float getLineSlewTime()

getLineSlewTimeUnit

public java.lang.String getLineSlewTimeUnit()

getLineSlewTime

public float getLineSlewTime(java.lang.String unit)

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()

getEndDate

public java.util.Date getEndDate()

isScan

public boolean isScan()

Description copied from class: OffsetAngles

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

Overrides:

isScan in class OffsetAngles

Returns:

copy

public OffsetScan copy()

Specified by:

copy in class OffsetAngles