IDLanROI objects have the following properties in addition to properties inherited from any superclasses. Properties with the word “Yes” in the “Get” column of the property table can be retrieved via IDLanROI::GetProperty. Properties with the word “Yes” in the “Init” column of the property table can be set via IDLanROI::Init. Properties with the word “Yes” in the “Set” column in the property table can be set via IDLanROI::SetProperty.
Note: For a discussion of the property description tables shown below, see Modifying Object Property Descriptions.
Objects of this class have the following properties.
In addition, objects of this class inherit the properties of all superclasses of this class.
ALL
An anonymous structure containing the values of all of the properties associated with the state of this object. State information about the object includes things like block size, type, etc., but not vertex data.
Note: The fields in this structure may change in subsequent releases of IDL.
|
Type
|
Structure |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: No |
Init: No |
Registered: No
|
BLOCK_SIZE
The number of vertices to allocate per block as needed for the region. When additional vertices are required, an additional block is allocated. The default is 100.
|
Type
|
Integer |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
DATA
A 2 x n or a 3 x n array that defines the 2‑D or 3‑D vertex data, respectively. DATA is equivalent to the optional arguments, X, Y, and Z. This property is stored as double precision floating point values if the argument variable is of type DOUBLE or if the DOUBLE property is non-zero. Otherwise it is stored as single precision floating point.
|
Type
|
Array |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
Note: Setting the DATA property is equivalent to calling IDLanROI::ReplaceData when START=0 and FINISH=nVerts-1 (where nVerts is the number of vertices in the original ROI).
DOUBLE
A non-zero value that indicates whether or not data should be stored in this object in double precision floating point. Set this keyword to zero to indicate that the data should be stored in single precision floating point, which is the default. The DOUBLE property controls the precision used for storing the data in the AppendData, Init, and ReplaceData methods via the X, Y, and Z arguments and in SetProperty method via the DATA keyword. IDL converts any data already stored in the object to the requested precision, if necessary. Note that this keyword does not need to be set if any of the X, Y, or Z arguments or the DATA parameters are of type DOUBLE. However, setting this keyword may be desirable if the data consists of large integers that cannot be accurately represented in single precision floating point. This property is also automatically set to one if any of the X, Y or Z arguments or the DATA parameter is stored using a variable of type DOUBLE.
|
Type
|
Boolean |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
INTERIOR
A Boolean variable that marks this region as an interior region (i.e., a region treated as a hole). By default, the region is treated as an exterior region.
|
Type
|
Boolean |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
N_VERTS
An integer that contains the number of vertices currently being used by the region.
|
Type
|
String
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: No |
Init: No |
Registered: No
|
ROI_XRANGE
A two-element double-precision floating-point vector of the form [xmin, xmax] that specifies the range of X data coordinates covered by the region.
|
Type
|
Vector |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: No |
Init: No |
Registered: No
|
ROI_YRANGE
A two-element double-precision floating-point vector of the form [ymin, ymax] specifying the range of Y data coordinates covered by the region.
|
Type
|
Vector |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: No |
Init: No |
Registered: No
|
ROI_ZRANGE
A two-element double-precision floating-point vector of the form [zmin, zmax] specifying the range of Z data coordinates covered by the region.
|
Type
|
Vector |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: No |
Init: No |
Registered: No
|
TYPE
An integer that indicates the type of the region. The TYPE keyword determines how computational operations, such as mask generation, are performed. Valid values include:
- 0 = points
- 1 = path
- 2 = closed polygon (the default)
|
Type
|
Integer |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: No |
Init: Yes
|
Registered: No
|