Skip to main content

Skip First Samples

The skip_first hook discards the first samples of a simulation case. It can either drop the first n samples or drop the first n seconds of a case.

Implementation​

The source code of the hook is available here: https://github.com/VILLASframework/node/blob/master/lib/hooks/skip_first.cpp

Configuration​

samples
integer

The number of samples which should be dropped by this hook after a start or restart of the node/path.

seconds
number

The number of seconds for which this hook should initially drop samples after a start or restart of the node/path.

enabled
boolean
Default: true

An optional field which can be used to disable a hook.

priority
integer
Default: 99

The priority of this hook which determines the order in which hooks are executed. Hooks with a lwoer priority are executed before ones with a higher priority.

If no priority is configured, hooks are executed in the order they are configured in the configuration file.

{
  • "samples": 0,
  • "seconds": 0,
  • "enabled": true,
  • "priority": 99
}

Example​

node/etc/examples/hooks/average.conf
@include "hook-nodes.conf"

paths = (
{
in = "signal_node"
out = "file_node"

hooks = (
{
type = "average"

signals = [ "sine", "square" ]
offset = 0
}
)
}
)