>  Docs Center  >  Libraries  >  Motley  >  MGHGRDENSITYPLANE__DEFINE

MGHGRDENSITYPLANE__DEFINE

MGHGRDENSITYPLANE__DEFINE

Class Name


  MGHgrDensityPlane

Purpose


  This class implements a "density plane" graphics object, ie a
  representation of 2-D numeric data on a flat surface using colour
  or grey-scale density. It encapsulates an MGHgrColorPlane, which
  handles all the geometry.

Category


  Object graphics.

Properties


  The following properties are supported (amongst others):
    BYTE_RANGE (Init,Get)
      The range of byte values to which the data range is to be mapped.
    COLORSCALE (Init)
      A reference to an object (like a colour bar or another density
      plane) from which default colour mapping information
      (BYTE_RANGE, DATA_RANGE, LOGARITHMIC and PALETTE) can be retrieved.
    DATA_RANGE (Init,Get)
      The range of data values to be mapped onto the indexed color
      range. Data values outside the range are mapped to the nearest
      end of the range. If not specified, DATA_RANGE is calculated
      from the range of data values the first time the data values
      are assigned.
    DATA_VALUES (Init,*Get,Set)
      A 2-D array of data (interpreted as floating point) to be
      displayed. The DATA_VALUES keyword is accepted by GetProperty
      if & only if the STORE_DATA property has been set.
    PALETTE (Init,Get,Set)
      A reference to the palette defining the byte-color mapping.
    PLANE_CLASS (Init)
      The name of the class for the colour plane object. The default
      is 'MGHgrColorPlane'.
    STORE_DATA (Init,Get):
      This property determines whether the data values are stored
      with the object. The default is 1 (values are stored) and it
      can be overridden by setting STORE_DATA to 0 when the object
      is created.
###########################################################################
  Copyright (c) 1998-2012 NIWA:
  http://www.niwa.co.nz/
  Licensed under the MIT open source license:
  http://www.opensource.org/licenses/mit-license.php
###########################################################################

Modification History


  Mark Hadfield, 1998-09:
    Written.
  Mark Hadfield, 2001-03:
    Fixed bug: PARENT property was being returned by the embedded
    color-plane atom, not by self. This lead to confusing problems
    with the MGH_Player object.
  Mark Hadfield, 2004-05:
    Revised code to use IDL 6.0 features. Removed call to MGH_GET_PROPERTY.
  Mark Hadfield, 2012-10:
    Added LOGARITHMIC property.



© 2019 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us