Chandra X-Ray Observatory
	(CXC)
Skip to the navigation links
Last modified: December 2013

URL: http://cxc.harvard.edu/ciao/ahelp/dmmaskfill.html
Jump to: Description · Example · Parameters · Bugs · See Also


AHELP for CIAO 4.9

dmmaskfill

Context: tools

Synopsis

Replaces mask values with those found in lookup table

Syntax

dmmaskfill  infile maskfile outfile [clobber] [verbose]

Description

`dmmaskfill' takes in an input mask image (integer data-type) and a table (which must have 2 columns). It looks up the image mask value in the 1st column of the table and replaces it with the value in the 2nd column in the table ('coloring by number').

Example

dmmaskfill infile=stats.fits[cols mask,mean] maskfile=mask.fits
outfile=filled.fits

The values in the file 'mask.fits' are looked up in the 'mask' column of 'stats.fits'. The output image ('filled.fits') contains the values of the 'mean' column that correspond to the mask value.

Parameters

name type ftype def min max reqd
infile file input       yes
maskfile file input       yes
outfile file output       yes
clobber boolean   no      
verbose integer   0 0 5  

Detailed Parameter Descriptions

Parameter=infile (file required filetype=input)

The input (lookup) table.

The table must have two columns. The first column (assumed to be an interger data-type) is what is matched to the values in the maskfile. The 2nd column is the value that is used in the output image. A DM '[cols ]' filter can be used to select the columns from the table and re-order them if necessary.

Parameter=maskfile (file required filetype=input)

The input mask image

The input mask image must be an interger data-type.

Parameter=outfile (file required filetype=output)

The output file name

The output file will be an image matching the maskfile image. The output values will be taken from the lookup table.

Parameter=clobber (boolean default=no)

Remove output if it exists?

Used to specify whether or not to clobber existing file that has the same name as the specified output file

Parameter=verbose (integer default=0 min=0 max=5)

The tool chatter level

Verbose can be from 0 to 5, generating different amounts of debugging output.

Bugs

There are no known bugs for this tool.

See Also

dm
dmfiltering
tools
dmappend, dmcontour, dmellipse, dmfilth, dmimg2jpg, dmimgadapt, dmimgblob, dmimgcalc, dmimgdist, dmimgfilt, dmimghist, dmimghull, dmimglasso, dmimgpick, dmimgpm, dmimgproject, dmimgreproject, dmimgthresh, dmmaskbin, dmnautilus, dmregrid, dmregrid2, dmstat, evalpos, imgmoment, mean_energy_map, pileup_map

Last modified: December 2013
Smithsonian Institute Smithsonian Institute

The Chandra X-Ray Center (CXC) is operated for NASA by the Smithsonian Astrophysical Observatory. 60 Garden Street, Cambridge, MA 02138 USA.   Email:   cxchelp@head.cfa.harvard.edu Smithsonian Institution, Copyright © 1998-2017. All rights reserved.