Top | ![]() |
![]() |
![]() |
![]() |
GSTLALStateVectorGSTLALStateVector — Converts a state vector stream into booleans, for example to drive a lal_gate element. |
guint64 | gap-samples | Read |
guint64 | off-samples | Read |
guint64 | on-samples | Read |
guint | required-off | Read / Write / Construct |
guint | required-on | Read / Write / Construct |
#define | GSTLAL_STATEVECTOR_TYPE |
struct | GSTLALStateVector |
struct | GSTLALStateVectorClass |
Each sample of the input stream is interpreted as a bit vector, and mapped one-to-one to boolean-valued output samples. Each bit of the input vectors can be required to be on, required to be off, or ignored. The bits that must be on are set with the required-on property; the bits that must be off are set with the required-off property. For each input sample that satisfies the on/off requirements the output is a non-zero sample, all other output samples are 0. Note that if the bitwise intersection of the required-on and required-off properties is non-zero it will be impossible for the input stream to satisfy the conditions and the output will be identically 0.
Typically this element is used to transform a bit vector-valued stream into a boolean stream suitable for controling a gate element.
Reviewed: f989b34f43aec056f021f10e5e01866846a3c58d 2014-08-10 K. Cannon, J. Creighton, B. Sathyaprakash.
Completed Actions:
added warning messages if required-on/required-off have too many bits for width of input stream
generalized transform_caps()
so that sink-->src conversions are complete
added notifications for sample count properties
wrote unit test
why the mask? remove? maybe safer to remove. removed
“gap-samples”
property “gap-samples” guint64
number of samples seen thus far marked as gap.
Flags: Read
Default value: 0
“off-samples”
property “off-samples” guint64
Number of samples seen thus far marked as off.
Flags: Read
Default value: 0
“on-samples”
property “on-samples” guint64
Number of samples seen thus far marked as on.
Flags: Read
Default value: 0
“required-off”
property“required-off” guint
Bit mask setting the bits that must be off in the state vector.
Flags: Read / Write / Construct
Default value: 0
“required-on”
property“required-on” guint
Bit mask setting the bits that must be on in the state vector. Note: if the mask is wider than the input stream, the high-order bits should be 0 or the on condition will never be met.
Flags: Read / Write / Construct
Default value: 0