1.40. doFreqGrid

Full Name: herschel.hifi.pipeline.generic.DoFreqGridTask
Alias: doFreqGrid
Type: Java Task - Java Task
Import: from herschel.hifi.pipeline.generic import DoFreqGridTask
Category

HIFI/Pipeline/Level 2 Pipeline

Description

Resamples the flux data to a suitable frequency grid.

Example

Example 1: In HIPE doFreqGrid(htp=htp, resolution=1.0)
newGrid = mkFreqGrid(htp, stepsize=0.5) doFreqGrid(htp=htp,
grid=newGrid)
doFreqGrid(htp=htp, resolution=1.0, scheme="gaussian",
resamplingParams=4.0)

API details

Properties

HifiTimelineProduct htp [INOUT, MANDATORY, default=no default value The]

timeline product to be processed.

PipelineConfiguration params [INPUT, OPTIONAL, default=no default value]

Pipeline configuration parameters that can be passed to the task.

Boolean ignore [INPUT, OPTIONAL, default=no default value Flag to]

indicate whether the execution of the module should be ignored.

String scheme [INPUT, OPTIONAL, default=no default value. The scheme to]

be adopted for the resampling - available are "trapezoidal", "euler" or "gaussian".

Object resamplingParams [INPUT, OPTIONAL, default=no default value.]

Additional parameters for configuring specific resampling schemes (e.g. kernel width for the Gaussian resampler).

Double resolution [INPUT, OPTIONAL, default=no default value The desired]

resolution of the output frequency grid.

Unit | String unit [INPUT, OPTIONAL, default=no default value The unit]

the desired resolution is specified in. By default, it is specified in the same unit as the frequency scale of the spectra to be resampled. You can pass here either a Unit (like herschel.share.unit.Frequency.MEGAHERTZ) or a string that specifies the unit ("MHz").

Object grid [INPUT, OPTIONAL, default=no default value Specification of]

the wavescale grid(s):

  • as PyDictionary: For each dataset a frequency grid is specified. Use the integer key of the dataset within the product as key in the PyDictionary and a Double1d[] as values.

  • as CalFreqGrid: Calibration product that is created in the MkFreqGrid module.

See also

History

  • 2011-07-11 - melchior: : history added.
  • 2011-08-14 - melchior: : renamed to DoFreqGridTask.
  • 2011-09-28 - melchior: : Fix the unit bug, HIFI-4365