Chapter 1. DP Commands

Table of Contents

1.1. Introduction
1.1.1. How to use this chapter
1.2. accessPacket
1.3. browseDf
1.4. browseHk
1.5. browseProduct
1.6. CalFluxHotCold
1.7. CalHrsBadChans
1.8. CalHrsPowCorr
1.9. CalHrsQDCFast
1.10. CalHrsQDCFull
1.11. CalOffBaseline
1.12. CalPhases
1.13. CalWbsFreq
1.14. checkDataStructure
1.15. checkFreqGrid
1.16. checkPhases
1.17. checkPlatforming
1.18. cleanDF
1.19. ClearHifiFlagsTask
1.20. configureHifiPipeline
1.21. convertFrequency
1.22. convertK2Jy
1.23. convertSingleHifiSpectrum
1.24. convertTemp
1.25. DatasetWrapper
1.26. detectLines
1.27. DFTProduct
1.28. displayDataFrame
1.29. displayPacket
1.30. doAntennaTemp
1.31. doAvg
1.32. doBadLo
1.33. doChannelFlags
1.34. doChannelWeights
1.35. doCleanUp
1.36. doDeconvolution
1.37. doFilterLoads
1.38. doFluxHotCold
1.39. doFold
1.40. doFreqGrid
1.41. doGridding
1.42. doHebCorrection
1.43. doHkCheck
1.44. doHrsCorrSP
1.45. doHrsCutBandEdges
1.46. doHrsFFT
1.47. doHrsFreq
1.48. doHrsNorm
1.49. doHrsOffsetPow
1.50. doHrsPowCorr
1.51. doHrsQDCFast
1.52. doHrsQDCFull
1.53. doHrsSmooth
1.54. doHrsSubbands
1.55. doHrsSymm
1.56. doHrsWindow
1.57. doMainBeamTemp
1.58. doOffset
1.59. doOffSubtract
1.60. doPipelineConfiguration
1.61. doPointing
1.62. doRadialVelocity
1.63. doRefSubtract
1.64. doSidebandGain
1.65. doSpectrumStatistics
1.66. doStitch
1.67. doSubtractMedian
1.68. doTimeCorr
1.69. doUplink
1.70. doVelocityCorrection
1.71. doWbsBadPixels
1.72. doWbsCrFlag
1.73. doWbsDark
1.74. doWbsFreq
1.75. doWbsNonlin
1.76. doWbsScanCount
1.77. doWbsSubbands
1.78. doWbsZero
1.79. exportLines
1.80. fitBaseline
1.81. fitHifiFringe
1.82. flagTool
1.83. FreqRanges
1.84. getChannelFlags
1.85. getHifiCal
1.86. gridding
1.87. hebCorrection
1.88. hiClass
1.89. hifiDeconToClass
1.90. hifiPipeline
1.91. HifiProduct
1.92. hifiProductValidation
1.93. HifiTimelineProduct
1.94. hrsPipeline
1.95. identifyLinesCatalog
1.96. identifyLines
1.97. level1Pipeline
1.98. level25Pipeline
1.99. level2Pipeline
1.100. mergeHtps
1.101. mkFlagSummary
1.102. mkFluxHotCold
1.103. mkFreqGrid
1.104. mkGrid
1.105. mkOffSmooth
1.106. mkRef
1.107. mkRms
1.108. mkSidebandGain
1.109. mkSpur
1.110. mkUncertaintyTable
1.111. mkWbsBadPixels
1.112. mkWbsFluxAtten
1.113. mkWbsFreqFromHrs
1.114. mkWbsFreq
1.115. mkWbsZero
1.116. None
1.117. PipelineConfiguration
1.118. polarPair
1.119. removeFlaggedPixels
1.120. selectHifi
1.121. SetHifiChannelFlagsTask
1.122. SetHifiRowFlagsTask
1.123. undoSidebandGain
1.124. userFlag
1.125. wbsPipeline

1.1. Introduction

This chapter is a listing of built-in HIPE functions, task and objects, collectively referred to as commands.

1.1.1. How to use this chapter

A first section gives a general overview what a command is used for and how to use it. This includes a general description and some examples. The "API summary" section provides a quick overview of the available constructors, methods and properties of a command. It is intended as quick reference for users that just need to remember a certain functionality. The "API details" section provides more detailed information about the constructors, methods and properties. Furthermore it provides links to other references and information about the command's history.

1.1.1.1. Overview

A table gives the full name of the command, indicates if it is written in Java or Jython and if it is just an ordinary command or if it follows the HCSS Task specifications. The import statement in this table can be copied to a Jython console.

Description

General description of the command.

Examples

Most commands include one or more examples that demonstrates how the command is used. Most of the examples are just one or two lines of DP code that can be entered at the Jython prompt. Others are code fragments or routines designed to serve as an examples for your own programs.

Limitations and Miscellaneous

The "Limitations" and "Miscellaneous" sections describes the boundaries of applicability and other specialties of the command.

1.1.1.2. API Summary

The API Summary provides a quick summary of the commands constructor, method, and properties. Note that most of the arguments are positional parameters that must be supplied in the order indicated by the command's syntax. However arguments can be often supplied by specifying their names. If its the case then they can provided in any order.

Constructor

Constructors are used to create a command.

Method

Methods are functions of a command that can be executed.

Properties

Properties are fields of a command that can be read or written by a command. INPUT properties contain values that are required by a command, OUTPUT properties contain the result of a command, INOUT provide both functionalities at the same time.

1.1.1.3. See also

The "See also" section provides links to related commands, to other manuals, or to external resources in the Internet.

1.1.1.4. History

The "History" section describes the changes occurred to the command.