get_piximg

Context: crates

Synopsis

Return a CrateData object of an image from a crate.

Syntax

get_piximg(crate)

The get_piximg command returns a CrateData object representing the contents of the image within the crate. To retrieve just the image data (without any metadata), use copy_piximgvals or get_piximgvals.

Example

>>> cr = read_file("image.fits")
>>> img = get_piximg(cr)
>>> print(img)

  Name:     EVENTS_IMAGE
  Datatype: int64
  Unit:     
  Desc:     
  Eltype:   Array
     Ndim:     2
     Dimarr:   (1650, 1572)

which can be compared to the dmlist output:

unix% dmlist image.fits blocks
 
--------------------------------------------------------------------------------
Dataset: image.fits
--------------------------------------------------------------------------------
 
     Block Name                          Type         Dimensions
--------------------------------------------------------------------------------
Block    1: EVENTS_IMAGE                   Image      Int4(1572x1650)
Block    2: GTI7                           Table         2 cols x 1        rows
Block    3: GTI5                           Table         2 cols x 1        rows
Block    4: GTI6                           Table         2 cols x 2        rows
Block    5: GTI3                           Table         2 cols x 2        rows
Block    6: GTI2                           Table         2 cols x 6        rows

Bugs

See the bug pages on the CIAO website for an up-to-date listing of known bugs.

Refer to the CIAO bug pages for an up-to-date listing of known issues.