SubsetKFirst Option

The SubsetKFirst option changes the first 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 SubsetZFirst option.

Syntax

object.Construct(“ModifyModule”)

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

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

object.Do() or object.DoOnce()

Example

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

CommandApi.Construct ("ModifyModule")

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

CommandApi.Option ("SubsetKFirst", "4")

CommandApi.Do()

Used by: Subset