mirfiller Class Reference

A Distributed Object for filling MIRIAD uv data into an MS. More...

#include <DOmirfiller.h>

Public Member Functions
	mirfiller (const String &mirfile)
	create the filler, attaching it to a Miriad dataset.
	~mirfiller ()
	destruct this filler
void	fill (const String &msfile)
	fill the output MS according to the current selections and options.
void	selectspectra (const Vector< Int > &wideChans, const Vector< Int > &narrowWins) throw (UnavailableMiriadDataSelectionError)
	select spectra from the input Miriad dataset.
void	selectpols (const Vector< Int > pols)
	select polarization setups from the input Miriad dataset.
GlishRecord	summary (Bool verbose=True, Bool scan=True)
	return a description of the input Miriad dataset's contents as a Record object.
void	setoptions (const Record &opts)
	set the options for filling.
Record	getoptions ()
	get the current filling options
virtual String	className () const
virtual Vector< String >	methods () const
virtual MethodResult	runMethod (uInt which, ParameterSet &parameters, Bool runMethod)
virtual Vector< String >	noTraceMethods () const
Private Member Functions
	mirfiller ()
	mirfiller (const mirfiller &other)
Private Attributes
MirFiller	filler_p

Detailed Description

A Distributed Object for filling MIRIAD uv data into an MS.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

MirFiller
the AIPS++ DO/Tasking system

Etymology

DO means it's a distributed object; mirfiller means its a filler of miriad data

Synopsis

Example

Motivation

Thrown Exceptions

To Do

Definition at line 81 of file DOmirfiller.h.

Constructor & Destructor Documentation

mirfiller::mirfiller ( ) [private]

mirfiller::mirfiller ( const mirfiller & other ) [private]

mirfiller::mirfiller ( const String & mirfile )

create the filler, attaching it to a Miriad dataset.

mirfile is the dataset filename

mirfiller::~mirfiller ( )

destruct this filler

Member Function Documentation

virtual String mirfiller::className ( ) const [virtual]

void mirfiller::fill ( const String & msfile ) [inline]

fill the output MS according to the current selections and options.

msfile is the output name to use; it should not already exist.

Definition at line 97 of file DOmirfiller.h.

References MirFiller::fill(), and filler_p.

Record mirfiller::getoptions ( ) [inline]

get the current filling options

Definition at line 125 of file DOmirfiller.h.

References filler_p, and MirFiller::getOptions().

virtual Vector<String> mirfiller::methods ( ) const [virtual]

virtual Vector<String> mirfiller::noTraceMethods ( ) const [virtual]

virtual MethodResult mirfiller::runMethod	(	uInt	which,
		ParameterSet &	parameters,
		Bool	runMethod
	)			`[virtual]`

void mirfiller::selectpols ( const Vector< Int > pols )

select polarization setups from the input Miriad dataset.

void mirfiller::selectspectra	(	const Vector< Int > &	wideChans,
		const Vector< Int > &	narrowWins
	)			throw (UnavailableMiriadDataSelectionError) `[inline]`

select spectra from the input Miriad dataset.

wideChans is a list of one-based channel indices. narrowWins is a list of one-based window indices. The default is to choose all available wide channels and windows.

Definition at line 103 of file DOmirfiller.h.

References filler_p, and MirFiller::selectSpectra().

void mirfiller::setoptions ( const Record & opts ) [inline]

set the options for filling.

The options are set via a Record object for which the following keys are recognized:

Definition at line 122 of file DOmirfiller.h.

References filler_p, and MirFiller::setOptions().

GlishRecord mirfiller::summary	(	Bool	verbose = `True`,
		Bool	scan = `True`
	)

return a description of the input Miriad dataset's contents as a Record object.

If scan is True, the dataset will be implicitly scanned in its entirety to extract all the needed information; otherwise, just the first timestep will be read.

Member Data Documentation

MirFiller mirfiller::filler_p [private]

Definition at line 86 of file DOmirfiller.h.

Referenced by fill(), getoptions(), selectspectra(), and setoptions().

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

code/miriad/Filling/DOmirfiller.h