NRAO Home > CASA > CASA Task Reference Manual

0.1.42 immoments

Requires:

Synopsis
Compute moments from an image

Description



Arguments





Inputs

imagename

Name of the input image

allowed:

string

Default:

moments

List of moments you would like to compute

allowed:

intArray

Default:

0

axis

The momement axis: ra, dec, lat, long, spectral, or stokes

allowed:

any

Default:

variant spectral

region

Region selection. See ”help par.region” for details. Default is to use the full image.

allowed:

any

Default:

variant

box

Rectangular region(s) to select in direction plane. See ”help par.box” for details. Default is to use the entire direction plane.

allowed:

string

Default:

chans

Channels to use. See ”help par.chans” for details. Default is to use all channels.

allowed:

string

Default:

stokes

Stokes planes to use. See ”help par.stokes” for details. Default is to use all Stokes planes.

allowed:

string

Default:

mask

Mask to use. See help par.mask. Default is none.

allowed:

string

Default:

variant

includepix

Range of pixel values to include

allowed:

any

Default:

variant -1

excludepix

Range of pixel values to exclude

allowed:

any

Default:

variant -1

outfile

Output image file name (or root for multiple moments)

allowed:

string

Default:

stretch

Stretch the mask if necessary and possible?

allowed:

bool

Default:

False

Returns
bool

Example

 
The spectral moment distributions at each pixel are  
determined.  See the cookbook and User Reference Manual for  
mathematical details.  
 
The main control of the calculation is given by parameter  
moments:  
 
        moments=-1  - mean value of the spectrum  
moments=0   - integrated value of the spectrum  
moments=1   - intensity weighted coordinate;traditionally used to get  
      ’velocity fields’  
    moments=2   - intensity weighted dispersion of the coordinate; traditionally  
      used to get "velocity dispersion"  
moments=3   - median of I  
moments=4   - median coordinate  
moments=5   - standard deviation about the mean of the spectrum  
moments=6   - root mean square of the spectrum  
moments=7   - absolute mean deviation of the spectrum  
moments=8   - maximum value of the spectrum  
moments=9   - coordinate of the maximum value of the spectrum  
moments=10  - minimum value of the spectrum  
    moments=11  - coordinate of the minimum value of the spectrum  
 
   Keyword arguments:  
   imagename    Name of input image  
                default: none; example: imagename="ngc5921_task.image"  
   moments      List of moments you would like to compute  
                default: 0 (integrated spectrum);example: moments=[0,1]  
                see list above  
   axis         The moment axis  
                default: (spectral axis); example: axis=spec  
                options: ra, dec, lattitude, longitude, spectral, stokes  
   mask         Mask to use. See help par.mask. Default is none.  
   stretch      Stretch the input mask if necessary and possible. See below.  
   region       Region selection. See "help par.region" for details. Default  
                is to use the full image.  
    box         Rectangular region to select in direction plane. See  
                "help par.box" for details. Default is to use the entire direction plane.  
                Example: box="10,10,50,50"  
                box = "10,10,30,30,35,35,50,50" (two boxes)  
    chans       Channels to use. See "help par.chans" for details. Default is to use  
                all channels.  
                See "help par.chans" for examples.  
    stokes      Stokes planes to use. See "help par.stokes" for details. Default is to  
                use all Stokes planes.  
                Example: stokes="IQUV";  
                Example:stokes="I,Q"  
    includepix  Range of pixel values to include  
                default: [-1] (all pixels); example=[0.02,100.0]  
    excludepix  Range of pixel values to exclude  
                default: [-1] (don"t exclude pixels); example=[100.,200.]  
    outfile     Output image file name (or root for multiple moments)  
                default: "" (input+auto-determined suffix);example: outfile="source_moment"  
 
    If stretch is true and if the number of mask dimensions is less than  
    or equal to the number of image dimensions and some axes in the  
    mask are degenerate while the corresponding axes in the image are not,  
    the mask will be stetched in the degenerate axis dimensions. For example,  
    if the input image has shape [100, 200, 10] and the input  
    mask has shape [100, 200, 1] and stretch is true, the mask will be  
    stretched along the third dimension to shape [100, 200, 10]. However if  
    the mask is shape [100, 200, 2], stretching is not possible and an  
    error will result.  
 
        Example for finding the 1-momment, intensity-weighted  
        coordinate, often used for finding velocity fields.  
        immoments( axis="spec", imagename="myimage", moment=1, outfile="velocityfields" )  
 
        Example finding the spectral mean, -1 moment, on a specified region  
        of the image as defined by the box and stokes parameters  
        taskname="immoments"  
        default()  
        imagename = "myimage"  
        moment    =  -1  
 
        axis      = "spec"  
        stokes     = "I"  
        box       = [55,12,97,32]  
        go  
 
        Example using a mask created with a second file to select the  
        data used to calculate the 0-moments, integrated values.  In  
        this case the mask is from the calibrated.im file and all values  
        that have a value greater than 0.5 will be positive in the mask..  
        immoments( "clean.image", axis="spec", mask="calibrated.im>0.5", outfile="mom_withmask.im" )  
 
If an image has multiple (per-channel beams) and the moment axis is equal to the  
spectral axis, each channel will be convolved with a beam that is equal to the beam  
having the largest area in the beamset prior to moment determination.  
 
 


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