casa::SynthesisImager Class Reference

Class that contains functions needed for imager. More...

#include <SynthesisImager.h>

Inheritance diagram for casa::SynthesisImager:

Public Member Functions
	SynthesisImager ()
	Default constructor.
virtual	~SynthesisImager ()
virtual Bool	selectData (const SynthesisParamsSelect &selpars)
	Copy constructor and assignment operator Imager(const Imager&); Imager& operator=(const Imager&);.
virtual Bool	selectData (const String &msname, const String &spw="", const String &freqBeg="", const String &freqEnd="", const MFrequency::Types freqFrame=MFrequency::LSRK, const String &field="", const String &antenna="", const String &timestr="", const String &scan="", const String &obs="", const String &state="", const String &uvdist="", const String &taql="", const Bool usescratch=False, const Bool readonly=False, const Bool incrementModel=False)
	make all pure-inputs const
virtual Bool	defineImage (SynthesisParamsImage &impars, const SynthesisParamsGrid &gridpars)
virtual Bool	defineImage (const String &imagename, const Int nx, const Int ny, const Quantity &cellx, const Quantity &celly, const String &stokes, const MDirection &phaseCenter, const Int nchan, const Quantity &freqStart, const Quantity &freqStep, const Vector< Quantity > &restFreq, const Int facets=1, const String ftmachine="gridft", const Int nTaylorTerms=1, const Quantity &refFreq=Quantity(0,"Hz"), const Projection &projection=Projection::SIN, const Quantity &distance=Quantity(0,"m"), const MFrequency::Types &freqFrame=MFrequency::LSRK, const Bool trackSource=False, const MDirection &trackDir=MDirection(Quantity(0.0,"deg"), Quantity(90.0,"deg")), const Bool overwrite=False, const Float padding=1.0, const Bool useAutocorr=False, const bool useDoublePrec=True, const Int wprojplanes=1, const String convFunc="SF", const String startmodel="", const Bool aTermOn=True, const Bool psTermOn=True, const Bool mTermOn=False, const Bool wbAWP=True, const String cfCache="", const Bool doPointing=False, const Bool doPBCorr=True, const Bool conjBeams=True, const Float computePAStep=360.0, const Float rotatePAStep=5.0)
	When having a facetted image ...call with (facets > 1) first and once only .
virtual Bool	defineImage (CountedPtr< SIImageStore > imstor, const String &ftmachine)
	Define image via a predefine SIImageStore object.
Record	getcsys ()
Int	updateNchan ()
virtual Vector < SynthesisParamsSelect >	tuneSelectData ()
	Function to tune the data selection to intersect with image definition chosen This is to optimize the data selection so that unnecessary data is not parsed despite the user deciding to select so.
virtual void	setComponentList (const ComponentList &cl, Bool sdgrid=False)
	Defining componentlist to use while degriding This should be called once...if multiple lists are used..they can be merged in one if sdgrid=True then image plane degridding is done.
virtual Bool	weight (const String &type="natural", const String &rmode="norm", const Quantity &noise=Quantity(0.0,"Jy"), const Double robust=0.0, const Quantity &fieldofview=Quantity(0.0,"arcsec"), const Int npixels=0, const Bool multiField=False, const String &filtertype=String("Gaussian"), const Quantity &filterbmaj=Quantity(0.0,"deg"), const Quantity &filterbmin=Quantity(0.0,"deg"), const Quantity &filterbpa=Quantity(0.0,"deg"))
Bool	getWeightDensity ()
virtual Bool	setWeightDensity ()
void	resetMappers ()
	the following get rid of the mappers in this object
CountedPtr< SIImageStore >	imageStore (const Int id=0)
void	executeMajorCycle (Record &controls)
	Record getMajorCycleControls();.
void	makePSF ()
	make the psf images i.e grid weight rather than data
virtual Bool	makePB ()
virtual void	predictModel ()
virtual void	dryGridding (const Vector< String > &cfList)
	void makeImage();
virtual void	fillCFCache (const Vector< String > &cfList, const String &ftmName, const String &cfcPath, const Bool &psTermOn, const Bool &aTermOn)
virtual void	reloadCFCache ()
Static Public Member Functions
static String	doubleToString (const Double &df)
Protected Member Functions
Choose between different types of FTMs *void	createFTMachine (CountedPtr< FTMachine > &theFT, CountedPtr< FTMachine > &theIFT, const String &ftname, const uInt nTaylorTerms=1, const String mType="default", const Int facets=1, const Int wprojplane=1, const Float padding=1.0, const Bool useAutocorr=False, const Bool useDoublePrec=True, const String gridFunction=String("SF"), const Bool aTermOn=True, const Bool psTermOn=True, const Bool mTermOn=False, const Bool wbAWP=True, const String cfCache="", const Bool doPointing=False, const Bool doPBCorr=True, const Bool conjBeams=True, const Float computePAStep=360.0, const Float rotatePAStep=5.0, const String interpolation=String("linear"), const Bool freqFrameValid=True, const Int cache=1000000000, const Int tile=16, const String stokes="I", const String imageNamePrefix="")
void	createMosFTMachine (CountedPtr< FTMachine > &theFT, CountedPtr< FTMachine > &theIFT, const Float padding, const Bool useAutoCorr, const Bool useDoublePrec, const Float rotatePAStep, const String Stokes="I")
CountedPtr< SIImageStore >	createIMStore (String imageName, CoordinateSystem &cSys, IPosition imShape, const Bool overwrite, ROMSColumns &msc, String mappertype="default", uInt ntaylorterms=1, Quantity distance=Quantity(0.0,"m"), uInt facets=1, Bool useweightimage=False, Vector< String > startmodel=Vector< String >(0))
	Choose between different types of ImageStore types (single term, multiterm, faceted).
CountedPtr< SIMapper >	createSIMapper (String mappertype, CountedPtr< SIImageStore > imagestore, CountedPtr< FTMachine > ftmachine, CountedPtr< FTMachine > iftmachine, uInt ntaylorterms=1)
	Choose between different types of Mappers (single term, multiterm, imagemosaic, faceted).
Block< CountedPtr< SIImageStore > >	createFacetImageStoreList (CountedPtr< SIImageStore > imagestore, Int facets)
Block< CountedPtr< SIImageStore > >	createChanChunkImageStoreList (CountedPtr< SIImageStore > imagestore, Int chanchunks)
	void setPsfFromOneFacet();
Bool	toUseWeightImage (CountedPtr< FTMachine > &ftm, String mappertype)
virtual void	createVisSet (const Bool writeaccess=False)
void	createAWPFTMachine (CountedPtr< FTMachine > &theFT, CountedPtr< FTMachine > &theIFT, const String &ftmName, const Int facets, const Int wprojPlane, const Float padding, const Bool useAutocorr, const Bool useDoublePrec, const String gridFunction, const Bool aTermOn, const Bool psTermOn, const Bool mTermOn, const Bool wbAWP, const String cfCache, const Bool doPointing, const Bool doPBCorr, const Bool conjBeams, const Float computePAStep, const Float rotatePAStep, const Int cache, const Int tile, const String imageNamePrefix="")
ATerm *	createTelescopeATerm (const MeasurementSet &ms, const Bool &isATermOn)
void	getVPRecord (Record &rec, PBMath::CommonPB &kpb, String telescop)
	Get VP record.
virtual void	runMajorCycle (const Bool dopsf=False, const Bool savemodel=False)
	Do the major cycle.
virtual void	runMajorCycle2 (const Bool dopsf=False, const Bool savemodel=False)
	Version of major cycle code with mappers in a loop outside vi/vb.
void	appendToMapperList (String imagename, CoordinateSystem &csys, String ftmachine, Quantity distance=Quantity(0.0,"m"), Int facets=1, const Bool overwrite=False)
	It associated the ftmachine with a given field.
*void	appendToMapperList (String imagename, CoordinateSystem &csys, IPosition imshape, CountedPtr< FTMachine > &ftm, CountedPtr< FTMachine > &iftm, Quantity distance=Quantity(0.0,"m"), Int facets=1, Int chanchunks=1, const Bool overwrite=False, String mappertype=String("default"), Float padding=1.0, uInt ntaylorterms=1, Vector< String > startmodel=Vector< String >(0))
virtual void	unlockMSs ()
Bool	makePBImage (const String &telescopeName, Bool useSymmetricBeam, Double diam)
Bool	makePBImage (const String telescop)
virtual Bool	makePrimaryBeam (PBMath &pbMath)
Protected Attributes
*SIMapperCollection	itsMappers
CountedPtr< SIImageStore >	unFacettedImStore_p
	if facetting this storage will keep the unsliced version
CountedPtr< SIImageStore >	unChanChunkedImStore_p
Bool	itsDataLoopPerMapper
CoordinateSystem	itsMaxCoordSys
IPosition	itsMaxShape
Record	itsCsysRec
Int	itsNchan
String	itsVpTable
Bool	itsMakeVP
Data Selection *Vector < SynthesisParamsSelect >	dataSel_p
Block< const MeasurementSet * >	mss_p
	Image Definition Imaging/Gridding.
vi::FrequencySelections	fselections_p
CountedPtr < vi::VisibilityIterator2 >	vi_p
Bool	useViVb2_p
	Other Options ////////////////////////////////Till VisibilityIterator2 works as advertised.
Block< MeasurementSet >	mss4vi_p
VisibilityIterator *	wvi_p
ROVisibilityIterator *	rvi_p
Block< Vector< Int > >	blockNChan_p
Block< Vector< Int > >	blockStart_p
Block< Vector< Int > >	blockStep_p
Block< Vector< Int > >	blockSpw_p
Matrix< Double >	mssFreqSel_p
Cube< Int >	chanSel_p
	the 'channel flags' to handle various channel selections in the spw parameter
Bool	writeAccess_p
MPosition	mLocation_p
MDirection	phaseCenter_p
Int	facetsStore_p
Int	chanChunksStore_p
VisImagingWeight	imwgt_p
Bool	imageDefined_p
Bool	useScratch_p
Bool	readOnly_p
FTMachine::Type	datacol_p
	Bool freqFrameValid_p;.
Int	nMajorCycles

Detailed Description

Class that contains functions needed for imager.

Definition at line 56 of file SynthesisImager.h.

Constructor & Destructor Documentation

casa::SynthesisImager::SynthesisImager ( )

Default constructor.

virtual casa::SynthesisImager::~SynthesisImager ( ) [virtual]

Member Function Documentation

* void casa::SynthesisImager::appendToMapperList	(	String	imagename,
		CoordinateSystem &	csys,
		IPosition	imshape,
		CountedPtr< FTMachine > &	ftm,
		CountedPtr< FTMachine > &	iftm,
		Quantity	distance = `Quantity(0.0,"m")`,
		Int	facets = `1`,
		Int	chanchunks = `1`,
		const Bool	overwrite = `False`,
		String	mappertype = `String("default")`,
		Float	padding = `1.0`,
		uInt	ntaylorterms = `1`,
		Vector< String >	startmodel = `Vector< String >(0)`
	)			`[protected]`

void casa::SynthesisImager::appendToMapperList	(	String	imagename,
		CoordinateSystem &	csys,
		String	ftmachine,
		Quantity	distance = `Quantity(0.0,"m")`,
		Int	facets = `1`,
		const Bool	overwrite = `False`
	)			`[protected]`

It associated the ftmachine with a given field.

void casa::SynthesisImager::createAWPFTMachine	(	CountedPtr< FTMachine > &	theFT,
		CountedPtr< FTMachine > &	theIFT,
		const String &	ftmName,
		const Int	facets,
		const Int	wprojPlane,
		const Float	padding,
		const Bool	useAutocorr,
		const Bool	useDoublePrec,
		const String	gridFunction,
		const Bool	aTermOn,
		const Bool	psTermOn,
		const Bool	mTermOn,
		const Bool	wbAWP,
		const String	cfCache,
		const Bool	doPointing,
		const Bool	doPBCorr,
		const Bool	conjBeams,
		const Float	computePAStep,
		const Float	rotatePAStep,
		const Int	cache,
		const Int	tile,
		const String	imageNamePrefix = `""`
	)			`[protected]`

Parameters:

	wprojPlane	----------------------------
	aTermOn	---------------------------

Block<CountedPtr<SIImageStore> > casa::SynthesisImager::createChanChunkImageStoreList	(	CountedPtr< SIImageStore >	imagestore,
		Int	chanchunks
	)			`[protected]`

void setPsfFromOneFacet();

Block<CountedPtr<SIImageStore> > casa::SynthesisImager::createFacetImageStoreList	(	CountedPtr< SIImageStore >	imagestore,
		Int	facets
	)			`[protected]`

Choose between different types of FTMs* void casa::SynthesisImager::createFTMachine	(	CountedPtr< FTMachine > &	theFT,
		CountedPtr< FTMachine > &	theIFT,
		const String &	ftname,
		const uInt	nTaylorTerms = `1`,
		const String	mType = `"default"`,
		const Int	facets = `1`,
		const Int	wprojplane = `1`,
		const Float	padding = `1.0`,
		const Bool	useAutocorr = `False`,
		const Bool	useDoublePrec = `True`,
		const String	gridFunction = `String("SF")`,
		const Bool	aTermOn = `True`,
		const Bool	psTermOn = `True`,
		const Bool	mTermOn = `False`,
		const Bool	wbAWP = `True`,
		const String	cfCache = `""`,
		const Bool	doPointing = `False`,
		const Bool	doPBCorr = `True`,
		const Bool	conjBeams = `True`,
		const Float	computePAStep = `360.0`,
		const Float	rotatePAStep = `5.0`,
		const String	interpolation = `String("linear")`,
		const Bool	freqFrameValid = `True`,
		const Int	cache = `1000000000`,
		const Int	tile = `16`,
		const String	stokes = `"I"`,
		const String	imageNamePrefix = `""`
	)			`[protected]`

Parameters:

	wprojplane	------------------------------
	aTermOn	------------------------------

CountedPtr<SIImageStore> casa::SynthesisImager::createIMStore	(	String	imageName,
		CoordinateSystem &	cSys,
		IPosition	imShape,
		const Bool	overwrite,
		ROMSColumns &	msc,
		String	mappertype = `"default"`,
		uInt	ntaylorterms = `1`,
		Quantity	distance = `Quantity(0.0,"m")`,
		uInt	facets = `1`,
		Bool	useweightimage = `False`,
		Vector< String >	startmodel = `Vector< String >(0)`
	)			`[protected]`

Choose between different types of ImageStore types (single term, multiterm, faceted).

void casa::SynthesisImager::createMosFTMachine	(	CountedPtr< FTMachine > &	theFT,
		CountedPtr< FTMachine > &	theIFT,
		const Float	padding,
		const Bool	useAutoCorr,
		const Bool	useDoublePrec,
		const Float	rotatePAStep,
		const String	Stokes = `"I"`
	)			`[protected]`

CountedPtr<SIMapper> casa::SynthesisImager::createSIMapper	(	String	mappertype,
		CountedPtr< SIImageStore >	imagestore,
		CountedPtr< FTMachine >	ftmachine,
		CountedPtr< FTMachine >	iftmachine,
		uInt	ntaylorterms = `1`
	)			`[protected]`

Choose between different types of Mappers (single term, multiterm, imagemosaic, faceted).

Parameters:

ftmachine

/ make this inside !!!!!

ATerm* casa::SynthesisImager::createTelescopeATerm	(	const MeasurementSet &	ms,
		const Bool &	isATermOn
	)			`[protected]`

virtual void casa::SynthesisImager::createVisSet ( const Bool writeaccess = False ) [protected, virtual]

Reimplemented in casa::SynthesisImagerVi2.

virtual Bool casa::SynthesisImager::defineImage	(	CountedPtr< SIImageStore >	imstor,
		const String &	ftmachine
	)			`[virtual]`

Define image via a predefine SIImageStore object.

virtual Bool casa::SynthesisImager::defineImage	(	const String &	imagename,
		const Int	nx,
		const Int	ny,
		const Quantity &	cellx,
		const Quantity &	celly,
		const String &	stokes,
		const MDirection &	phaseCenter,
		const Int	nchan,
		const Quantity &	freqStart,
		const Quantity &	freqStep,
		const Vector< Quantity > &	restFreq,
		const Int	facets = `1`,
		const String	ftmachine = `"gridft"`,
		const Int	nTaylorTerms = `1`,
		const Quantity &	refFreq = `Quantity(0,"Hz")`,
		const Projection &	projection = `Projection::SIN`,
		const Quantity &	distance = `Quantity(0,"m")`,
		const MFrequency::Types &	freqFrame = `MFrequency::LSRK`,
		const Bool	trackSource = `False`,
		const MDirection &	trackDir = `MDirection(Quantity(0.0,"deg"), Quantity(90.0,"deg"))`,
		const Bool	overwrite = `False`,
		const Float	padding = `1.0`,
		const Bool	useAutocorr = `False`,
		const bool	useDoublePrec = `True`,
		const Int	wprojplanes = `1`,
		const String	convFunc = `"SF"`,
		const String	startmodel = `""`,
		const Bool	aTermOn = `True`,
		const Bool	psTermOn = `True`,
		const Bool	mTermOn = `False`,
		const Bool	wbAWP = `True`,
		const String	cfCache = `""`,
		const Bool	doPointing = `False`,
		const Bool	doPBCorr = `True`,
		const Bool	conjBeams = `True`,
		const Float	computePAStep = `360.0`,
		const Float	rotatePAStep = `5.0`
	)			`[virtual]`

When having a facetted image ...call with (facets > 1) first and once only .

\. Easier to keep track of the imstores that way CAREFUL: make sure you donot overwrite if you want to predict the model or subtract it to make residual

Parameters:

	ftmachine	const Int chanchunks=1,
	startmodel	const String vptable="",
	aTermOn	The extra params for WB-AWP

virtual Bool casa::SynthesisImager::defineImage	(	SynthesisParamsImage &	impars,
		const SynthesisParamsGrid &	gridpars
	)			`[virtual]`

Reimplemented in casa::SynthesisImagerVi2.

static String casa::SynthesisImager::doubleToString ( const Double & df ) [static]

virtual void casa::SynthesisImager::dryGridding ( const Vector< String > & cfList ) [virtual]

void makeImage();

SIIterBot& getLoopControls();

Reimplemented in casa::SynthesisImagerVi2.

void casa::SynthesisImager::executeMajorCycle ( Record & controls )

Record getMajorCycleControls();.

virtual void casa::SynthesisImager::fillCFCache	(	const Vector< String > &	cfList,
		const String &	ftmName,
		const String &	cfcPath,
		const Bool &	psTermOn,
		const Bool &	aTermOn
	)			`[virtual]`

Reimplemented in casa::SynthesisImagerVi2.

Record casa::SynthesisImager::getcsys ( ) [inline]

Definition at line 136 of file SynthesisImager.h.

References itsCsysRec.

void casa::SynthesisImager::getVPRecord	(	Record &	rec,
		PBMath::CommonPB &	kpb,
		String	telescop
	)			`[protected]`

Get VP record.

Bool casa::SynthesisImager::getWeightDensity ( )

CountedPtr<SIImageStore> casa::SynthesisImager::imageStore ( const Int id = 0 )

virtual Bool casa::SynthesisImager::makePB ( ) [virtual]

Reimplemented in casa::SynthesisImagerVi2.

Bool casa::SynthesisImager::makePBImage ( const String telescop ) [protected]

Bool casa::SynthesisImager::makePBImage	(	const String &	telescopeName,
		Bool	useSymmetricBeam,
		Double	diam
	)			`[protected]`

virtual Bool casa::SynthesisImager::makePrimaryBeam ( PBMath & pbMath ) [protected, virtual]

Reimplemented in casa::SynthesisImagerVi2.

void casa::SynthesisImager::makePSF ( )

make the psf images i.e grid weight rather than data

virtual void casa::SynthesisImager::predictModel ( ) [virtual]

Reimplemented in casa::SynthesisImagerVi2.

virtual void casa::SynthesisImager::reloadCFCache ( ) [virtual]

Reimplemented in casa::SynthesisImagerVi2.

void casa::SynthesisImager::resetMappers ( )

the following get rid of the mappers in this object

virtual void casa::SynthesisImager::runMajorCycle	(	const Bool	dopsf = `False`,
		const Bool	savemodel = `False`
	)			`[protected, virtual]`

Do the major cycle.

Reimplemented in casa::SynthesisImagerVi2.

virtual void casa::SynthesisImager::runMajorCycle2	(	const Bool	dopsf = `False`,
		const Bool	savemodel = `False`
	)			`[protected, virtual]`

Version of major cycle code with mappers in a loop outside vi/vb.

Reimplemented in casa::SynthesisImagerVi2.

virtual Bool casa::SynthesisImager::selectData	(	const String &	msname,
		const String &	spw = `"*"`,
		const String &	freqBeg = `""`,
		const String &	freqEnd = `""`,
		const MFrequency::Types	freqFrame = `MFrequency::LSRK`,
		const String &	field = `"*"`,
		const String &	antenna = `""`,
		const String &	timestr = `""`,
		const String &	scan = `""`,
		const String &	obs = `""`,
		const String &	state = `""`,
		const String &	uvdist = `""`,
		const String &	taql = `""`,
		const Bool	usescratch = `False`,
		const Bool	readonly = `False`,
		const Bool	incrementModel = `False`
	)			`[virtual]`

make all pure-inputs const

virtual Bool casa::SynthesisImager::selectData ( const SynthesisParamsSelect & selpars ) [virtual]

Copy constructor and assignment operator Imager(const Imager&); Imager& operator=(const Imager&);.

Reimplemented in casa::SynthesisImagerVi2.

virtual void casa::SynthesisImager::setComponentList	(	const ComponentList &	cl,
		Bool	sdgrid = `False`
	)			`[virtual]`

Defining componentlist to use while degriding This should be called once...if multiple lists are used..they can be merged in one if sdgrid=True then image plane degridding is done.

virtual Bool casa::SynthesisImager::setWeightDensity ( ) [virtual]

Reimplemented in casa::SynthesisImagerVi2.

Bool casa::SynthesisImager::toUseWeightImage	(	CountedPtr< FTMachine > &	ftm,
		String	mappertype
	)			`[protected]`

virtual Vector<SynthesisParamsSelect> casa::SynthesisImager::tuneSelectData ( ) [virtual]

Function to tune the data selection to intersect with image definition chosen This is to optimize the data selection so that unnecessary data is not parsed despite the user deciding to select so.

defineimage has to be run first (and thus selectData prior to that) otherwise an exception is thrown

virtual void casa::SynthesisImager::unlockMSs ( ) [protected, virtual]

Reimplemented in casa::SynthesisImagerVi2.

Int casa::SynthesisImager::updateNchan ( ) [inline]

Definition at line 137 of file SynthesisImager.h.

References itsNchan.

virtual Bool casa::SynthesisImager::weight	(	const String &	type = `"natural"`,
		const String &	rmode = `"norm"`,
		const Quantity &	noise = `Quantity(0.0,"Jy")`,
		const Double	robust = `0.0`,
		const Quantity &	fieldofview = `Quantity(0.0,"arcsec")`,
		const Int	npixels = `0`,
		const Bool	multiField = `False`,
		const String &	filtertype = `String("Gaussian")`,
		const Quantity &	filterbmaj = `Quantity(0.0,"deg")`,
		const Quantity &	filterbmin = `Quantity(0.0,"deg")`,
		const Quantity &	filterbpa = `Quantity(0.0,"deg")`
	)			`[virtual]`