TimeSignal
INTERNAL:A time signal.
Property List
- Amplitude
- The amplitude of the time signal. Not valid if PulseType is SpecifyPoints or DefineFunction. (Read/Write Expression)
- ChargeDuration
- The time (in the specified unit) from the end of the pulse delay until the signal begins to discharge. Only valid if PulseType is DoubleExponentialPiecewise. (Read/Write Expression)
- ChargeTimeConstant1
- The time (in the specified unit) to charge the signal up to 63.2% of its full potential. Only valid if PulseType is DoubleExponentialPiecewise. (Read/Write Expression)
- ChargeTimeConstant2
- The time (in the specified unit) to discharge the signal down to 36.8% of its full potential. Only valid if PulseType is DoubleExponentialPiecewise. (Read/Write Expression)
- DefiningFunction
- Analytical equation describing the input pulse, where “t” can be used as the input time variable. Time is measured in seconds. Only valid if PulseType is DefineFunction. (Read/Write Expression)
- FallTime
- The time (in the specified unit) required for the pulse to reach its rest value from peak. Only valid if PulseType is Ramp. (Read/Write Expression)
- Label
- The object label. (Read/Write string)
- PulseDelay
- Depending on the time signal pulse type, this is either the time required for the signal to reach the centre of its peak amplitude (Gaussian, Ramp and Triangular), or the duration of the rest period before the pulse begins to charge up (DoubleExponentialPiecewise and DoubleExponentialDifference). It is measured in the specified unit. (Read/Write Expression)
- PulseType
- The type of time signal definition used, e.g. DoubleExponentialPiecewise or Ramp. (Read/Write TimeSignalPulseTypeEnum)
- PulseWidth
- This is the half-amplitude pulse width of the signal. The pulse width is the total length of time (in the specified unit) that the signal is above 50% of its peak value. Only valid if PulseType is Gaussian, Triangular or Ramp. (Read/Write Expression)
- RiseTime
- The time (in the specified unit) required for the pulse to reach its peak value from rest. Only valid if PulseType is Ramp. (Read/Write Expression)
- Samples
- The number of samples taken from the signal's analytical equation. Only valid if PulseType is DefineFunction. (Read/Write number)
- ScaleAmplitude
- A scale factor applied to the amplitude axis values. Only valid if PulseType is SpecifyPoints. (Read/Write Expression)
- ScaleTime
- A scale factor applied to the time axis values. Only valid if PulseType is SpecifyPoints. (Read/Write Expression)
- TimeAxisUnit
- The unit to be used for the time axis. (Read/Write Unit)
- TimeConstant1
- The time (in the specified unit) for the subtracted signal to reach 63.2% of its full potential. Only valid if PulseType is DoubleExponentialDifference. (Read/Write Expression)
- TimeConstant2
- The time (in the specified unit) for the base signal to reach 63.2% of its full potential. Only valid if PulseType is DoubleExponentialDifference. (Read/Write Expression)
- TotalDuration
- The total length of the signal in the specified unit. Not valid if PulseType is SpecifyPoints. (Read/Write Expression)
- Type
- The object type string. (Read only string)
Collection List
- Points
- The collection of points that define the time signal. (TimeSignalPointCollection of TimeSignalPoint.)
Method List
- Delete ()
- Delete the time signal.
- Duplicate ()
- Duplicates the time signal. (Returns a TimeSignal object.)
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
- SetProperties (properties table)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
- Amplitude
- The amplitude of the time signal. Not valid if PulseType is SpecifyPoints or DefineFunction.
- Type
- Expression
- Access
- Read/Write
- ChargeDuration
- The time (in the specified unit) from the end of the pulse delay until the signal begins to discharge. Only valid if PulseType is DoubleExponentialPiecewise.
- Type
- Expression
- Access
- Read/Write
- ChargeTimeConstant1
- The time (in the specified unit) to charge the signal up to 63.2% of its full potential. Only valid if PulseType is DoubleExponentialPiecewise.
- Type
- Expression
- Access
- Read/Write
- ChargeTimeConstant2
- The time (in the specified unit) to discharge the signal down to 36.8% of its full potential. Only valid if PulseType is DoubleExponentialPiecewise.
- Type
- Expression
- Access
- Read/Write
- DefiningFunction
- Analytical equation describing the input pulse, where “t” can be used as the input time variable. Time is measured in seconds. Only valid if PulseType is DefineFunction.
- Type
- Expression
- Access
- Read/Write
- FallTime
- The time (in the specified unit) required for the pulse to reach its rest value from peak. Only valid if PulseType is Ramp.
- Type
- Expression
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- PulseDelay
- Depending on the time signal pulse type, this is either the time required for the signal to reach the centre of its peak amplitude (Gaussian, Ramp and Triangular), or the duration of the rest period before the pulse begins to charge up (DoubleExponentialPiecewise and DoubleExponentialDifference). It is measured in the specified unit.
- Type
- Expression
- Access
- Read/Write
- PulseType
- The type of time signal definition used, e.g. DoubleExponentialPiecewise or Ramp.
- Type
- TimeSignalPulseTypeEnum
- Access
- Read/Write
- PulseWidth
- This is the half-amplitude pulse width of the signal. The pulse width is the total length of time (in the specified unit) that the signal is above 50% of its peak value. Only valid if PulseType is Gaussian, Triangular or Ramp.
- Type
- Expression
- Access
- Read/Write
- RiseTime
- The time (in the specified unit) required for the pulse to reach its peak value from rest. Only valid if PulseType is Ramp.
- Type
- Expression
- Access
- Read/Write
- Samples
- The number of samples taken from the signal's analytical equation. Only valid if PulseType is DefineFunction.
- Type
- number
- Access
- Read/Write
- ScaleAmplitude
- A scale factor applied to the amplitude axis values. Only valid if PulseType is SpecifyPoints.
- Type
- Expression
- Access
- Read/Write
- ScaleTime
- A scale factor applied to the time axis values. Only valid if PulseType is SpecifyPoints.
- Type
- Expression
- Access
- Read/Write
- TimeAxisUnit
- The unit to be used for the time axis.
- Type
- Unit
- Access
- Read/Write
- TimeConstant1
- The time (in the specified unit) for the subtracted signal to reach 63.2% of its full potential. Only valid if PulseType is DoubleExponentialDifference.
- Type
- Expression
- Access
- Read/Write
- TimeConstant2
- The time (in the specified unit) for the base signal to reach 63.2% of its full potential. Only valid if PulseType is DoubleExponentialDifference.
- Type
- Expression
- Access
- Read/Write
- TotalDuration
- The total length of the signal in the specified unit. Not valid if PulseType is SpecifyPoints.
- Type
- Expression
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
Collection Details
- Points
- The collection of points that define the time signal.
Method Details
- Delete ()
- Delete the time signal.
- Duplicate ()
- Duplicates the time signal.
- Return
- TimeSignal
- The duplicated time signal.
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
- Return
- table
- A properties table.
- SetProperties (properties table)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
- Input Parameters
- properties(table)
- A table of properties defining the new state of the object.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- The default properties table.