mirfiller Class Reference

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

#include <DOmirfiller.h>

Inheritance diagram for mirfiller:

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

virtual

void mirfiller::fill ( const casacore::String &  msfile )

inline

fill the output casacore::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.

casacore::Record mirfiller::getoptions ( )

inline

get the current filling options

Definition at line 125 of file DOmirfiller.h.

References filler_p, and MirFiller::getOptions().

virtual casacore::Vector<casacore::String> mirfiller::methods ( ) const

virtual

virtual casacore::Vector<casacore::String> mirfiller::noTraceMethods ( ) const

virtual

virtual MethodResult mirfiller::runMethod ( casacore::uInt  which, ParameterSet &  parameters, casacore::Bool  runMethod  )

virtual

void mirfiller::selectpols

(

const casacore::Vector< casacore::Int >

pols

)

select polarization setups from the input Miriad dataset.

void mirfiller::selectspectra ( const casacore::Vector< casacore::Int > &  wideChans, const casacore::Vector< casacore::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 casacore::Record &  opts )

inline

set the options for filling.

The options are set via a casacore::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	(	casacore::Bool	verbose = true,
		casacore::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:

• casa/code/miriad/Filling/DOmirfiller.h