casac::msplot Class Reference

#include <msplot_cmpt.h>

List of all members.

---

Detailed Description

msplot component class

// TODO: WRITE YOUR DESCRIPTION HERE!

Author:

Shannon Jaeger

Version:

Definition at line 54 of file msplot_cmpt.h.

Public Member Functions
	msplot ()
virtual	~msplot ()
bool	open (const std::string &msname="")
	open, resetting, clearing, and done methods
bool	clearplot (const int subplot=000)
bool	emperorsNewClose ()
bool	closeMS ()
bool	reset ()
bool	close ()
bool	done ()
bool	plotoptions (const int subplot=0, const std::string &plotsymbol="", const std::string &plotcolor="", const std::string &multicolor="none", const std::string &plotrange="", const char timeplot='o', const double markersize=-1.0, const double linewidth=-1.0, const bool overplot=false, const bool replacetopplot=false, const bool removeoldpanels=true, const int skipnrows=0, const int averagenrows=0, const std::string &connect="none", const bool showflags=false, const std::string &title="", const std::string &xlabel="", const std::string &ylabel="", const double fontsize=-1.0, const double windowsize=-1.0, const double aspectratio=-1.0)
bool	summary (const bool selected=true)
bool	setdata (const std::string &baseline="", const std::string &field="", const std::string &scan="", const std::string &uvrange="", const std::string &array="", const std::string &feed="", const std::string &spw="", const std::string &correlation="", const std::string &time="")
bool	avedata (const std::string &chanavemode="none", const std::string &corravemode="none", const std::string &datacolumn="DATA", const std::string &averagemode="vector", const std::string &averagechan="1", const std::string &averagetime="0", const bool averageflagged=false, const bool averagescan=false, const bool averagebl=false, const bool averagearray=false, const bool averagechanid=false)
bool	checkplotxy (const std::string &x="uvdist", const std::string &y="data", const std::string &xcolumn="data", const std::string &ycolumn="data", const std::string &xvalue="amp", const std::string &yvalue="amp", const std::vector< std::string > &iteration=std::vector< std::string >(1,""))
bool	plotxy (const std::string &x="uvdist", const std::string &y="data", const std::string &xcolumn="data", const std::string &ycolumn="data", const std::string &xvalue="amp", const std::string &yvalue="amp", const std::vector< std::string > &iteration=std::vector< std::string >(1,""))
bool	checkplot (const std::string &type="", const std::string &column="", const std::string &value="", const std::vector< std::string > &iteration=std::vector< std::string >(1,""))
bool	plot (const std::string &type="", const std::string &column="", const std::string &value="", const std::vector< std::string > &iteration=std::vector< std::string >(1,""))
bool	iterplotstart ()
	Iterative plot function definitions.
bool	iterplotnext ()
bool	iterplotstop (const bool rmplotter=false)
bool	savefig (const std::string &filename="", const int dpi=-1, const std::string &orientation="", const std::string &papertype="", const std::string &facecolor="", const std::string &edgecolor="")
	For those who wish to create papers, and the pipeline group a routine for saving the plotted image to a file.
bool	markregion (const int subplot=111, const std::vector< double > &region=std::vector< double >(1, 0.0))
bool	flagdata ()
bool	unflagdata ()
bool	clearflags ()
bool	locatedata ()
bool	saveflagversion (const std::string &versionname="""", const std::string &comment="""", const std::string &merge="""")
bool	restoreflagversion (const std::vector< std::string > &versionname=std::vector< std::string >(1,""""), const std::string &merge="""")
bool	deleteflagversion (const std::vector< std::string > &versionname=std::vector< std::string >(1,""""))
bool	getflagversionlist ()

---

Constructor & Destructor Documentation

casac::msplot::msplot

(

)

virtual casac::msplot::~msplot

(

)

[virtual]

---

Member Function Documentation

bool casac::msplot::open

(

const std::string &

msname = ""

)

open, resetting, clearing, and done methods

bool casac::msplot::clearplot

(

const int

subplot = 000

)

bool casac::msplot::emperorsNewClose

(

)

bool casac::msplot::closeMS

(

)

bool casac::msplot::reset

(

)

bool casac::msplot::close

(

)

bool casac::msplot::done

(

)

bool casac::msplot::plotoptions	(	const int	subplot = 0,
		const std::string &	plotsymbol = "",
		const std::string &	plotcolor = "",
		const std::string &	multicolor = "none",
		const std::string &	plotrange = "",
		const char	timeplot = 'o',
		const double	markersize = -1.0,
		const double	linewidth = -1.0,
		const bool	overplot = false,
		const bool	replacetopplot = false,
		const bool	removeoldpanels = true,
		const int	skipnrows = 0,
		const int	averagenrows = 0,
		const std::string &	connect = "none",
		const bool	showflags = false,
		const std::string &	title = "",
		const std::string &	xlabel = "",
		const std::string &	ylabel = "",
		const double	fontsize = -1.0,
		const double	windowsize = -1.0,
		const double	aspectratio = -1.0
	)

bool casac::msplot::summary

(

const bool

selected = true

)

bool casac::msplot::setdata	(	const std::string &	baseline = "",
		const std::string &	field = "",
		const std::string &	scan = "",
		const std::string &	uvrange = "",
		const std::string &	array = "",
		const std::string &	feed = "",
		const std::string &	spw = "",
		const std::string &	correlation = "",
		const std::string &	time = ""
	)

bool casac::msplot::avedata	(	const std::string &	chanavemode = "none",
		const std::string &	corravemode = "none",
		const std::string &	datacolumn = "DATA",
		const std::string &	averagemode = "vector",
		const std::string &	averagechan = "1",
		const std::string &	averagetime = "0",
		const bool	averageflagged = false,
		const bool	averagescan = false,
		const bool	averagebl = false,
		const bool	averagearray = false,
		const bool	averagechanid = false
	)

bool casac::msplot::checkplotxy	(	const std::string &	x = "uvdist",
		const std::string &	y = "data",
		const std::string &	xcolumn = "data",
		const std::string &	ycolumn = "data",
		const std::string &	xvalue = "amp",
		const std::string &	yvalue = "amp",
		const std::vector< std::string > &	iteration = std::vector< std::string >(1,"")
	)

bool casac::msplot::plotxy	(	const std::string &	x = "uvdist",
		const std::string &	y = "data",
		const std::string &	xcolumn = "data",
		const std::string &	ycolumn = "data",
		const std::string &	xvalue = "amp",
		const std::string &	yvalue = "amp",
		const std::vector< std::string > &	iteration = std::vector< std::string >(1,"")
	)

bool casac::msplot::checkplot	(	const std::string &	type = "",
		const std::string &	column = "",
		const std::string &	value = "",
		const std::vector< std::string > &	iteration = std::vector< std::string >(1,"")
	)

bool casac::msplot::plot	(	const std::string &	type = "",
		const std::string &	column = "",
		const std::string &	value = "",
		const std::vector< std::string > &	iteration = std::vector< std::string >(1,"")
	)

bool casac::msplot::iterplotstart

(

)

Iterative plot function definitions.

Note that iterplotstart() is the same as iterplotnext(), we just have it so the user's are more comfortable with things. They can just use iterplotnext() without using iterplotstart() if they wish.

bool casac::msplot::iterplotnext

(

)

bool casac::msplot::iterplotstop

(

const bool

rmplotter = false

)

bool casac::msplot::savefig	(	const std::string &	filename = "",
		const int	dpi = -1,
		const std::string &	orientation = "",
		const std::string &	papertype = "",
		const std::string &	facecolor = "",
		const std::string &	edgecolor = ""
	)

For those who wish to create papers, and the pipeline group a routine for saving the plotted image to a file.

Only supported types at this point are eps, ps, pdf, and png. png is takes the least amount of time to create.

bool casac::msplot::markregion	(	const int	subplot = 111,
		const std::vector< double > &	region = std::vector< double >(1, 0.0)
	)

bool casac::msplot::flagdata

(

)

bool casac::msplot::unflagdata

(

)

bool casac::msplot::clearflags

(

)

bool casac::msplot::locatedata

(

)

bool casac::msplot::saveflagversion	(	const std::string &	versionname = """",
		const std::string &	comment = """",
		const std::string &	merge = """"
	)

bool casac::msplot::restoreflagversion	(	const std::vector< std::string > &	versionname = std::vector< std::string >(1,""""),
		const std::string &	merge = """"
	)

bool casac::msplot::deleteflagversion

(

const std::vector< std::string > &

versionname = std::vector< std::string >(1,"""")

)

bool casac::msplot::getflagversionlist

(

)

---

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

• xmlcasa/implement/ms/msplot_cmpt.h

---