casa::MSTransformRegridder Class Reference

MSTransformRegridder definition. More...

#include <MSTransformRegridder.h>

Public Member Functions
	MSTransformRegridder ()
	~MSTransformRegridder ()
Static Public Member Functions
static Bool	combineSpws (LogIO &os, String msName, const Vector< Int > &spwids, Vector< Double > &newCHAN_FREQ, Vector< Double > &newCHAN_WIDTH, std::vector< std::vector< Int > > &averageWhichChan, std::vector< std::vector< Int > > &averageWhichSPW, std::vector< std::vector< Double > > &averageChanFrac, Bool verbose=False)
	Make one spectral window from all SPWs given by the SPW Ids vector.
static Bool	combineSpwsCore (LogIO &os, MeasurementSet &ms_p, const Vector< Int > &spwids, Vector< Double > &newCHAN_FREQ, Vector< Double > &newCHAN_WIDTH, std::vector< std::vector< Int > > &averageWhichChan, std::vector< std::vector< Int > > &averageWhichSPW, std::vector< std::vector< Double > > &averageChanFrac, Bool verbose=False)
	Make one spectral window from all SPWs given by the SPW Ids vector.
static Bool	calcChanFreqs (LogIO &os, Vector< Double > &newCHAN_FREQ, Vector< Double > &newCHAN_WIDTH, Double &weightScale, const Vector< Double > &oldCHAN_FREQ, const Vector< Double > &oldCHAN_WIDTH, const MDirection phaseCenter, const MFrequency::Types theOldRefFrame, const MEpoch theObsTime, const MPosition mObsPos, const String &mode, const int nchan, const String &start, const String &width, const String &restfreq, const String &outframe, const String &veltype, const Bool verbose=False, const MRadialVelocity mRV=MRadialVelocity())
	A wrapper for regridChanBounds() which takes the user interface type re-gridding parameters The ready-made grid is returned in newCHAN_FREQ and newCHAN_WIDTH.
static Bool	convertGridPars (LogIO &os, const String &mode, const int nchan, const String &start, const String &width, const String &interp, const String &restfreq, const String &outframe, const String &veltype, String &t_mode, String &t_outframe, String &t_regridQuantity, Double &t_restfreq, String &t_regridInterpMeth, Double &t_cstart, Double &t_bandwidth, Double &t_cwidth, Bool &t_centerIsStart, Bool &t_startIsEnd, Int &t_nchan, Int &t_width, Int &t_start)
	Helper function for handling the re-gridding parameter user input.
static Bool	regridChanBounds (Vector< Double > &newChanLoBound, Vector< Double > &newChanHiBound, const Double regridCenter, const Double regridBandwidth, const Double regridChanWidth, const Double regridVeloRestfrq, const String regridQuant, const Vector< Double > &transNewXin, const Vector< Double > &transCHAN_WIDTH, String &message, const Bool centerIsStart=False, const Bool startIsEnd=False, const Int nchan=0, const Int width=0, const Int start=-1)
	Calculate the final new channel boundaries from the re-regridding parameters and the old channel boundaries (already transformed to the desired reference frame).
static lDouble	vrad (const lDouble freq, const lDouble rest)
	The following inline convenience methods for regridSpw bypass the whole CASA measure system because when they are used, they can assume that the frame stays the same and the units are OK.
static lDouble	vopt (const lDouble freq, const lDouble rest)
static lDouble	lambda (const lDouble freq)
static lDouble	freq_from_vrad (const lDouble vrad, const lDouble rest)
static lDouble	freq_from_vopt (const lDouble vopt, const lDouble rest)
static lDouble	freq_from_lambda (const lDouble lambda)

Detailed Description

MSTransformRegridder definition.

Definition at line 45 of file MSTransformRegridder.h.

Constructor & Destructor Documentation

casa::MSTransformRegridder::MSTransformRegridder ( )

casa::MSTransformRegridder::~MSTransformRegridder ( )

Member Function Documentation

static Bool casa::MSTransformRegridder::calcChanFreqs	(	LogIO &	os,
		Vector< Double > &	newCHAN_FREQ,
		Vector< Double > &	newCHAN_WIDTH,
		Double &	weightScale,
		const Vector< Double > &	oldCHAN_FREQ,
		const Vector< Double > &	oldCHAN_WIDTH,
		const MDirection	phaseCenter,
		const MFrequency::Types	theOldRefFrame,
		const MEpoch	theObsTime,
		const MPosition	mObsPos,
		const String &	mode,
		const int	nchan,
		const String &	start,
		const String &	width,
		const String &	restfreq,
		const String &	outframe,
		const String &	veltype,
		const Bool	verbose = `False`,
		const MRadialVelocity	mRV = `MRadialVelocity()`
	)			`[static]`

A wrapper for regridChanBounds() which takes the user interface type re-gridding parameters The ready-made grid is returned in newCHAN_FREQ and newCHAN_WIDTH.

Parameters:

	newCHAN_FREQ	Output
	oldCHAN_FREQ	Input (original grid)
	phaseCenter	Re-gridding parameters
	mRV	Additional radial velocity shift to apply, used e.g. when outframe=="SOURCE"

static Bool casa::MSTransformRegridder::combineSpws	(	LogIO &	os,
		String	msName,
		const Vector< Int > &	spwids,
		Vector< Double > &	newCHAN_FREQ,
		Vector< Double > &	newCHAN_WIDTH,
		std::vector< std::vector< Int > > &	averageWhichChan,
		std::vector< std::vector< Int > > &	averageWhichSPW,
		std::vector< std::vector< Double > > &	averageChanFrac,
		Bool	verbose = `False`
	)			`[static]`

Make one spectral window from all SPWs given by the SPW Ids vector.

static Bool casa::MSTransformRegridder::combineSpwsCore	(	LogIO &	os,
		MeasurementSet &	ms_p,
		const Vector< Int > &	spwids,
		Vector< Double > &	newCHAN_FREQ,
		Vector< Double > &	newCHAN_WIDTH,
		std::vector< std::vector< Int > > &	averageWhichChan,
		std::vector< std::vector< Int > > &	averageWhichSPW,
		std::vector< std::vector< Double > > &	averageChanFrac,
		Bool	verbose = `False`
	)			`[static]`

Make one spectral window from all SPWs given by the SPW Ids vector.

static Bool casa::MSTransformRegridder::convertGridPars	(	LogIO &	os,
		const String &	mode,
		const int	nchan,
		const String &	start,
		const String &	width,
		const String &	interp,
		const String &	restfreq,
		const String &	outframe,
		const String &	veltype,
		String &	t_mode,
		String &	t_outframe,
		String &	t_regridQuantity,
		Double &	t_restfreq,
		String &	t_regridInterpMeth,
		Double &	t_cstart,
		Double &	t_bandwidth,
		Double &	t_cwidth,
		Bool &	t_centerIsStart,
		Bool &	t_startIsEnd,
		Int &	t_nchan,
		Int &	t_width,
		Int &	t_start
	)			`[static]`

Helper function for handling the re-gridding parameter user input.

static lDouble casa::MSTransformRegridder::freq_from_lambda ( const lDouble lambda ) [inline, static]

Definition at line 151 of file MSTransformRegridder.h.

References casacore::C::c.

static lDouble casa::MSTransformRegridder::freq_from_vopt	(	const lDouble	vopt,
		const lDouble	rest
	)			`[inline, static]`

Definition at line 150 of file MSTransformRegridder.h.

References casacore::C::c.

static lDouble casa::MSTransformRegridder::freq_from_vrad	(	const lDouble	vrad,
		const lDouble	rest
	)			`[inline, static]`

Definition at line 149 of file MSTransformRegridder.h.

References casacore::C::c.

static lDouble casa::MSTransformRegridder::lambda ( const lDouble freq ) [inline, static]

Definition at line 148 of file MSTransformRegridder.h.

References casacore::C::c.

static Bool casa::MSTransformRegridder::regridChanBounds	(	Vector< Double > &	newChanLoBound,
		Vector< Double > &	newChanHiBound,
		const Double	regridCenter,
		const Double	regridBandwidth,
		const Double	regridChanWidth,
		const Double	regridVeloRestfrq,
		const String	regridQuant,
		const Vector< Double > &	transNewXin,
		const Vector< Double > &	transCHAN_WIDTH,
		String &	message,
		const Bool	centerIsStart = `False`,
		const Bool	startIsEnd = `False`,
		const Int	nchan = `0`,
		const Int	width = `0`,
		const Int	start = `-1`
	)			`[static]`

Calculate the final new channel boundaries from the re-regridding parameters and the old channel boundaries (already transformed to the desired reference frame).

Returns False if input parameters were invalid and no useful boundaries could be created

static lDouble casa::MSTransformRegridder::vopt	(	const lDouble	freq,
		const lDouble	rest
	)			`[inline, static]`

Definition at line 147 of file MSTransformRegridder.h.

References casacore::C::c.

static lDouble casa::MSTransformRegridder::vrad	(	const lDouble	freq,
		const lDouble	rest
	)			`[inline, static]`

The following inline convenience methods for regridSpw bypass the whole CASA measure system because when they are used, they can assume that the frame stays the same and the units are OK.

Definition at line 146 of file MSTransformRegridder.h.

References casacore::C::c.

The documentation for this class was generated from the following file:

code/mstransform/MSTransform/MSTransformRegridder.h

casa::MSTransformRegridder Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation