Last modified: December 2022

AHELP for CIAO 4.16


Context: Tools::Image


Project image along axis


dmimgproject infile outfile axis [clobber] [verbose]


'dmimgproject' projects data along one of the image axes. The sum of the pixels along either axis are output as is the area and normalized integral.

Image pixels that fall outside and region subspace are exlcuded as are any NaN or integer NULL values. The input image may be any data-type, but must be 2 dimensions.


Example 1

dmimgproject infile=img.fits outfile=project.fits axis=x

Project the data to the X-axis. The output file will contain a table of the X-axis column (grid) and the SUM_y(pixels@X_i).

Example 2

dmimgproject infile="exposure.fits[sky=circle(4096,4096,100)][opt
full]" outfile=project.fits axis=y

Project the exposure image onto the Y-axis. Pixels outside the circle are not included in the integral. The area column give the number of pixels included in the sum and the NORM column gives the normalized area.

See "ahelp dmopt" for a full explination of the 'opt' directive.


name type ftype def min max reqd
infile file input       yes
outfile file output       yes
axis string   x x|y   yes
clobber boolean   no      
verbose integer   0 0 5  

Detailed Parameter Descriptions

Parameter=infile (file required filetype=input)

The input image.

The input 2D image.

Parameter=outfile (file required filetype=output)

The output file name

The output file containing the projected data along the given axis.

Parameter=axis (string required default=x min=x|y)

Which data to project the data onto.

The data can be projected onto either the X or Y axis. For a 256(x) by 512(y) image, with axis=x, there will be values for each X axis value (256 of them) with the integral of the Y values in the column. For axis=y, there will be 1 value for each row (512 of them) with the integral along the X-axis.

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.


There are no known bugs for this tool.

See Also

centroid_map, dmfilth, dmimg2jpg, dmimgadapt, dmimgblob, dmimgcalc, dmimgdist, dmimgfilt, dmimghist, dmimgpick, dmimgpm, dmimgreproject, dmimgthresh, dmmaskbin, dmmaskfill, dmnautilus, dmradar, dmregrid, dmregrid2, energy_hue_map, evalpos, hexgrid, map2reg, merge_too_small, mkregmap, pathfinder, vtbin
dmcontour, dmellipse, dmimghull, dmimglasso
mean_energy_map, pileup_map
dmstat, imgmoment, statmap