NRAO Home > CASA > CASA Toolkit Reference Manual
regionmanager.frombcs - Function

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


Description

This function creates a multi-dimensional world coordinate region based on box, chans, stokes inputs familiar from image analysis tasks. It is being introduced as a temporary means of refactoring some python level task code into C++. However, if users find it to have value, its existence can be permanent.

Arguments





Inputs

csys

Coordinate system record. Must be specified.

allowed:

record

Default:

shape

shape of the image. Necessary for boundedness checks. Must have the same number of dimensions as the associated coordinate system. Default = []

allowed:

intArray

Default:

0

box

Direction plane box specification as normally provided in image analysis tasks. ”” means use entire directional plane as specified in shape. Default ””.

allowed:

string

Default:

chans

Channel spec as normally provided to image analysis tasks. ”” means use all channels, Default ””.

allowed:

string

Default:

stokes

Stokes spec as normally provided to image analysis tasks. ”” means use stokescontrol for setting stokes. Default ””.

allowed:

string

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”.

allowed:

string

Default:

a

region

Named region in the form imagename:regionname or region dictionary. Used only if box, chans, stokes not specified. Default ””.

allowed:

any

Default:

variant

Returns
record

Example

 
 

__________________________________________________________________


More information about CASA may be found at the CASA web page

Copyright 2016 Associated Universities Inc., Washington, D.C.

This code is available under the terms of the GNU General Public Lincense


Home | Contact Us | Directories | Site Map | Help | Privacy Policy | Search