Inheritance diagram for __casac__.regionmanager.regionmanager:

Public Member Functions
def	__init__
def	absreltype
def	box
def	frombcs
def	complement
def	concatenation
def	deletefromtable
def	difference
def	done
def	fromtextfile
def	fromtext
def	fromfiletorecord
def	tofile
def	fromrecordtotable
def	fromtabletorecord
def	intersection
def	ispixelregion
def	isworldregion
def	namesintable
def	setcoordinates
def	makeunion
def	wbox
def	wpolygon
Public Attributes
	this
Static Private Attributes
dictionary	__swig_setmethods__
tuple	__setattr__
dictionary	__swig_getmethods__
tuple	__getattr__
	__repr__
	__swig_destroy__
	__del__

Detailed Description

Proxy of C++ casac::regionmanager class

Definition at line 70 of file regionmanager.py.

Constructor & Destructor Documentation

def __casac__.regionmanager.regionmanager.__init__ ( self )

__init__(self) -> regionmanager

Definition at line 77 of file regionmanager.py.

Member Function Documentation

def __casac__.regionmanager.regionmanager.absreltype	(	self,
		absrelvalue = `0`
	)

absreltype(self, absrelvalue=0) -> string

Summary
Convert region type value to a string

Input Parameters:
absrelvalue      Region type value 0 Integer - 1, 2, 3, 4 

--------------------------------------------------------------------------------

Definition at line 84 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.box	(	self,
		args,
		kwargs
	)

box(self, blc=initialize_vector(1, (double)0), trc=initialize_vector(1, (double)-1), inc=initialize_vector(1, (double)1), 
    absrel=string("abs"), frac=False, comment=string("")) -> record *

Summary
Create a pixel box region

Input Parameters:
blc              blc of the box 0 Unity 
trc              trc of the box -1 Shape 
inc              increment 1 
absrel           Absolute or relative coordinates relref relcen abs 
frac             Pixel or fractional coordinates false F 
comment          A comment stored with the region 

--------------------------------------------------------------------------------

Definition at line 99 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.complement	(	self,
		args,
		kwargs
	)

complement(self, region=initialize_variant(""), comment=string("")) -> record *

Summary
Create the complement of a world region

Input Parameters:
region           The world region Region tool 
comment          A comment stored with the region String 

--------------------------------------------------------------------------------

Definition at line 142 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.concatenation	(	self,
		args,
		kwargs
	)

concatenation(self, box=initialize_variant(""), regions=initialize_variant(""), comment=string("")) -> record *

Summary
Concatenate world regions along a new axis

Input Parameters:
box              The axis to concatenate along world box region 
regions          World regions Record containing world regions 
comment          A comment stored with the region String 

--------------------------------------------------------------------------------

Definition at line 158 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.deletefromtable	(	self,
		args,
		kwargs
	)

deletefromtable(self, tablename=string(""), regionname=string("")) -> bool

Summary
Delete regions from a Table

Input Parameters:
tablename        The table Image tool, table tool or String 
regionname       Name(s) of the region(s) to delete Vector of strings 

--------------------------------------------------------------------------------

Definition at line 175 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.difference	(	self,
		args,
		kwargs
	)

difference(self, region1=initialize_record(""), region2=initialize_record(""), comment=string("")) -> record *

Summary
Create the difference of two world regions

Input Parameters:
region1          The first world region 
region2          The second world region Region tool 
comment          A comment stored with the region String 

--------------------------------------------------------------------------------

Definition at line 191 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.done ( self )

done(self) -> bool

Summary
Destroy this regionmanager
--------------------------------------------------------------------------------

Definition at line 208 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.frombcs	(	self,
		args,
		kwargs
	)

frombcs(self, csys=initialize_record(""), shape=initialize_vector(1, (int)0), box=string(""), chans=string(""), 
    stokes=string(""), stokescontrol=string("a"), region=initialize_variant("")) -> record *

Summary
Create a world coordinate region based on box-chan-stokes input

Input Parameters:
csys             Coordinate system record. Must be specified. 
shape            shape of the image. Necessary for boundedness checks. Must have the same number of dimensions as the associated coordinate system. Default = [] 0 
box              Direction plane box specification as normally provided in image analysis tasks. '' means use entire directional plane as specified in shape. Default ''. 
chans            Channel spec as normally provided to image analysis tasks. '' means use all channels, Default ''. 
stokes           Stokes spec as normally provided to image analysis tasks. '' means use stokescontrol for setting stokes. Default ''. 
stokescontrol    Polarization set to use if stokes parameter is not specified. Choices are 'a' (use all stokes) and 'f' (use first stokes). Default 'a'. a 
region           Named region in the form imagename:regionname or region dictionary. Used only if box, chans, stokes not specified. Default ''. 

--------------------------------------------------------------------------------

Definition at line 120 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.fromfiletorecord	(	self,
		args,
		kwargs
	)

fromfiletorecord(self, filename=string(""), verbose=True, regionname=string("")) -> record *

Summary
Create a region record(s) from a file(s).

Input Parameters:
filename         List of files containing the Image Regions File name(s) 
verbose          Report successful saves true true 
regionname       Name(s) of the region(s) when saved in the table Self naming 

--------------------------------------------------------------------------------

Definition at line 253 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.fromrecordtotable	(	self,
		args,
		kwargs
	)

fromrecordtotable(self, tablename=string(""), regionname=initialize_variant(""), regionrec=initialize_record(""), 
    verbose=True) -> string

Summary
Save regions stored in a record into a Table

Input Parameters:
tablename        The table Image tool, table tool or String 
regionname       Name(s) of the region(s) when saved in the table Vector of strings 
regionrec        Region(s) to save Record of region tool(s) 
verbose          Report successful saves true True 

--------------------------------------------------------------------------------

Definition at line 286 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.fromtabletorecord	(	self,
		args,
		kwargs
	)

fromtabletorecord(self, tablename=string(""), regionname=initialize_variant(""), verbose=True) -> record *

Summary
Restore regions from a Table to a record

Input Parameters:
tablename        The table Image tool, table tool or String 
regionname       Name of the region(s) to restore All 
verbose          Report successful restores true True 

--------------------------------------------------------------------------------

Definition at line 305 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.fromtext	(	self,
		args,
		kwargs
	)

fromtext(self, text=string(""), shape=initialize_vector(1, (int)1), csys=initialize_record("")) -> record *

Summary
Create a region dictionary from a region text string.

Input Parameters:
text             region description 
shape            Image shape, only used if first region is a difference. 1 
csys             Coordinate system record. Defaults to coordinate system used in rg.setcoordinates() 

--------------------------------------------------------------------------------

Definition at line 236 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.fromtextfile	(	self,
		args,
		kwargs
	)

fromtextfile(self, filename=string(""), shape=initialize_vector(1, (int)0), csys=initialize_record("")) -> record *

Summary
Create a region dictionary from a region text file.

Input Parameters:
filename         List of text file containing the region description 
shape            Image shape. 0 
csys             Coordinate system record. Defaults to coordinate system used in rg.setcoordinates() 

--------------------------------------------------------------------------------

Definition at line 219 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.intersection	(	self,
		args,
		kwargs
	)

intersection(self, regions=initialize_variant(""), comment=string("")) -> record *

Summary
Create the intersection of some world regions

Input Parameters:
regions          World regions and comment Region tools or record of region tools, and String 
comment          A comment stored with the region String 

--------------------------------------------------------------------------------

Definition at line 322 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.ispixelregion	(	self,
		args,
		kwargs
	)

ispixelregion(self, region=initialize_record("")) -> bool

Summary
Is this region a pixel region ?

Input Parameters:
region           The region Region tool 

--------------------------------------------------------------------------------

Definition at line 338 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.isworldregion	(	self,
		args,
		kwargs
	)

isworldregion(self, region=initialize_record("")) -> bool

Summary
Is this region a world region ?

Input Parameters:
region           The region Region tool 

--------------------------------------------------------------------------------

Definition at line 353 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.makeunion	(	self,
		args,
		kwargs
	)

makeunion(self, regions=initialize_variant(""), comment=string("")) -> record *

Summary
Create a union of world regions

Input Parameters:
regions          World regions and comment Record/dict of regions to be unionized (the key names are immaterial) 
comment          A comment stored with the region 

--------------------------------------------------------------------------------

Definition at line 398 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.namesintable	(	self,
		args,
		kwargs
	)

namesintable(self, tablename=string("")) -> std::vector< std::string >

Summary
Find the names of the regions stored in a Table

Input Parameters:
tablename        The table Image tool, table tool or String 

--------------------------------------------------------------------------------

Definition at line 368 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.setcoordinates	(	self,
		args,
		kwargs
	)

setcoordinates(self, csys=initialize_record("")) -> bool

Summary
Set new default Coordinate System

Input Parameters:
csys             Default Coordinate System for use in world regions Coordinate tool 

--------------------------------------------------------------------------------

Definition at line 383 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.tofile	(	self,
		args,
		kwargs
	)

tofile(self, filename=string(""), region=initialize_record("")) -> bool

Summary
Create a region record file that can be read by from filetorecord.

Input Parameters:
filename         List of files containing the Image Regions File name(s) 
region           region record/dict to store in the file 

--------------------------------------------------------------------------------

Definition at line 270 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.wbox	(	self,
		args,
		kwargs
	)

wbox(self, blc=initialize_variant(""), trc=initialize_variant(""), pixelaxes=initialize_vector(1, (int)-1), 
    csys=initialize_record(""), absrel=string("'abs'"), comment=string("")) -> record *

Summary
Create a world box region

Input Parameters:
blc              blc of the box ; a vector of quantities Unity 
trc              trc of the box; a vector of quantities Shape 
pixelaxes        Which pixel axes -1 [0,1,2,...] 
csys             Coordinate System Private Coordinate System 
absrel           Absolute or relative coordinates Vector of strings from 'abs', 'relref' and 'relcen' 'abs' 
comment          A comment stored with the region 

--------------------------------------------------------------------------------

Definition at line 414 of file regionmanager.py.

def __casac__.regionmanager.regionmanager.wpolygon	(	self,
		args,
		kwargs
	)

wpolygon(self, x=initialize_variant(""), y=initialize_variant(""), pixelaxes=initialize_vector(1, (int)-1), 
    csys=initialize_record(""), absrel=string("abs"), comment=string("")) -> record *

Summary
Create a world polygon region with quantities

Input Parameters:
x                The x vector; a vector of quantities 
y                The y vector; vector of quantities Quantity vector 
pixelaxes        which pixel axes; vector of integers ..default -1 means [0,1] -1 [1,2] 
csys             Coordinate System Private Coordinate System 
absrel           Absolute or relative coordinates; possibilities are 'abs', 'rel', 'relcen' abs 'abs' 
comment          A comment stored with the region 

--------------------------------------------------------------------------------

Definition at line 435 of file regionmanager.py.