<<<<<<<<<<<<<<<<<

filter(display) Filter filter(display)

NAME

filter - an abstract class that contains information for generating data in display_data

DESCRIPTION

filter is a superclass for a series of classes that generate data in display_data. For example, warp_scalar, ribbon_filter, contour_filter, series_filter etc...

SUPERCLASS

object

INSTANCE VARIABLES

data_in the name of the display_data that is used as input. If the display_data of that name is not instantiated, it will be automatically.

data_out the name of the display_data that is the output. If no name is specified one is generated. If it is not instantiated previously it will be automatically.

scalar_visibility is a scalar. when it is equal to 1 the scalar values are visible when it is equal to 0 they are not.

vector_visibility is a scalar. When it is equal to 1 the vectors are visibile when it is equal to 0 they are not.

scale_factor is a scalar by which the elements in the generated data are scaled by.

range is a two value vector which contains the range of the scalar data. This is automatically set when the display_data is set but can be altered. These values are used to calculate the colors tables.

mask is a list of 0's and 1's that indicate wheather or not an item is displayed or not. If the mask length is shorter than the number items that are being displayed (polygons, vectors etc...) then the mask is repeated multiple times.

mask_size is the number of numbers in the mask

MESSAGES

data_in=( data_set) sets the name of the display_data to be used.

data_in? returns the name of the display_data

data_out=( data_set) sets the name of the display_data to be used as output. This can be equal to data_in.

data_out? returns the name of the display_data

scale_factor=value sets the scale_factor to a given value. default=1.0;

scale_factor? returns the value of the scale_factor.

range=(min,max) sets the range of the data. default=the range of the display_data scalar values

range? returns the range.

scalar_data_on! turns the scalar data on

scalar_data_off! turns the scalar data off

scalar_visibility=(value) sets the scalar visibility. 1 is on 0 is off.

scalar_visibility? returns the value of scalar_visibility

vector_data_on! turns the vector data on

vector_data_off! turns the vector data off

vector_visibility=(value) sets the vector visibility. 1 is on 0 is off.

vector_visibility? returns the scalar value of the vector visibility

mask=(argument_list) sets the mask to the argument list. If a value in the argument list is greater than 1 then the value is interpreted as 1. If the value is less than 0 then the value is interpreted as 0.

mask+(argument_list) adds the values in the argument list to the mask. If a value in the argument list is greater than 1 then the value is interpreted as 1. If the value is less than 0 then the value is interpreted as 0.

mask? returns the value of the mask on the argument stack

mask_size? returns the number of values in the mask

EXAMPLE

See examples of warp_scalar, warp_vector, hash, and contour_filter.