# RaysQuantity

The rays quantity properties.

## Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Antenna_and_UTD_Plate.fek]])
rayData = app.Models[1].Configurations[1].Rays["Rays1"]

-- Add the ray data to the 3D view

-- SetProperties the ray quantity options

rayPlot.Quantity.GroupsSelected = {1,2,3,4,5,6,7,8,9,10}
rayPlot.Quantity.AllRaysSelected = false
rayPlot.Quantity.RaysSelected = {1,2,3,4,5,6,7,8,9,10}


## Usage locations (object properties)

The following objects have properties using the RaysQuantity object:

## Property List

AllRaysSelected
Specifies whether all the rays should be selected. (Read/Write boolean)
GroupsSelected
The list of groups that must be selected for the ray plot. (Read/Write List of number)
InteractionsUpTo
Specify the maximum number of ray interactions plot. (Read/Write number)
RayFieldType
The rays field type that must be displayed, specified by the RayFieldTypeEnum, e.g. NearElectricRequest, FarFieldRequest, NearMagneticCoupling, etc. (Read/Write RayFieldTypeEnum)
RaysSelected
The list of rays that must be selected for the ray plot. AllRaysSelected must be disabled first before this property can be set.Ensure the group in which the ray is contained is selected as well. (Read/Write List of number)
Type
The ray type that must be displayed, specified by the RayTypeEnum, e.g. AllRays, ReflectionRay, TransmissionRay, etc. (Read/Write RayTypeEnum)
ValuesNormalised
Specifies whether the rays quantity values must be normalised to the range [0,1] before plotting. This property can be used together with dB scaling. This property is not valid when ComplexComponent is Phase. (Read/Write boolean)
ValuesScaledToDB
Specifies whether the rays quantity values are scaled to dB before plotting. (Read/Write boolean)

## Property Details

AllRaysSelected
Specifies whether all the rays should be selected.
Type
boolean
Access
GroupsSelected
The list of groups that must be selected for the ray plot.
Access
InteractionsUpTo
Specify the maximum number of ray interactions plot.
Type
number
Access
RayFieldType
The rays field type that must be displayed, specified by the RayFieldTypeEnum, e.g. NearElectricRequest, FarFieldRequest, NearMagneticCoupling, etc.
Type
RayFieldTypeEnum
Access
RaysSelected
The list of rays that must be selected for the ray plot. AllRaysSelected must be disabled first before this property can be set.Ensure the group in which the ray is contained is selected as well.
Access
Type
The ray type that must be displayed, specified by the RayTypeEnum, e.g. AllRays, ReflectionRay, TransmissionRay, etc.
Type
RayTypeEnum
Access