shuffle_image

Context: images

Synopsis

Repositions the specified image within its depth. The user may elect to move the image to the front of the depth, the back of the depth, or swap forward/backward with another object at the same depth.

Syntax

shuffle_image([id,] [direction])

Description

id - an optional ChipsId structure containing values to modify the currency state for the command, or a string to specify the id of the image to operate on.
direction - how to shuffle the object; options are chips_forward, chips_backward, chips_front, and chips_back. If not given then chips_forward is assumed.

By default, objects within a depth are ordered chonologically based on when they were added to that depth. The objects are stacked with the oldest item at the back of the list and the newest item at the front of the list. This order dictates how the objects overlap when drawn.

The shuffle_image command modifies the order in which objects at a specific depth are rendered. It may be used to position a image in front of or behind other objects which are at the same depth.

The available "direction" options are:

chips_back - send to the back of the stack
chips_front - send to the front of the stack
chips_forward - moves one step closer to the front
chips_backward - moves one step further back

The shuffle routines can only operate on a single object. An error is returned if currency is set to "all".

Example 1

chips> add_image('evt2_image.fits')
chips> add_image('evt2_image2.fits')
chips> add_image('evt2_image3.fits')
chips> shuffle_image(chips_backward)

Create three overlapping images. Move the current image one step back in the stack.

Example 2

chips> shuffle_image("image1",chips_front)

Move the image "image1" to the front of the depth.

Bugs

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