Options Resources¶

Objects that define visualization options

../_images/lfview_resources_spatial_options.png

Doc links: _BaseElementOptions _BaseOptions _BaseOptionsItem HasProperties OptionsBlockModel OptionsColor OptionsLines OptionsOpacity OptionsPoints OptionsSize OptionsSurface OptionsSurfaceColor OptionsTexture OptionsTubes OptionsVolumeSlices OptionsWireframe

class lfview.resources.spatial.options._BaseOptions(**kwargs)¶: Base class for all options

class lfview.resources.spatial.options._BaseOptionsItem(**kwargs)¶

Base class for options on a specific visual attribute

These options classes allow you to specify for each attribute both (1) a single static value and (2) variable values calculated from data/mapping.

class lfview.resources.spatial.options.OptionsTexture(**kwargs)¶

Options for a displayed texture

Required Properties:

data (TextureProjection instance or UID): Texture data for visualization, an instance of TextureProjection or a valid uid property of that class
value (Float): Single opacity value, a float in range [0.0, 1.0], Default: 1.0
visible (Boolean): Visibility of texture on/off, a boolean, Default: True

class lfview.resources.spatial.options.OptionsOpacity(**kwargs)¶

Options for displayed opacity

Opaque is 1.0; transparent is 0.0. You may specify a single value for the entire Element or variable values using data and a mapping that evaluates to numbers in range 0-1.

Note: Visualization clients may not support variable opacity.

Required Properties:

value (Float): Single opacity value, a float in range [0.0, 1.0], Default: 1.0

Optional Properties:

data (DataBasic instance or UID, DataCategory instance or UID): Data for attribute visualization, an instance of DataBasic or a valid uid property of that class or an instance of DataCategory or a valid uid property of that class
mapping (MappingContinuous instance or UID, MappingDiscrete instance or UID, MappingCategory instance or UID): Mapping to apply to data for visualization; must be specified if data is specified, an instance of MappingContinuous or a valid uid property of that class or an instance of MappingDiscrete or a valid uid property of that class or an instance of MappingCategory or a valid uid property of that class

class lfview.resources.spatial.options.OptionsSize(**kwargs)¶

Options for displayed size

You may specify a single size value for the entire Element or variable values using data and a mapping that evaluates to positive numbers.

Note: Visualization clients may not support variable size.

Optional Properties:

data (DataBasic instance or UID, DataCategory instance or UID): Data for attribute visualization, an instance of DataBasic or a valid uid property of that class or an instance of DataCategory or a valid uid property of that class
mapping (MappingContinuous instance or UID, MappingDiscrete instance or UID, MappingCategory instance or UID): Mapping to apply to data for visualization; must be specified if data is specified, an instance of MappingContinuous or a valid uid property of that class or an instance of MappingDiscrete or a valid uid property of that class or an instance of MappingCategory or a valid uid property of that class
value (Float): Single size value, only used if data is unspecified, a float in range [0.0, inf], Default: 10

class lfview.resources.spatial.options.OptionsColor(**kwargs)¶

Options for displayed color

You may specify a single solid color value for the entire Element or a variable colormap using data and mapping that evaluates to RGB color

Optional Properties:

data (DataBasic instance or UID, DataCategory instance or UID): Data for attribute visualization, an instance of DataBasic or a valid uid property of that class or an instance of DataCategory or a valid uid property of that class
mapping (MappingContinuous instance or UID, MappingDiscrete instance or UID, MappingCategory instance or UID): Mapping to apply to data for visualization; must be specified if data is specified, an instance of MappingContinuous or a valid uid property of that class or an instance of MappingDiscrete or a valid uid property of that class or an instance of MappingCategory or a valid uid property of that class
value (Color): Single color value, only used if data is unspecified, a color

class lfview.resources.spatial.options.OptionsSurfaceColor(**kwargs)¶

Options for displayed surface color

Identical to lfview.resources.spatial.options.OptionsColor except it also includes solid back color.

Optional Properties:

back (Color): Back color of the surface, only used if data is unspecified, a color
data (DataBasic instance or UID, DataCategory instance or UID): Data for attribute visualization, an instance of DataBasic or a valid uid property of that class or an instance of DataCategory or a valid uid property of that class
mapping (MappingContinuous instance or UID, MappingDiscrete instance or UID, MappingCategory instance or UID): Mapping to apply to data for visualization; must be specified if data is specified, an instance of MappingContinuous or a valid uid property of that class or an instance of MappingDiscrete or a valid uid property of that class or an instance of MappingCategory or a valid uid property of that class
value (Color): Single color value, only used if data is unspecified, a color

class lfview.resources.spatial.options.OptionsWireframe(**kwargs)¶

Options for displaying wireframes on elements

Currently this is limited to enabled/disabled.

Required Properties:

active (Boolean): Wireframe on/off, a boolean, Default: False

class lfview.resources.spatial.options._BaseElementOptions(**kwargs)¶

Base class for various element options

Required Properties:

color (OptionsColor): Default color options on the element, an instance of OptionsColor, Default: new instance of OptionsColor
opacity (OptionsOpacity): Default opacity options on the element, an instance of OptionsOpacity, Default: new instance of OptionsOpacity
visible (Boolean): Visibility of resource on/off, a boolean, Default: True

class lfview.resources.spatial.options.OptionsPoints(**kwargs)¶

PointSet visualization options

Required Properties:

color (OptionsColor): Default color options on the element, an instance of OptionsColor, Default: new instance of OptionsColor
opacity (OptionsOpacity): Default opacity options on the element, an instance of OptionsOpacity, Default: new instance of OptionsOpacity
shape (StringChoice): Points are displayed as squares or spheres, either “square” or “sphere”, Default: square
size (OptionsSize): Default point size on the element, an instance of OptionsSize, Default: new instance of OptionsSize
visible (Boolean): Visibility of resource on/off, a boolean, Default: True

class lfview.resources.spatial.options.OptionsLines(**kwargs)¶

LineSet visualization options

Using this options class implies that lines do not have any thickness.

Required Properties:

color (OptionsColor): Default color options on the element, an instance of OptionsColor, Default: new instance of OptionsColor
opacity (OptionsOpacity): Default opacity options on the element, an instance of OptionsOpacity, Default: new instance of OptionsOpacity
visible (Boolean): Visibility of resource on/off, a boolean, Default: True

class lfview.resources.spatial.options.OptionsTubes(**kwargs)¶

LineSet visualization options for lines with finite thickness

This adds radius to standard lfview.resources.spatial.options.OptionsLines and may be used with drillholes, for example.

Required Properties:

color (OptionsColor): Default color options on the element, an instance of OptionsColor, Default: new instance of OptionsColor
opacity (OptionsOpacity): Default opacity options on the element, an instance of OptionsOpacity, Default: new instance of OptionsOpacity
radius (OptionsSize): Default radius options on the element, an instance of OptionsSize, Default: new instance of OptionsSize
visible (Boolean): Visibility of resource on/off, a boolean, Default: True

class lfview.resources.spatial.options.OptionsSurface(**kwargs)¶

Surface visualizatino options

Required Properties:

color (OptionsSurfaceColor): Default color options on the element, an instance of OptionsSurfaceColor, Default: new instance of OptionsSurfaceColor
opacity (OptionsOpacity): Default opacity options on the element, an instance of OptionsOpacity, Default: new instance of OptionsOpacity
textures (a list of OptionsTexture): Default textures on the element, a list (each item is an instance of OptionsTexture)
visible (Boolean): Visibility of resource on/off, a boolean, Default: True
wireframe (OptionsWireframe): Default wireframe options on the element, an instance of OptionsWireframe, Default: new instance of OptionsWireframe

class lfview.resources.spatial.options.OptionsBlockModel(**kwargs)¶

Volume visualization options for displaying as solid block model

Required Properties:

color (OptionsColor): Default color options on the element, an instance of OptionsColor, Default: new instance of OptionsColor
opacity (OptionsOpacity): Default opacity options on the element, an instance of OptionsOpacity, Default: new instance of OptionsOpacity
visible (Boolean): Visibility of resource on/off, a boolean, Default: True
wireframe (OptionsWireframe): Default wireframe options on the element, an instance of OptionsWireframe, Default: new instance of OptionsWireframe

Optional Properties:

textures (a list of OptionsTexture): Provided for backwards compatibility, a list (each item is an instance of OptionsTexture) with length between 0 and 0

class lfview.resources.spatial.options.OptionsVolumeSlices(**kwargs)¶

Volume visualization options for displaying certain cross sections

Cross-section slices are specified by normalized location along the three volume axes.

Required Properties:

color (OptionsColor): Default color options on the element, an instance of OptionsColor, Default: new instance of OptionsColor
opacity (OptionsOpacity): Default opacity options on the element, an instance of OptionsOpacity, Default: new instance of OptionsOpacity
slices_u (a list of Float): List of active slice locations along u axis, a list (each item is a float in range [0.0, 1.0]) with length between 0 and 256, Default: new instance of list
slices_v (a list of Float): List of active slice locations along v axis, a list (each item is a float in range [0.0, 1.0]) with length between 0 and 256, Default: new instance of list
slices_w (a list of Float): List of active slice locations along w axis, a list (each item is a float in range [0.0, 1.0]) with length between 0 and 256, Default: new instance of list
visible (Boolean): Visibility of resource on/off, a boolean, Default: True
wireframe (OptionsWireframe): Default wireframe options on the element, an instance of OptionsWireframe, Default: new instance of OptionsWireframe

Optional Properties:

textures (a list of OptionsTexture): Provided for backwards compatibility, a list (each item is an instance of OptionsTexture) with length between 0 and 0