Upload
others
View
4
Download
0
Embed Size (px)
Citation preview
HCSS User's Reference Manual
Herschel Data Processing
Version 10.0, Document Number: HERSCHEL-HSC-DOC-093510 April 2017
Build 15.0.3262
HCSS User's Reference Manual: Herschel Data Processing
Build 15.0.3262
Table of ContentsI. Categorised view of commands .................................................................................. xiiII. How to use this manual ....................................................................................... xxviii
II.1. Related documentation .............................................................................. xxviiiIII. Dictionary .......................................................................................................... xxix1. DP Commands .......................................................................................................... 1
1.1. Introduction .................................................................................................... 11.2. Aberration ...................................................................................................... 31.3. ABS .............................................................................................................. 81.4. AbstractBasicModel ......................................................................................... 91.5. AbstractFitter ................................................................................................ 101.6. AbstractModel .............................................................................................. 131.7. accumulate ................................................................................................... 171.8. add .............................................................................................................. 211.9. ALL ............................................................................................................ 251.10. AllPresent ................................................................................................... 271.11. AmoebaFitter .............................................................................................. 291.12. angles2RotationMatrix .................................................................................. 311.13. AnnotationToolbox ...................................................................................... 321.14. annularSkyAperturePhotometry ...................................................................... 341.15. AnnularSkyAperturePhotometryProduct ........................................................... 381.16. ANY ......................................................................................................... 431.17. AnyPresent ................................................................................................. 451.18. ARCCOS ................................................................................................... 471.19. ARCCOSH ................................................................................................. 481.20. ARCSIN ..................................................................................................... 491.21. ARCSINH .................................................................................................. 501.22. ARCTANCONTFRAC ................................................................................. 511.23. ARCTAN ................................................................................................... 531.24. ARCTANH ................................................................................................. 541.25. ArctanModel ............................................................................................... 551.26. ArrayAssistant ............................................................................................. 561.27. asciiTableReader .......................................................................................... 571.28. asciiTableWriter .......................................................................................... 691.29. astrometryFix .............................................................................................. 771.30. AttribQuery ................................................................................................ 801.31. autoCorrelation ............................................................................................ 811.32. automaticContour ......................................................................................... 821.33. avg ............................................................................................................ 841.34. axisAngle2RotationMatrix ............................................................................. 901.35. bg ............................................................................................................. 911.36. Bilinear ...................................................................................................... 931.37. BinCentres .................................................................................................. 991.38. BinomialModel .......................................................................................... 1011.39. Bool1d ..................................................................................................... 1021.40. Bool2d ..................................................................................................... 1031.41. Bool3d ..................................................................................................... 1041.42. Bool4d ..................................................................................................... 1051.43. Bool5d ..................................................................................................... 1061.44. BoxCarFilter ............................................................................................. 1071.45. boxCarSmoothing ....................................................................................... 1091.46. Byte1d ..................................................................................................... 1101.47. Byte2d ..................................................................................................... 1111.48. Byte3d ..................................................................................................... 1121.49. Byte4d ..................................................................................................... 1131.50. Byte5d ..................................................................................................... 114
iii
HCSS User's Reference Manual Build 15.0.3262
1.51. CachedPool ............................................................................................... 1151.52. calc_errcov ................................................................................................ 1171.53. calcAttitude ............................................................................................... 1191.54. calcGyroAttitude ........................................................................................ 1221.55. calcStrAttitude ........................................................................................... 1261.56. CauchyErrorDistribution .............................................................................. 1311.57. CEIL ........................................................................................................ 1321.58. ChebyshevPolynomialModel ........................................................................ 1331.59. ChiSquared ............................................................................................... 1341.60. CholeskyDecomposition .............................................................................. 1361.61. circleHistogram .......................................................................................... 1381.62. CircleHistogramProduct ............................................................................... 1411.63. clamp ....................................................................................................... 1441.64. clear ......................................................................................................... 1461.65. ComboModel ............................................................................................. 1481.66. Complex1d ................................................................................................ 1491.67. Complex2d ................................................................................................ 1501.68. Complex3d ................................................................................................ 1511.69. Complex4d ................................................................................................ 1521.70. Complex5d ................................................................................................ 1531.71. compress .................................................................................................. 1541.72. computePVMap ......................................................................................... 1561.73. computeVelocityMap .................................................................................. 1581.74. CONCATENATE ...................................................................................... 1611.75. Condense .................................................................................................. 1621.76. ConjugateGradientFitter ............................................................................... 1661.77. ConstantModel ........................................................................................... 1671.78. ContainerModel ......................................................................................... 1681.79. ContinuousWavelet ..................................................................................... 1691.80. Contour .................................................................................................... 1711.81. contour ..................................................................................................... 1731.82. ContourLevel ............................................................................................. 1751.83. convertAngles ............................................................................................ 1771.84. convertImageUnit ....................................................................................... 1801.85. convertUnits .............................................................................................. 1821.86. convertWavescale ....................................................................................... 1841.87. Convolution .............................................................................................. 1871.88. CoordsTranslator ........................................................................................ 1931.89. Correlate ................................................................................................... 1951.90. CorrelateMatrix .......................................................................................... 1971.91. COS ......................................................................................................... 1981.92. COSH ...................................................................................................... 2001.93. Covariance ................................................................................................ 2011.94. CovarianceMatrix ....................................................................................... 2031.95. createRgbImage ......................................................................................... 2041.96. cropCube .................................................................................................. 2071.97. crop ......................................................................................................... 2091.98. crossCorrelation ......................................................................................... 2111.99. CubicSplineInterpolator ............................................................................... 2121.100. cutLevels ................................................................................................ 2141.101. CWavelet ................................................................................................ 2161.102. Cwt ........................................................................................................ 2191.103. DataFormatter .......................................................................................... 2211.104. decompress .............................................................................................. 2231.105. DERIV ................................................................................................... 2251.106. DETERMINANT ..................................................................................... 2261.107. dFT2d ..................................................................................................... 2271.108. DiscreteWavelet ....................................................................................... 228
iv
HCSS User's Reference Manual Build 15.0.3262
1.109. Display ................................................................................................... 2311.110. DistortionMaps ......................................................................................... 2791.111. divide ..................................................................................................... 2801.112. Double1d ................................................................................................ 2841.113. Double2d ................................................................................................ 2851.114. Double3d ................................................................................................ 2861.115. Double4d ................................................................................................ 2871.116. Double5d ................................................................................................ 2881.117. Dwt ........................................................................................................ 2891.118. EigenvalueDecomposition .......................................................................... 2911.119. ellipseHistogram ....................................................................................... 2931.120. EllipseHistogramProduct ............................................................................ 2961.121. EngineList ............................................................................................... 3001.122. ERFC ..................................................................................................... 3011.123. ERF ....................................................................................................... 3021.124. est_attitude_new ....................................................................................... 3031.125. est_attitude .............................................................................................. 3061.126. EXP10 .................................................................................................... 3091.127. EXP ....................................................................................................... 3101.128. ExpModel ............................................................................................... 3121.129. ExpN ...................................................................................................... 3131.130. ExponentialPrior ....................................................................................... 3151.131. exportObservation ..................................................................................... 3161.132. exportSpectrumToAscii ............................................................................. 3181.133. extract .................................................................................................... 3211.134. extractRegionSpectrum .............................................................................. 3251.135. Factor ..................................................................................................... 3271.136. Factory ................................................................................................... 3281.137. fFT2d ..................................................................................................... 3291.138. FFT_AUTO ............................................................................................. 3301.139. FFT_PACK_EVEN ................................................................................... 3321.140. FFT_PACK_ODD .................................................................................... 3351.141. FFT_PACK ............................................................................................. 3381.142. FFT ........................................................................................................ 3401.143. filterSpectrum .......................................................................................... 3421.144. FitFringeData ........................................................................................... 3441.145. fitFringe .................................................................................................. 3461.146. FitsArchive .............................................................................................. 3501.147. fitsReader ................................................................................................ 3661.148. FitterFunction .......................................................................................... 3681.149. Fitter ...................................................................................................... 3701.150. FixedMask .............................................................................................. 3731.151. fixedSkyAperturePhotometry ...................................................................... 3761.152. FixedSkyAperturePhotometryProduct ........................................................... 3791.153. FIX ........................................................................................................ 3831.154. Flag ....................................................................................................... 3851.155. flagPixels ................................................................................................ 3931.156. flagSaturatedPixelsCube ............................................................................. 3961.157. flagSaturatedPixels .................................................................................... 3971.158. Float1d ................................................................................................... 3981.159. Float2d ................................................................................................... 3991.160. Float3d ................................................................................................... 4001.161. Float4d ................................................................................................... 4011.162. Float5d ................................................................................................... 4021.163. FLOOR .................................................................................................. 4031.164. fold ........................................................................................................ 4041.165. FreeShapeModel ....................................................................................... 4061.166. FullQuery ................................................................................................ 407
v
HCSS User's Reference Manual Build 15.0.3262
1.167. GAMMALN ............................................................................................ 4081.168. GammaP ................................................................................................. 4091.169. GammaQ ................................................................................................ 4111.170. Gauss2DModel ......................................................................................... 4131.171. Gauss2DRotModel .................................................................................... 4141.172. GaussErrorDistribution .............................................................................. 4161.173. GaussianFilter .......................................................................................... 4171.174. gaussianSmoothing ................................................................................... 4181.175. GaussModel ............................................................................................. 4191.176. GEOMEAN ............................................................................................. 4201.177. getObservation ......................................................................................... 4211.178. HAMMING ............................................................................................. 4271.179. HANNING .............................................................................................. 4291.180. HarmonicDynamicModel ........................................................................... 4311.181. HarmonicModel ....................................................................................... 4321.182. HduHeaders ............................................................................................. 4331.183. help ........................................................................................................ 4351.184. Histogram ............................................................................................... 4371.185. historyExtract ........................................................................................... 4391.186. HttpClientFactory ..................................................................................... 4411.187. imageAbs ................................................................................................ 4421.188. imageAdd ................................................................................................ 4431.189. ImageAxis ............................................................................................... 4451.190. imageCeil ................................................................................................ 4541.191. ImageContourExplorer ............................................................................... 4551.192. ImageContour .......................................................................................... 4571.193. imageContourSaver ................................................................................... 4611.194. imageConvolution ..................................................................................... 4631.195. imageDivide ............................................................................................ 4651.196. imageExp10 ............................................................................................. 4671.197. imageExp ................................................................................................ 4681.198. imageExpN ............................................................................................. 4691.199. imageFloor .............................................................................................. 4701.200. imageHistogram ....................................................................................... 4711.201. ImageHistogramProduct ............................................................................. 4731.202. imageLog10 ............................................................................................. 4761.203. imageLog ................................................................................................ 4771.204. imageLogN ............................................................................................. 4781.205. imageModulo ........................................................................................... 4791.206. imageMultiply .......................................................................................... 4811.207. imagePower ............................................................................................. 4831.208. imageRound ............................................................................................ 4841.209. imageSaver .............................................................................................. 4851.210. imageSqrt ................................................................................................ 4861.211. imageSquare ............................................................................................ 4871.212. imageSubtract .......................................................................................... 4881.213. importCube ............................................................................................. 4901.214. importImage ............................................................................................ 4911.215. importRgbImage ....................................................................................... 4921.216. importSpectralCube ................................................................................... 4931.217. importSpectrumFromAscii .......................................................................... 4941.218. Int1d ...................................................................................................... 4971.219. Int2d ...................................................................................................... 4981.220. Int3d ...................................................................................................... 4991.221. Int4d ...................................................................................................... 5001.222. Int5d ...................................................................................................... 5011.223. integrateSpectralMap ................................................................................. 5021.224. Integrator ................................................................................................ 504
vi
HCSS User's Reference Manual Build 15.0.3262
1.225. IntensityCalculator .................................................................................... 5061.226. IntTabulated ............................................................................................ 5071.227. inverseDFT2d .......................................................................................... 5091.228. inverseFFT2d ........................................................................................... 5101.229. INVERSE ............................................................................................... 5111.230. IS_ANY_NAN ......................................................................................... 5121.231. IS_FINITE .............................................................................................. 5131.232. IS_INFINITE ........................................................................................... 5151.233. IS_NAN .................................................................................................. 5171.234. JeffreysPrior ............................................................................................ 5191.235. Kernel2dModel ........................................................................................ 5201.236. Kernel .................................................................................................... 5221.237. KernelModel ............................................................................................ 5231.238. KernelModel ............................................................................................ 5241.239. KURTOSIS ............................................................................................. 5251.240. LaplaceErrorDistribution ............................................................................ 5271.241. LaplacePrior ............................................................................................ 5281.242. LevenbergMarquardtFitter .......................................................................... 5291.243. LinearInterpolator ..................................................................................... 5311.244. ListContext .............................................................................................. 5331.245. localStoreCopier ....................................................................................... 5351.246. LOG10 ................................................................................................... 5371.247. LogFactorial ............................................................................................ 5381.248. LOG ....................................................................................................... 5391.249. LogN ...................................................................................................... 5401.250. Long1d ................................................................................................... 5421.251. Long2d ................................................................................................... 5431.252. Long3d ................................................................................................... 5441.253. Long4d ................................................................................................... 5451.254. Long5d ................................................................................................... 5461.255. LorentzModel .......................................................................................... 5471.256. manualContour ......................................................................................... 5481.257. MapContext ............................................................................................. 5501.258. MATRIXMULTIPLY ............................................................................... 5521.259. MATRIXSOLVE ...................................................................................... 5541.260. MAX ...................................................................................................... 5561.261. MEAN .................................................................................................... 5581.262. meanSmoothing ........................................................................................ 5601.263. MedianAbsoluteDeviation .......................................................................... 5611.264. MEDIAN ................................................................................................ 5631.265. medianSmoothing ..................................................................................... 5651.266. MetaQuery .............................................................................................. 5661.267. MIN ....................................................................................................... 5671.268. MinpackFunc ........................................................................................... 5691.269. MinpackPro ............................................................................................. 5701.270. MODE .................................................................................................... 5711.271. modelFit ................................................................................................. 5721.272. MonteCarloError ...................................................................................... 5771.273. MoreRandom ........................................................................................... 5791.274. mosaic .................................................................................................... 5841.275. MpFitter .................................................................................................. 5861.276. multiply .................................................................................................. 5881.277. NAN_FILTER ......................................................................................... 5921.278. NearestNeighborInterpolator ....................................................................... 5941.279. nearestNeighbourProjection ........................................................................ 5961.280. NestedSampler ......................................................................................... 5991.281. NoiseScale .............................................................................................. 6011.282. Normalize ............................................................................................... 602
vii
HCSS User's Reference Manual Build 15.0.3262
1.283. NotPresent ............................................................................................... 6051.284. nSigmaClip ............................................................................................. 6071.285. NullModel ............................................................................................... 6081.286. ObservationContext ................................................................................... 6091.287. openFile .................................................................................................. 6111.288. openSE ................................................................................................... 6131.289. openTask ................................................................................................ 6151.290. openVariable ........................................................................................... 6171.291. OverPlotter .............................................................................................. 6191.292. PackedMask ............................................................................................ 6221.293. PacketSequence ........................................................................................ 6241.294. PadeModel .............................................................................................. 6251.295. pairAvg .................................................................................................. 6261.296. ParameterCube ......................................................................................... 6301.297. Planck .................................................................................................... 6341.298. pointHistoryDisplay .................................................................................. 6381.299. PoissonErrorDistribution ............................................................................ 6401.300. Polygon .................................................................................................. 6411.301. polygonHistogram .................................................................................... 6431.302. PolygonHistogramProduct .......................................................................... 6451.303. PolygonIntersect ....................................................................................... 6481.304. PolynomialDynamicModel ......................................................................... 6491.305. Polynomial .............................................................................................. 6501.306. PolynomialModel ..................................................................................... 6521.307. PolySurfaceModel .................................................................................... 6531.308. PoolManager ........................................................................................... 6541.309. PositionList ............................................................................................. 6551.310. PowerLawModel ...................................................................................... 6571.311. PowerModel ............................................................................................ 6581.312. PowerSpectrum ........................................................................................ 6591.313. Pow ....................................................................................................... 6611.314. PreviousInterpolator .................................................................................. 6631.315. PrfGaussian ............................................................................................. 6651.316. PrfImage ................................................................................................. 6661.317. PriorList .................................................................................................. 6671.318. ProductBrowserTools ................................................................................ 6681.319. PRODUCT .............................................................................................. 6701.320. ProductRef .............................................................................................. 6721.321. ProductStorage ......................................................................................... 6741.322. Profile .................................................................................................... 6801.323. profile ..................................................................................................... 6851.324. qMethod ................................................................................................. 6871.325. QRDecomposition .................................................................................... 6891.326. QRMS .................................................................................................... 6911.327. quat_to_att .............................................................................................. 6931.328. raDecRoll2xyz ......................................................................................... 6941.329. RadialV .................................................................................................. 6961.330. radialV ................................................................................................... 7011.331. RandomGauss .......................................................................................... 7051.332. RandomPoisson ........................................................................................ 7061.333. RandomUniform ....................................................................................... 7071.334. RealDoubleFFT ........................................................................................ 7081.335. Rebin ..................................................................................................... 7111.336. rectangleHistogram ................................................................................... 7141.337. RectangleHistogramProduct ........................................................................ 7171.338. rectangularSkyAperturePhotometry .............................................................. 7211.339. RectangularSkyAperturePhotometryProduct ................................................... 7261.340. Regrid .................................................................................................... 731
viii
HCSS User's Reference Manual Build 15.0.3262
1.341. regrid ..................................................................................................... 7391.342. removeBaselineFromCube .......................................................................... 7411.343. REPEAT ................................................................................................. 7431.344. replace .................................................................................................... 7441.345. resample ................................................................................................. 7461.346. RESHAPE ............................................................................................... 7501.347. Restarter ................................................................................................. 7521.348. restore .................................................................................................... 7531.349. REVERSE ............................................................................................... 7551.350. RgbSimpleImage ...................................................................................... 7561.351. RMS ...................................................................................................... 7621.352. RobustClipWeight .................................................................................... 7641.353. RobustCosineWeight ................................................................................. 7651.354. RobustMedianWeight ................................................................................ 7661.355. RobustShell ............................................................................................. 7671.356. RobustTukeyWeight .................................................................................. 7691.357. Rotate ..................................................................................................... 7701.358. rotate ...................................................................................................... 7731.359. ROUND .................................................................................................. 7761.360. SampleList .............................................................................................. 7781.361. SampleProduct ......................................................................................... 7791.362. save ....................................................................................................... 7801.363. saveObservation ....................................................................................... 7821.364. saveProduct ............................................................................................. 7841.365. saveProduct ............................................................................................. 7851.366. scale ....................................................................................................... 7871.367. select ...................................................................................................... 7901.368. SerialArchive ........................................................................................... 7931.369. SHIFT .................................................................................................... 7971.370. Short1d ................................................................................................... 7991.371. Short2d ................................................................................................... 8001.372. Short3d ................................................................................................... 8011.373. Short4d ................................................................................................... 8021.374. Short5d ................................................................................................... 8031.375. SideBandGED .......................................................................................... 8041.376. SideBandModel ........................................................................................ 8051.377. SideBandRatioGED .................................................................................. 8061.378. SideBandRatioModel ................................................................................. 8071.379. Sigclip .................................................................................................... 8081.380. SIGNUM ................................................................................................ 8111.381. SimpleCube ............................................................................................. 8131.382. simpleFitsReader ...................................................................................... 8261.383. simpleFitsWriter ....................................................................................... 8281.384. SimpleImage ............................................................................................ 8301.385. SimpleSpectrum ....................................................................................... 8461.386. SincGaussModel ....................................................................................... 8471.387. SINC ...................................................................................................... 8491.388. SincModel ............................................................................................... 8511.389. SineAmpModel ........................................................................................ 8521.390. SineModel ............................................................................................... 8531.391. SingularValueDecompositionFitter ............................................................... 8541.392. SingularValueDecomposition ...................................................................... 8551.393. SIN ........................................................................................................ 8571.394. SINH ...................................................................................................... 8591.395. SkewGaussModel ..................................................................................... 8601.396. SKEWNESS ............................................................................................ 8621.397. SkyMaskToolbox ...................................................................................... 8641.398. smoothBaseline ........................................................................................ 866
ix
HCSS User's Reference Manual Build 15.0.3262
1.399. smooth .................................................................................................... 8681.400. SORT ..................................................................................................... 8711.401. sortTable ................................................................................................. 8731.402. sourceExtractorDaophot ............................................................................. 8751.403. sourceExtractor ........................................................................................ 8811.404. sourceExtractorSimultaneous ...................................................................... 8821.405. sourceExtractorSussextractor ...................................................................... 8851.406. sourceFit ................................................................................................. 8901.407. sourceFitting ............................................................................................ 8951.408. SourceFittingProduct ................................................................................. 8981.409. SpectralLineList ....................................................................................... 9131.410. SpectralSimpleCube .................................................................................. 9141.411. Spectrum1d ............................................................................................. 9151.412. Spectrum2d ............................................................................................. 9171.413. SpectrumContainerBox .............................................................................. 9191.414. SpectrumContainer .................................................................................... 9201.415. SplinesModel ........................................................................................... 9221.416. SQRT ..................................................................................................... 9251.417. SQUARE ................................................................................................ 9261.418. Sso ......................................................................................................... 9271.419. StationaryWavelet ..................................................................................... 9301.420. statistics .................................................................................................. 9331.421. StatWithNaN ........................................................................................... 9371.422. STDDEV ................................................................................................ 9391.423. stitch ...................................................................................................... 9411.424. StrCalibration ........................................................................................... 9461.425. strExtractVelocityFromTeleCommHistory ..................................................... 9481.426. String1d .................................................................................................. 9491.427. subtract ................................................................................................... 9501.428. SUM ...................................................................................................... 9541.429. SurfaceSplinesModel ................................................................................. 9561.430. Swt ........................................................................................................ 9571.431. TablePlotter ............................................................................................. 9581.432. tableToVo ............................................................................................... 9661.433. TAN ....................................................................................................... 9671.434. TANH .................................................................................................... 9691.435. tiledImage ............................................................................................... 9701.436. translate .................................................................................................. 9721.437. TRANSPOSE .......................................................................................... 9741.438. transpose ................................................................................................. 9751.439. UniformPrior ........................................................................................... 9771.440. UNIQ_SORTED ...................................................................................... 9781.441. UNIQ ..................................................................................................... 9801.442. UNWRAP ............................................................................................... 9821.443. updateDataset ........................................................................................... 9841.444. updateMetadata ........................................................................................ 9861.445. VARIANCE ............................................................................................ 9881.446. VoigtModel ............................................................................................. 9901.447. voToTable ............................................................................................... 9911.448. Wcs ....................................................................................................... 9921.449. WeightedMean ....................................................................................... 10191.450. xyz2raDecRoll ........................................................................................ 1021
x
Build 15.0.3262
List of Tables1.1. Polynomial table. ................................................................................................. 1011.2. Kernel table. ....................................................................................................... 5201.3. Kernel table. ....................................................................................................... 5221.4. Polynomial table. ................................................................................................. 6531.5. Weighting scheme table. ....................................................................................... 7641.6. Weighting scheme table. ....................................................................................... 7651.7. Weighting scheme table. ....................................................................................... 7661.8. Weighting scheme table. ....................................................................................... 7691.9. Splines table. ...................................................................................................... 922
xi
Build 15.0.3262
Categorised view of commandsThis chapter provides a categorised view of all built-in DP functions, tasks and objects.
Arrays and datasets
Bool1d - A rectangular numeric boolean array of rank 1.
Bool2d - A rectangular numeric boolean array of rank 2.
Bool3d - A rectangular numeric boolean array of rank 3.
Bool4d - A rectangular numeric boolean array of rank 4.
Bool5d - A rectangular numeric boolean array of rank 5.
Byte1d - A rectangular numeric byte array of rank 1.
Byte2d - A rectangular numeric byte array of rank 2.
Byte3d - A rectangular numeric byte array of rank 3.
Byte4d - A rectangular numeric byte array of rank 4.
Byte5d - A rectangular numeric byte array of rank 5.
Complex1d - A rectangular numeric Complex array of rank 1.
Complex2d - A rectangular numeric Complex array of rank 2.
Complex3d - A rectangular numeric Complex array of rank 3.
Complex4d - A rectangular numeric Complex array of rank 4.
Complex5d - A rectangular numeric Complex array of rank 5.
Double1d - A rectangular numeric double array of rank 1.
Double2d - A rectangular numeric double array of rank 2.
Double3d - A rectangular numeric double array of rank 3.
Double4d - A rectangular numeric double array of rank 4.
Double5d - A rectangular numeric double array of rank 5.
Float1d - A rectangular numeric float array of rank 1.
Float2d - A rectangular numeric float array of rank 2.
Float3d - A rectangular numeric float array of rank 3.
Float4d - A rectangular numeric float array of rank 4.
Float5d - A rectangular numeric float array of rank 5.
Int1d - A rectangular numeric int array of rank 1.
Int2d - A rectangular numeric int array of rank 2.
Int3d - A rectangular numeric int array of rank 3.
Int4d - A rectangular numeric int array of rank 4.
Int5d - A rectangular numeric int array of rank 5.
Long1d - A rectangular numeric long array of rank 1.
Long2d - A rectangular numeric long array of rank 2.
xii
Categorised view of commands Build 15.0.3262
Long3d - A rectangular numeric long array of rank 3.
Long4d - A rectangular numeric long array of rank 4.
Long5d - A rectangular numeric long array of rank 5.
ObservationContext - An Observation Context is a container of Products applicable to aspecific observation.
Polynomial - Returns the value of a polynomial, given its coefficients, at a series of posi-tions.
Short1d - A rectangular numeric short array of rank 1.
Short2d - A rectangular numeric short array of rank 2.
Short3d - A rectangular numeric short array of rank 3.
Short4d - A rectangular numeric short array of rank 4.
Short5d - A rectangular numeric short array of rank 5.
String1d - A rectangular numeric String array of rank 1.
Display
OverPlotter - Overview of OverPlotter
TablePlotter - TablePlotter is a GUI tool to view and analyze instances of Table-Dataset.
Element selection
ALL - Determines whether all the elements of an array satisfy an expression.
AllPresent - Checks whether all the bits in the specified bitmask are present in the el-ements of the input array.
ANY - Determines whether any element of an array satisfies an expression.
AnyPresent - Checks whether any of the bits in the specified bitmask are present inthe elements of the input array.
IS_ANY_NAN - Checks if the given array contains a NaN value.
IS_FINITE - Checks whether a number or the elements of an array are finite.
IS_INFINITE - Checks whether a number or the elements of an array are infinite.
IS_NAN - Checks whether a number or the elements of an array are NaN (Not aNumber).
NAN_FILTER - Returns an array without any NaN (Not a Number) elements.
NotPresent - Checks whether none of the bits in the specified bitmask are present inthe elements of the input array.
UNIQ_SORTED - Returns the unique elements of a sorted array.
UNIQ - Returns the unique elements of an array.
Manipulation
CONCATENATE - Concatenates an array of rank greater than one into an array ofrank 1 of the same type.
convertAngles - Converts angles between numeric and textual representations.
convertUnits - Converts numeric data expressed in one unit, in terms of another unit.
xiii
Categorised view of commands Build 15.0.3262
FIX - For each element of an array, returns the largest integer less than or equal tothe element.
Normalize - Normalizes sets of data.
PRODUCT - Returns the product of all the elements of an array.
REPEAT - Creates a new array which contains the specified repetitions of the origi-nal array.
RESHAPE - Creates a new array of the same type as the input array but with a dif-ferent shape.
REVERSE - Reverses the order of the elements of a one-dimensional array.
Rotate - Rotates a Numeric two- or three-dimensional array.
ROUND - Returns the input number or array rounded to the nearest integer or deci-mal position.
SHIFT - Shifts the elements of an array along the specified dimension.
SORT - Sorts the specified array into ascending natural order.
sortTable - Returns a new table with rows sorted.
UNWRAP - Unwraps the radian phase angles in an array.
updateDataset - Updates a dataset in a context hierarchy so that the changes are pre-served in the context tree.
updateMetadata - Updates metadata in a context hierarchy so that the changes arepreserved in the context tree.
Reduction
Condense - Condenses an array along a given dimension by applying a function togroups of array items.
MAX - Returns the value of the largest element in the input array.
MIN - Returns the value of the smallest element in the input array.
StatWithNaN - Removes NaN variables from input arrays to other numeric func-tions.
SUM - Returns the sum of all the elements of an array.
Astronomical utilities
Aberration - Obtain astrometric and geometric positions from apparent ones.
astrometryFix - This task changes the astrometry in the input data to make it consistentwith some other data.
Planck - Computes the Planck function.
pointHistoryDisplay - Task for displaying graphs of pointing information.
RadialV - Calculates S/C velocity projection in the direction of the pointing (radial veloci-ty).
radialV - The RadialV Task calculates S/C radial velocity projection in the direction of thepointing.
Sso - Tools for SSO centred coordinate systems.
Photometry
xiv
Categorised view of commands Build 15.0.3262
annularSkyAperturePhotometry - This is a task that performs aperture photometry oftarget, enclosed
AnnularSkyAperturePhotometryProduct - This is a class to deal with the results ofaperture photometry with a circular target aperture and an annular sky aperture.
fixedSkyAperturePhotometry - This is a task for aperture photometry for a circulartarget aperture.
FixedSkyAperturePhotometryProduct - This is a class to deal with the results ofaperture photometry with a circular target aperture and a fixed value for the sky intensi-ty.
rectangularSkyAperturePhotometry - This is a task for aperture photometry for arectangular target
RectangularSkyAperturePhotometryProduct - This is a class to deal with the resultsof aperture photometry with a circular target aperture and an rectangular sky aperture.
SourceFittingProduct - A class to handle the result of the SourceFittingTask.
Source extraction
PrfGaussian - A representation of a Gaussian point response function as an Image.
PrfImage - A representation of a point response function based on an image.
sourceExtractorDaophot - This task extracts point sources from an HCSS SimpleIm-age image using DAOPHOT.
sourceExtractorSimultaneous - This task measures point source photometry of multi-ple sources simultaneously using linear inversion method.
sourceExtractorSussextractor - This task extracts point sources from an HCSS Sim-pleImage image using SUSSEXtractor.
sourceFitting - This is a task to fit a two-dimensional gaussian to a source in a
Data access
AttribQuery - Attribute Query formulates a query on the attributes of a Product.
CachedPool - Implementation of a PAL ProductPool that adds caching functionality to aremote ProductPool.
exportObservation - Exports observations from a pool to an HSA hierarchical directorystructure.
FullQuery - A data mining query formulates a query the full interface of a Product.
HttpClientFactory - Factory class to create HttpClientPool instances.
ListContext - Groups products (or other Contexts that in turn group products) in a list-likestructure.
localStoreCopier - Creates a copy of a LocalStore (pool).
MapContext - Groups products (or other Contexts that in turn group products) in a map-like structure.
MetaQuery - Meta data query formulates a query on the meta data of a Product.
PoolManager - The PoolManager provides the means to reference Product Pools without
ProductRef - A ProductRef provides a reference to a product that is held in a product stor-age or to a product in memory.
ProductStorage - The ProductStorage is a storage mechanism to provide read, write and
xv
Categorised view of commands Build 15.0.3262
saveProduct - The product is saved to the pool you pass.
saveProduct - The product is saved to the pool you pass.
Data cubes
importCube - The ImportCube task for Cubes.
importSpectralCube - The ImportSpectralCube task for SpectralSimpleCubes.
nearestNeighbourProjection - Creates a spectral cube by converting the pixels specified bya Wcs into world coordinates and assigning the nearest spectral data to each pixel.
SimpleCube - A Product describing cubes.
SpectralSimpleCube - SpectralSimpleCube is a SimpleCube implementation where the 3rdaxis represents a spectral axis.
Wcs - A class to create a Wcs.
Analysis
computePVMap - This task computes a Position-Velocity (PV) map, which is across-section of a spectral cube along a given slit.
computeVelocityMap - VelocityPosMapComputeTask computes several velocity re-lated values from a processed cube.
cropCube - Extracts a sub-cube from the provided Cube.
extractRegionSpectrum - Extracts a spectrum from either the whole image, a singlepixel, or an ellipsoid, rectangular or slit region.
flagSaturatedPixelsCube - A Task to flag saturated pixels in a cube.
integrateSpectralMap - Integrates a spectral cube over one or several ranges in orderto produce a series of integrated maps.
removeBaselineFromCube - Simple baseline subtraction task.
History
historyExtract - This task extracts a specific parameter value from a task in the history of aproduct.
Images
Flag - A class to describe Flags for images (SimpleImage and SimpleCube).
imageSaver - This is a task which creates a grey colors JPEG file from an image.
importImage - This is a task to import an image from a file.
importRgbImage - This is a task to import an RGB image from a file.
RgbSimpleImage - A Product describing three colour images.
SimpleImage - A Product describing images.
Wcs - A class to create a Wcs.
Analysis
autoCorrelation - This is a task to calculate the linear Pearson correlation coefficientsof an image.
automaticContour - This is a task that generates the contours for a given number ofcontour levels, distribution and extreme values.
xvi
Categorised view of commands Build 15.0.3262
boxCarSmoothing - This is a task to smooth/filter an image using a convolution witha box car.
circleHistogram - This is a task to make a histogram of a region of interest on an im-age which is bounded by a circle.
clamp - This is a task which restricts the range of intensity given low and high valuesin an image.
convertImageUnit - This is a task to convert the unit of an image from one surfacebrightness unit to another one.
createRgbImage - This is a task to combine three images to an RGB-image.
crop - This is a task to crop an image to a rectangular region.
crossCorrelation - This is a task to calculate the linear Pearson correlation coefficientof two images.
cutLevels - This is a task to determine the cut levels of an image.
flagSaturatedPixels - This is a task to flag saturated pixels in an image.
gaussianSmoothing - This is a task to smooth/filter an image using a convolutionwith a gaussian.
imageAbs - This is a task that takes the absolute value of the intensity values of animage.
imageAdd - This task is able to add two images or a scalar to an image, using pixelpositions or Wcs values.
imageCeil - This is a task that ceils the intensity values of an image.
imageContourSaver - This is a task to save image contours as a ds9 region file.
imageConvolution - This is a task to convolve an image with a given convolutionkernel of the same dimensions.
imageDivide - This is a task to divide two images pixel-by-pixel (ref = 0) or basedon their Wcs (ref = 1), or to divide all intensity values in an image by a scalar.
imageExp10 - This is a task that allows to change the intensity values of an imageaccording to a exp10 scaling.
imageExp - This is a task that allows to change the intensity values of an image ac-cording to a exp scaling.
imageExpN - This is a task that allows to change the intensity values of an image ac-cording to a expN scaling.
imageFloor - This is a task that floors the intensity values of an image.
imageHistogram - This is a task to make a histogram of an image as a whole.
imageLog10 - This is a task that allows to change the intensity values of an imageaccording to a log10 scaling.
imageLog - This is a task that allows to change the intensity values of an image ac-cording to a log scaling.
imageLogN - This is a task that allows to change the intensity values of an image ac-cording to a logN scaling.
imageModulo - This is a task that allows to take the modulo of an image, either withanother image or with a scalar.
xvii
Categorised view of commands Build 15.0.3262
imageMultiply - This is a task to multiply two images or an image and a scalar.
imagePower - This is a task that changes the intensity values of an image accordingto a power scaling.
imageRound - This is a task that rounds the intensity values of an image.
imageSqrt - This is a task that changes the intensity values of an image according toa sqrt scaling.
imageSquare - This is a task that changes the intensity values of an image accordingto a square scaling.
imageSubtract - This is a task to subtract two images pixel-by-pixel (ref = 0) orbased on their Wcs (ref = 1), or to subtract a scalar from all intensity values in an image.
IntensityCalculator - This is a class to apply sky estimtion algorithms.
meanSmoothing - This is a task to smooth/filter an image by applying a mean filter.
medianSmoothing - This is a task to smooth/filter an image by applying a median fil-ter.
mosaic - This is a task to make mosaics, by
nSigmaClip - This is a task to flag image values for which |value| is greater than n·σ.
profile - This is a task to make intensity plots along a straight line.
regrid - This is a task to regrid an image.
rotate - This is a task to rotate an image.
scale - This is a task to scale an image, and adapts its Wcs.
tiledImage - This is a task to convert an image to a TiledImage.
translate - This is a task to translate an image, and adapts its Wcs.
transpose - This is a task to transpose an image, and adapts its Wcs.
Display
AnnotationToolbox - A toolbox to draw annotations.
CircleHistogramProduct - A class to deal with the results of a circle histogram.
Contour - A class to deal with Contours.
contour - This task generates the contours for one given contour value.
ContourLevel - A class to deal with ContourLevels.
Display - A class to display images.
ellipseHistogram - This is a task to make a histogram of a region of interest on imagewhich is bounded by an ellipse.
EllipseHistogramProduct - A class to deal with the results of an ellipse histogram.
ImageAxis - Axes for image display.
ImageHistogramProduct - A class to deal with the results of an image histogram.
manualContour - This is a task that generates the contours for a given list of contourvalues.
Polygon - A polygon shape.
xviii
Categorised view of commands Build 15.0.3262
polygonHistogram - This is a task to make a histogram of a region of interest on amimage which is bounded by a polygon.
PolygonHistogramProduct - A class to deal with the results of a polygon histogram.
PolygonIntersect - This is a class to calculate the overlap between polygons.
PositionList - Position list.
Profile - A class to deal with the results of profile plotting.
rectangleHistogram - This is a task to make a histogram of a region of interest on animage which is bounded by a rectangle.
RectangleHistogramProduct - A class to deal with the results of a rectangle his-togram.
SkyMaskToolbox - SkyMaskToolbox construct a toolbox where the user can anno-tate an image and create a SkyMask from the annotations.
Input-output
asciiTableWriter - Task for writing TableDatasets into ASCII (text) files.
FitsArchive - A class for reading and writing FITS files.
fitsReader - Task to read and import arbitrary products in FITS files into HIPE.
getObservation - Task to download, browse, or import an Observation.
HduHeaders - A class for working with FITS HDUs. HDU data is loaded only when re-quested.
imageSaver - This is a task which creates a grey colors JPEG file from an image.
importCube - The ImportCube task for Cubes.
importImage - This is a task to import an image from a file.
importRgbImage - This is a task to import an RGB image from a file.
importSpectralCube - The ImportSpectralCube task for SpectralSimpleCubes.
saveObservation - Save an observation into a local pool.
SerialArchive - A class for writing and reading serialised objects.
simpleFitsReader - Task to read HCSS products (and simple external FITS).
simpleFitsWriter - Saves a product in a FITS file.
Mathematics
Fitting
AbstractBasicModel - AbstractBasicModel implements the common parts of Modelsand in particular those of simple or basic Models.
AbstractFitter - Fitter for linear models.
AbstractModel - AbstractModel implements the common parts of (compound) Mod-els which can be handled by the Fitter class and its descendants.
AmoebaFitter - Simulated annealing simplex finding minimum.
ArctanModel - ArcTangus Model.
ArrayAssistant - ArrayAssistant contains 2 methods to assist with more dimensionalfitting.
xix
Categorised view of commands Build 15.0.3262
BinomialModel - General binomial model of arbitrary degree.
CauchyErrorDistribution - CauchyErrorDistribution aka Lorentz distribution.
ChebyshevPolynomialModel - Chebyshev polynomial model of arbitrary degree.
ComboModel - ComboModel combines a number of copies of the same basic model.
ConjugateGradientFitter - Non-linear fitter using the conjugate gradient method.
ConstantModel - ConstantModel is an extension of NullModel. It does not have anyparameters.
ContainerModel - ContainerModel is a AbstractModel that contains another Ab-stractModel.
EngineList - EngineList is a ArrayList of Engines generated by a Enginer.
ExpModel - Exponential Model.
ExponentialPrior - Exponential prior distribution.
FitterFunction - Specialization of RealFunction that fits some given data.
Fitter - Fitter for linear models.
FreeShapeModel - Free Shape Model.
Gauss2DModel - Rotationally symmetric two dimensional Gaussian Model.
Gauss2DRotModel - Rotated asymmetric 2 dimensional Gaussian Model.
GaussErrorDistribution - GaussErrorDistribution models the fitting error using aGauss distribution.
GaussModel - Gaussian Model.
HarmonicDynamicModel - Harmonic oscillator Model of adaptable Order.
HarmonicModel - Harmonic oscillator Model.
JeffreysPrior - Jeffreys prior distribution, for scale-like parameters.
Kernel2dModel - Two dimensional Kernel Model.
Kernel - A Kernel is a non-negative real-valued integrable function.
KernelModel - Kernel Model, a Model build around an Kernel.
KernelModel - Kernel Model, a Model build around an Kernel.
LaplaceErrorDistribution - LaplaceErrorDistribution.
LaplacePrior - Laplace prior distribution.
LevenbergMarquardtFitter - Non-linear fitter using the Levenberg-Marquardtmethod.
LorentzModel - Lorentzian Model.
modelFit - Task shell around the package herschel.ia.numeric.toolbox.fit.
MonteCarloError - Fitter for linear models.
MpFitter - Non-linear fitter using MINPACK minimization.
NestedSampler - NestedSampler can be used to fit data to a model.
NoiseScale - NoiseScale contains a measure of the noise.
xx
Categorised view of commands Build 15.0.3262
NullModel - NullModel represents models without parameters.
PadeModel - General Pade model of arbitrary degrees in numerator and denomina-tor.
PoissonErrorDistribution - PoissonErrorDistribution models the fitting error using aPoisson distribution.
PolynomialDynamicModel - General polynomial model of an adaptable degree.
PolynomialModel - General polynomial model of arbitrary degree.
PolySurfaceModel - General polynomial surface model of arbitrary degree.
PowerLawModel - General powerlaw model of arbitrary degree.
PowerModel - General power model of arbitrary degree.
PriorList - PriorList is a ArrayList of AbstractPrior elements.
RobustClipWeight - Clip weighting scheme. Also known as sigma-clipping.
RobustCosineWeight - Cosine weighting scheme.
RobustMedianWeight - Median weighting scheme; also known as Huber.
RobustShell - RobustShell is a shell around another fitter to robustify the fit of theinner fitter.
RobustTukeyWeight - Tukey's weighting scheme.
SampleList - SampleList is a ArrayList of Samples generated by a Sampler.
SideBandGED - SideBandGED is a special case (with a sideband) of the GaussEr-rorDistribution.
SideBandRatioGED - SideBandRatioGED is a special case of the GaussErrorDistri-bution that considers the sideband ratio.
SincGaussModel - Sinc-Gauss Model.
SincModel - Sinc Model.
SineAmpModel - Find amplitudes/phases for sinusoidal of a given frequency.
SineModel - Sinusoidal Model.
SingularValueDecompositionFitter - SingularValueDecompositionFitter implementsa linear fitter based on Singular Value Decomposition (SVD).
SkewGaussModel - A class that defines a skew gaussian model.
sourceFit - Task to easily fit Source models (Gauss, Lorentz, Voigt etcetera).
SplinesModel - General splines model of arbitrary order and with arbitrary knot set-tings.
SurfaceSplinesModel - General surface splines model of arbitrary order and with ar-bitrary knot settings.
UniformPrior - Uniform prior distribution.
VoigtModel - Voigt Model.
General functions
ABS - Returns the absolute value of a number or a numeric array. For complex num-bers, ABS(x) returns the modulus.
xxi
Categorised view of commands Build 15.0.3262
EXP10 - Returns the base 10 exponential function applied to a number or array.
EXP - Returns the natural exponential function applied to a number or array.
ExpN - Returns the base n exponential function applied to a number or array.
LOG10 - Returns the base 10 logarithm of a number or array.
LogFactorial - To get a log factorial of a value.
LOG - Returns the natural logarithm of a number or array.
LogN - Returns the base n logarithm of a number or array.
Pow - Raises a number or the elements of an array to the specified power.
SIGNUM - Returns the sign function of a number or array.
SQRT - Returns the square root of a number or array.
SQUARE - Returns the square of a number or array.
Histograms
BinCentres - Returns an array of histogram bin centres for your data, based on binsize.
Histogram - Returns histogram column sizes for an array, using a user-specified binsize.
Integration
DERIV - Given a set of knots, this function performs numerical differentiation using3-point, Lagrangian interpolation.
Integrator - Interface for all integrators.
IntTabulated - Integrate tabular data similar to IDL's INT_TABULATED.
Interpolation
Bilinear - The Bilinear class is an interpolation algorithm used to compute the valuebetween regular grid points in an 2D array.
CubicSplineInterpolator - Given a set of knots (x,y), this function computes values atarbitrary positions by use of a cubic spline.
LinearInterpolator - This class linearly interpolates unknown values based on the twoclosest known knots (x,y data).
NearestNeighborInterpolator - This function interpolates values based on a set ofknown knots (x,y data).
PreviousInterpolator - Creates an linear interpolation function from a set of knots(x,y), that can be applied to numeric arrays of rank 1.
Rebin - The Rebin class resizes a vector or array to dimensions given by the parame-ters Di.
Regrid - The Regrid class shrinks or expands the size of an array by an arbitraryamount.
Masks
FixedMask - FixedMask represents the more traditional mask form, where a mask isdefined at a fixed bit offset position.
xxii
Categorised view of commands Build 15.0.3262
PackedMask - PackedMask creates and stores compressed mask array data whichcan be set, unset and checked.
Matrices
CholeskyDecomposition - CholeskyDecomposition implements the Choleskymethod for decomposing a matrix.
DETERMINANT - Yields the determinant of a square matrix.
EigenvalueDecomposition - EigenvalueDecomposition
INVERSE - Returns the inverse of a square matrix.
MATRIXMULTIPLY - Performs matrix multiplication of numeric or logical matri-ces.
MATRIXSOLVE - Solves systems of linear equations of type A x = b.
QRDecomposition - QRDecomposition
SingularValueDecomposition - SingularValueDecompositon
TRANSPOSE - Transposes a matrix.
Nearest integer
CEIL - Returns the largest integer greater than or equal to the input.
FLOOR - Returns the largest integer less than or equal to the input.
ROUND - Returns the input number or array rounded to the nearest integer or deci-mal position.
Random numbers
MoreRandom - More Random utilities for use with the rest of classes of this pack-age.
RandomGauss - RandomGauss generates or populates an array with normally N(0,1)distributed pseudo random numbers.
RandomPoisson - RandomPoisson generates Poisson random numbers sequencewith a given mean.
RandomUniform - RandomUniform generates or populates an array with uniform-ly-distributed pseudo-random
Signal processing
BoxCarFilter - Creates a box car filter, that can be applied to numeric arrays of rank1 and 2.
Convolution - This class implements the convolution of a one- or two-dimensionalarray with a one-dimensional convolution kernel.
dFT2d - This is a task to calculate the Discrete Fourier Transform and the powerspectrum of an image.
fFT2d - This is a task to calculate the Fast Fourier Transform and the power spec-trum of an image.
FFT_AUTO - Gives the Fast Fourier Transform, automatically choosing what shouldgenerally be the fastest implementation.
FFT_PACK_EVEN - Gives the Discrete Cosine Transform (DCT) of real data.
FFT_PACK_ODD - Gives the Discrete Sine Transform (DST) of real data.
xxiii
Categorised view of commands Build 15.0.3262
FFT_PACK - Gives the Fast Fourier Transform of complex data using anFFT_PACK algorithm.
FFT - Gives the Fast Fourier Transform.
GaussianFilter - Creates a Gaussian filter, that can be applied to numeric arrays ofrank 1 and 2.
HAMMING - Hamming function for multiplying with input arrays.
HANNING - Hanning function for multiplying with input arrays.
inverseDFT2d - This is a task to calculate the inverse Discrete Fourier Transformand the power spectrum of an image.
inverseFFT2d - This is a task to calculate the inverse Fast Fourier Transform and thepower spectrum of an image.
PowerSpectrum - A PowerSpectrum is a normalised Fourier Transform of the timeseries.
RealDoubleFFT - Gives the Fast Fourier Transform of real data using anFFT_PACK algorithm.
Statistics
ChiSquared - ChiSquared computes the chi^2 and significance of the null hypothesisthat an
Correlate - Returns the linear Pearson correlation coefficient of the input arrays.
CorrelateMatrix - Returns the linear Pearson correlation coefficients of the input m xn matrix.
Covariance - Yields the covariance between two random variables/vectors x and ywith finite second moments
CovarianceMatrix - Yields the covariance matrix of the input M x N matrix
ERFC - Returns the complementary error function of a number or array.
ERF - Returns the error function of a number or array.
GAMMALN - Returns the natural logarithm of the Gamma function.
GammaP - Returns the incomplete Gamma function P(a,x).
GammaQ - Returns the complement of the incomplete Gamma function Q(a,x).
GEOMEAN - Yields the geometric mean value of the elements in the input array.
KURTOSIS - Returns the kurtosis excess of an array.
MEAN - Returns the mean of an array.
MedianAbsoluteDeviation - Returns the median absolute deviation of an array.
MEDIAN - Returns the median of an array.
MODE - Yields mode(s), or the most common element(s), in an array of rank 1 to 5.
QRMS - Returns the quadratic root mean square of a set of values.
RMS - Returns the root mean square of a set of values.
Sigclip - Finds and removes outliers in an array.
SKEWNESS - Returns the skewness of an array.
xxiv
Categorised view of commands Build 15.0.3262
StatWithNaN - Removes NaN variables from input arrays to other numeric func-tions.
STDDEV - Returns the standard deviation of an array.
VARIANCE - Returns the variance of an array.
WeightedMean - Returns the quadratically weighted mean of an array.
Trigonometry
ARCCOS - Returns the inverse cosine of a number or array.
ARCCOSH - Returns the inverse hyperbolic cosine of a number or array.
ARCSIN - Returns the inverse sine of a number or array.
ARCSINH - Returns the inverse hyperbolic sine of a number or array.
ARCTANCONTFRAC - Returns the inverse tangent of a number or array using Eu-ler's continued fraction approximation.
ARCTAN - Returns the inverse tangent of a number or array.
ARCTANH - Returns the inverse hyperbolic tangent of a number or array.
COS - Returns the cosine of a number or array.
COSH - Returns the hyperbolic cosine of a number or array.
SINC - Returns the sinc of a number or array.
SIN - Returns the sine of a number or array.
SINH - Returns the hyperbolic sine of a number or array.
TAN - Returns the tangent of a number or array.
TANH - Returns the hyperbolic tangent of a number or array.
UNWRAP - Unwraps the radian phase angles in an array.
Session utilities
bg - Execute Jython commands in the background.
clear - Remove variables from the Jython session.
compress - Compresses files and directories.
decompress - Decompresses archives.
help - Display help page associated with an object.
openFile - Opens a file in a viewer.
openTask - Opens a task in its viewer.
openVariable - Opens a variable in a viewer.
restore - Restore variables from a file to a jython session.
save - Save variables from the jython session to a file.
Spectra
openSE - Opens a Spectrum Explorer in the Editor Area.
SimpleSpectrum - SimpleSpectrum is a simple wrapper to transform a Spectrum1d into aProduct.
xxv
Categorised view of commands Build 15.0.3262
SpectralLineList - SpectralLineList is a simple Product which implements the HerschelLineList definition.
SpectralSimpleCube - SpectralSimpleCube is a SimpleCube implementation where the 3rdaxis represents a spectral axis.
Spectrum1d - Spectrum1d is an extension of AbstractSpectrumDataset which in turn is anextension of (Strict)TableDataset.
Spectrum2d - Spectrum2d is an extension of AbstractSpectrumDataset which in turn is anextension of (Strict)TableDataset.
SpectrumContainerBox - Defines the requirements for an object that contains a number ofSpectrumContainers.
SpectrumContainer - Interface used to access spectrum information sitting in diverse datastructures.
Analysis
accumulate - Accumulates (averages) spectra to a common wave scale grid and re-turns a Spectrum1d.
add - Task for adding a scalar to the flux data of spectra or for pairwise adding spec-tra.
avg - Task for averaging spectra.
convertWavescale - Task for transforming the wavescale between frequency (w), ve-locity (v), wavelength (l) and wavenumber (k).
divide - Task for dividing the flux data of spectra by a scalar or for pairwise dividingspectra.
exportSpectrumToAscii - Task for exporting spectrum data to ASCII.
extract - Task for extracting a wavescale range (or ranges) from a spectrum or set ofspectra.
filterSpectrum - A Task which apply a filter on a spectrum (Double1d).
FitFringeData - Class that wraps Double1d's into a SpectralSegment.
fitFringe - Task that fits and removes fringes from spectra.
flagPixels - Task for flagging pixels in spectra.
fold - Task