
DownSample |
ptolemy.domains.sdf.lib.DownSample |
This actor downsamples an input stream by an integer factor by
removing tokens. The downsample factor is given by the factor
parameter. On each firing, this actor consumes factor tokens from the
input and sends only one of them to the output. The one sent
depends on the phase parameter. If phase is 0, then
the most recent one (the last one consumed) is sent. If phase
is 1, then the next most recent one is sent. The value of phase
can range up to factor-1, in which case the first one consumed
is sent. By default, the factor parameter is 2,
so the input sample rate is twice that of the output.
The default value for phase is 0.
This actor is data polymorphic. It can accept any token
type on the input.
Author(s): Steve Neuendorffer, Edward A. Lee
Version:$Id: DownSample.java,v 1.29 2005/07/08 19:58:44 cxh Exp $
Pt.Proposed Rating:Yellow (neuendor)
Pt.Accepted Rating:Yellow (neuendor)
factor
The number of input tokens to read per output token produced.
This is an integer that defaults to 2 and must be greater than
zero.
phase
The phase of the output with respect to the input.
This is an integer that defaults to 0 and must be between 0
and factor-1. If phase = 0, the most recent
sample is the output, while if phase = factor-1
the oldest sample is the output.