SubsetKStep Option

The SubsetKStep option changes the step value for the k index to extract for a Subset module. The OptionValue is an integer between 1 and the number of nodes in the Z direction. This command has been deprecated and should be replaced with the SubsetZStep option.

Syntax

object.Construct(“ModifyModule”)

object.Option(“Module”, “Subset”)

object.Option(“SubsetKStep”, “OptionValue”)

object.Do() or object.DoOnce()

Example

This example changes the step value for the k index for the output lattice from a Subset module.

CommandApi.Construct ("ModifyModule")

CommandApi.Option ("Module", "Subset")

CommandApi.Option ("SubsetKStep", "3")

CommandApi.Do()

Used by: Subset