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

URL: http://cxc.harvard.edu/chips/adjust_grid_yrelsize.html
Jump to: Description · Examples · Bugs · See Also


AHELP for CIAO 4.5 ChIPS v1

adjust_grid_yrelsize

Context: plots

Synopsis

Modifies the height of one row of plots created by split or grid_objects.

Syntax

adjust_grid_yrelsize([id,] row, size)

Description

  • id - an optional ChipsId structure containing values to modify the currency state for the command.
  • row - indicates which row of plots to modify. The rows are numbered from top to bottom, starting at 1.
  • size - ratio of the height of the selected row to the other rows (e.g. 1=same size, 2=twice as tall, .5=half as tall).

The adjust_grid_yrelsize command changes the size of a row of plots relative to the other rows in the frame created by split or grid_objects.

The height of the specified row is set to "size * unit_height". All other rows are set to unit_height.

The following is used to determine the height of the columns:

available_area = 1 - (top_margin + bottom_margin + (num_rows -1)*ygapsize)

unit_height = available_area / ((num_rows-1) + size)

To change the spacing between the plots, use the adjust_grid_gaps command ("ahelp adjust_grid_gaps") .

Example 1

chips> split(3,3)
chips> adjust_grid_yrelsize(2,.5)

A split command is issued to create a grid of 9 plots. The adjust_grid_yrelsize command sets the width of the center row to be half as tall as the other rows.

Example 2

chips> grid_objects(2,2,.05,.05,1)
chips> adjust_grid_yrelsize(1,3)

A grid_objects command creates a grid of 4 plot areas. The adjust_grid_yrelsize command makes the first row of plots three times as tall as the other row.

Bugs

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

See Also

limits
get_plot_range
plots
add_plot, adjust_grid_gaps, adjust_grid_xrelsize, adjust_grid_xrelsizes, adjust_grid_yrelsizes, clear_plot, current_plot, delete_plot, display_plot, get_plot, grid_objects, hide_plot, move_plot, reposition_plot, set_data_aspect_ratio, set_plot, set_plot_aspect_ratio, split, strip_chart, swap_object_positions

Last modified: December 2012
CXC logo

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