asap.flagplotter.flagplotter Class Reference

Inheritance diagram for asap.flagplotter.flagplotter:

List of all members.

Public Member Functions
def	__init__
def	set_showflagged
def	set_panelling
def	set_range
def	plotazel
def	plotpointing
def	plottp
def	save_data
def	set_data
def	plot
Private Member Functions
def	_new_custombar
def	_invalid_func
def	_plot
def	_plot_with_flag
def	_get_label
def	_is_new_scan
Private Attributes
	_scan
	_panelling
	_ismodified
	_showflagged
	_startrow

---

Detailed Description

The flag plotter
Only row based panneling is allowed.

Example:
   scan = asa p.scantable(filename='your_filename',average=False)
   guiflagger = asap.flagplotter(visible=True)
   guiflagger.plot(scan)
   ### flag/Unflag data graphically.
   guiflagger.save_data(name='flagged_file.asap',format='ASAP')

NOTICE: 
   The flagged data is not saved until you explicitly run scantable.save

Definition at line 11 of file flagplotter.py.

---

Constructor & Destructor Documentation

def asap.flagplotter.flagplotter.__init__	(		self,
			visible = None,
			kwargs
	)

Reimplemented from asap.asapplotter.asapplotter.

Definition at line 26 of file flagplotter.py.

---

Member Function Documentation

def asap.flagplotter.flagplotter._get_label	(		self,
			scan,
			row,
			mode = 'title',
			userlabel = None
	)		[private]

Reimplemented from asap.asapplotter.asapplotter.

Definition at line 284 of file flagplotter.py.

def asap.flagplotter.flagplotter._invalid_func	(		self,
			name
	)		[private]

Definition at line 61 of file flagplotter.py.

Referenced by asap.flagplotter.flagplotter.plotazel(), asap.flagplotter.flagplotter.plotpointing(), and asap.flagplotter.flagplotter.plottp().

def asap.flagplotter.flagplotter._is_new_scan	(		self,
			scan
	)		[private]

Definition at line 303 of file flagplotter.py.

References asap.asapplotter.asapplotter._data.

Referenced by asap.flagplotter.flagplotter.plot(), and asap.flagplotter.flagplotter.set_data().

def asap.flagplotter.flagplotter._new_custombar

(

self

)

[private]

Reimplemented from asap.asapplotter.asapplotter.

Definition at line 37 of file flagplotter.py.

References asap.asapplotter.asapplotter._visible.

def asap.flagplotter.flagplotter._plot	(		self,
			scan
	)		[private]

Reimplemented from asap.asapplotter.asapplotter.

Definition at line 142 of file flagplotter.py.

References asap.flagplotter.flagplotter._plot_with_flag(), and asap.flagplotter.flagplotter._showflagged.

def asap.flagplotter.flagplotter._plot_with_flag	(		self,
			scan,
			showflag = False
	)		[private]

Definition at line 161 of file flagplotter.py.

References asap.asapplotter.asapplotter._abcissa, asap.asapplotter.asapplotter._cols, asap.asapplotter.asapplotter._get_label(), asap.asapplotter.asapplotter._ipanel, asap.asapplotter.asapplotter._margins, asap.asapplotter.asapplotter._maskselection, asap.asapplotter.asapplotter._minmaxx, asap.asapplotter.asapplotter._minmaxy, asap.asapplotter.asapplotter._offset, asap.asapplotter.asapplotter._ordinate, asap.asapplotter.asapplotter._rows, asap.asapplotter.asapplotter._stacking, asap.asapplotter.asapplotter._startrow, asap.asapplotter.asapplotter._title, asap.asapplotter.asapplotter._usermask, listvis_regression.array, and irc_cs_task_regression.max.

Referenced by asap.flagplotter.flagplotter._plot().

def asap.flagplotter.flagplotter.plot	(		self,
			scan = None
	)

Plot a scantable.
Parameters:
    scan:   a scantable
Note:
    If a scantable was specified in a previous call
    to plot, no argument has to be given to 'replot'
    NO checking is done that the abcissas of the scantable
    are consistent e.g. all 'channel' or all 'velocity' etc.

Reimplemented from asap.asapplotter.asapplotter.

Definition at line 131 of file flagplotter.py.

References asap.flagplotter.flagplotter._is_new_scan(), asap.flagplotter.flagplotter._ismodified, asap.asapplotter.asapplotter._legendloc, asap.flagplotter.flagplotter._showflagged, and asap.asapplotter.asapplotter.set_legend().

Referenced by task_sdgrid.sdgrid_worker.finalize().

def asap.flagplotter.flagplotter.plotazel	(		self,
			args,
			kwargs
	)

This function is not available for the class flagplotter 

Reimplemented from asap.asapplotter.asapplotter.

Definition at line 83 of file flagplotter.py.

References asap.flagplotter.flagplotter._invalid_func().

def asap.flagplotter.flagplotter.plotpointing	(		self,
			args,
			kwargs
	)

This function is not available for the class flagplotter 

Reimplemented from asap.asapplotter.asapplotter.

Definition at line 87 of file flagplotter.py.

References asap.flagplotter.flagplotter._invalid_func().

def asap.flagplotter.flagplotter.plottp	(		self,
			args,
			kwargs
	)

This function is not available for the class flagplotter 

Definition at line 91 of file flagplotter.py.

References asap.flagplotter.flagplotter._invalid_func().

def asap.flagplotter.flagplotter.save_data	(		self,
			name = None,
			format = None,
			overwrite = False
	)

Store the plotted scantable on disk.
This function simply redirects call to scantable.save()

Parameters:
    
    name:        the name of the outputfile. For format "ASCII"
         this is the root file name (data in 'name'.txt
         and header in 'name'_header.txt)
    
    format:      an optional file format. Default is ASAP.
         Allowed are:
            * 'ASAP' (save as ASAP [aips++] Table),
            * 'SDFITS' (save as SDFITS file)
            * 'ASCII' (saves as ascii text file)
            * 'MS2' (saves as an casacore MeasurementSet V2)
            * 'FITS' (save as image FITS - not readable by class)
            * 'CLASS' (save as FITS readable by CLASS)
    
    overwrite:   If the file should be overwritten if it exists.
         The default False is to return with warning
         without writing the output. USE WITH CARE.

Definition at line 95 of file flagplotter.py.

References asap.asapplotter.asapplotter._data.

def asap.flagplotter.flagplotter.set_data	(		self,
			scan,
			refresh = True
	)

Set a scantable to plot.
Parameters:
    scan:      a scantable
    refresh:   True (default) or False. If True, the plot is
       replotted based on the new parameter setting(s).
       Otherwise,the parameter(s) are set without replotting.
Note:
   The user specified masks and data selections will be reset
   if a new scantable is set. This method should be called before
   setting data selections (set_selection) and/or masks (set_mask).

Reimplemented from asap.asapplotter.asapplotter.

Definition at line 124 of file flagplotter.py.

References asap.flagplotter.flagplotter._is_new_scan(), and asap.flagplotter.flagplotter._ismodified.

def asap.flagplotter.flagplotter.set_panelling	(		self,
			which = 'r'
	)

This function is not available for the class flagplotter 

Reimplemented from asap.asapplotter.asapplotter.

Definition at line 67 of file flagplotter.py.

References asap.asapplotter.asapplotter._panelling.

def asap.flagplotter.flagplotter.set_range	(		self,
			xstart = None,
			xend = None,
			ystart = None,
			yend = None,
			refresh = False,
			offset = None
	)

This function is not available for the class flagplotter 

Reimplemented from asap.asapplotter.asapplotter.

Definition at line 76 of file flagplotter.py.

References asap.asapplotter.asapplotter._panelling.

def asap.flagplotter.flagplotter.set_showflagged	(		self,
			show
	)

Whether or not plotting flagged data

Definition at line 53 of file flagplotter.py.

References asap.flagplotter.flagplotter._showflagged.

---

Member Data Documentation

asap.flagplotter.flagplotter._ismodified [private]

Definition at line 33 of file flagplotter.py.

Referenced by asap.flagplotter.flagplotter.plot(), and asap.flagplotter.flagplotter.set_data().

asap.flagplotter.flagplotter._panelling [private]

Reimplemented from asap.asapplotter.asapplotter.

Definition at line 31 of file flagplotter.py.

asap.flagplotter.flagplotter._scan [private]

Definition at line 27 of file flagplotter.py.

Referenced by asap.lagflagger.lagplotter.flag().

asap.flagplotter.flagplotter._showflagged [private]

Definition at line 34 of file flagplotter.py.

Referenced by asap.flagplotter.flagplotter._plot(), asap.flagplotter.flagplotter.plot(), and asap.flagplotter.flagplotter.set_showflagged().

asap.flagplotter.flagplotter._startrow [private]

Reimplemented from asap.asapplotter.asapplotter.

Definition at line 270 of file flagplotter.py.

---

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

• asap/flagplotter.py